doc/api/__init__.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Mon, 09 Nov 2015 11:34:28 +0100
changeset 10975 6615ecb60244
parent 10494 b6f00889355c
permissions -rw-r--r--
[tox] Use generating environments Drop the "env" option, which is unknown, and set a generative_ "envlist". Then use conditional dependencies based on factors_ to avoid repeating environment sections. The only singular one is the "cubicweb" environment because of its "commands". At some point, it'd be nice to find a way to have python version prefixes (py27-hooks or py34-web) for environment names but I could not find a way to extract the package name from such names. .. _generative: http://tox.readthedocs.org/en/latest/config.html#generative-envlist .. _factors: http://tox.readthedocs.org/en/latest/config.html#factors-and-factor-conditional-settings

.. _index_module:

:mod:`cubicweb`
===============

.. automodule:: cubicweb

    Exceptions
    ----------

    Base exceptions
    ~~~~~~~~~~~~~~~

    .. autoexception:: ProgrammingError
        :show-inheritance:

    .. autoexception:: CubicWebException
        :show-inheritance:

    .. autoexception:: InternalError
        :show-inheritance:

    .. autoexception:: SecurityError
        :show-inheritance:

    .. autoexception:: RepositoryError
        :show-inheritance:

    .. autoexception:: SourceException
        :show-inheritance:

    .. autoexception:: CubicWebRuntimeError
        :show-inheritance:

    Repository exceptions
    ~~~~~~~~~~~~~~~~~~~~~

    .. autoexception:: ConnectionError
        :show-inheritance:

    .. autoexception:: AuthenticationError
        :show-inheritance:

    .. autoexception:: BadConnectionId
        :show-inheritance:

    .. autoexception:: UnknownEid
        :show-inheritance:

    .. autoexception:: UniqueTogetherError
        :show-inheritance:

    Security Exceptions
    ~~~~~~~~~~~~~~~~~~~

    .. autoexception:: Unauthorized
        :show-inheritance:

    .. autoexception:: Forbidden
        :show-inheritance:

    Source exceptions
    ~~~~~~~~~~~~~~~~~

    .. autoexception:: EidNotInSource
        :show-inheritance:

    Registry exceptions
    ~~~~~~~~~~~~~~~~~~~

    .. autoexception:: UnknownProperty
        :show-inheritance:

    Query exceptions
    ~~~~~~~~~~~~~~~~

    .. autoexception:: QueryError
        :show-inheritance:

    .. autoexception:: NotAnEntity
        :show-inheritance:

    .. autoexception:: MultipleResultsError
        :show-inheritance:

    .. autoexception:: NoResultError
        :show-inheritance:

    .. autoexception:: UndoTransactionException
        :show-inheritance:


    Misc
    ~~~~

    .. autoexception:: ConfigurationError
        :show-inheritance:

    .. autoexception:: ExecutionError
        :show-inheritance:

    .. autoexception:: BadCommandUsage
        :show-inheritance:

    .. autoexception:: ValidationError
        :show-inheritance:


    Utilities
    ---------

    .. autoclass:: Binary
    .. autoclass:: CubicWebEventManager
    .. autofunction:: onevent
    .. autofunction:: validation_error