doc/api/__init__.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Fri, 15 Mar 2019 12:12:23 +0100
branch3.26
changeset 12617 f59439bac0a8
parent 10494 b6f00889355c
permissions -rw-r--r--
Skip tests for ldapsource with python >= 3.7 Until someone works on fixing these, this should make our CI green again. I tried to use setupModule() to check for python version, but pre_setup_database() is apparently called even when a SkipTest exception is raised there. So handle this in that method. (grafted from 4d68d20427dee4b6751a0f1f5511fec2a04f4782)

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