doc/api/__init__.rst
author Philippe Pepiot <philippe.pepiot@logilab.fr>
Mon, 29 Oct 2018 10:04:31 +0100
branch3.26
changeset 12432 2fcb53ee5178
parent 10494 b6f00889355c
permissions -rw-r--r--
Fix flake8 issues since release 3.6.0 Flake8 had a new release which raise new issues, namely: W504: line break after binary operator F841: local variable 'ex' is assigned to but never used W605: invalid escape sequence F821: undefined name 'buffer' (noqa seems the only way to avoid this false positive) Also pin flake8>=3.6 in our tests and make explicit that we use python3 to run flake8 tests.

.. _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