doc/api/__init__.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Thu, 14 Mar 2019 14:38:55 +0100
changeset 12500 ef2168f389f6
parent 10494 b6f00889355c
permissions -rw-r--r--
[test] Remove upper bound for cubicweb-localperms Version 0.4.0 does not use a deprecated API that we are planning to drop in forthcoming changesets. This requires changing expected values in unittest_cwconfig.py where we scan install cubes. * In CubicWebConfigurationTC.test_available_cubes(), localperms disappears from the list of expected cubes because this test method will look for new style cubes in located in cubicweb/test/data/libpython/ (we patch pkg_resources.iter_entry_points()) as well as old style cubes installed in $PREFIX/share/cubicweb/cubes; since the new cubicweb-localperms version is new-style, it won't be catched by this method. * In CubicWebConfigurationWithLegacyCubesTC.test_available_cubes(), localperms is still listed, but now with the package name, because this method will simply look at installed cubes whether old or new style.

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