doc/api/__init__.rst
changeset 10494 b6f00889355c
equal deleted inserted replaced
10493:64b4e1def4ec 10494:b6f00889355c
       
     1 .. _index_module:
       
     2 
       
     3 :mod:`cubicweb`
       
     4 ===============
       
     5 
       
     6 .. automodule:: cubicweb
       
     7 
       
     8     Exceptions
       
     9     ----------
       
    10 
       
    11     Base exceptions
       
    12     ~~~~~~~~~~~~~~~
       
    13 
       
    14     .. autoexception:: ProgrammingError
       
    15         :show-inheritance:
       
    16 
       
    17     .. autoexception:: CubicWebException
       
    18         :show-inheritance:
       
    19 
       
    20     .. autoexception:: InternalError
       
    21         :show-inheritance:
       
    22 
       
    23     .. autoexception:: SecurityError
       
    24         :show-inheritance:
       
    25 
       
    26     .. autoexception:: RepositoryError
       
    27         :show-inheritance:
       
    28 
       
    29     .. autoexception:: SourceException
       
    30         :show-inheritance:
       
    31 
       
    32     .. autoexception:: CubicWebRuntimeError
       
    33         :show-inheritance:
       
    34 
       
    35     Repository exceptions
       
    36     ~~~~~~~~~~~~~~~~~~~~~
       
    37 
       
    38     .. autoexception:: ConnectionError
       
    39         :show-inheritance:
       
    40 
       
    41     .. autoexception:: AuthenticationError
       
    42         :show-inheritance:
       
    43 
       
    44     .. autoexception:: BadConnectionId
       
    45         :show-inheritance:
       
    46 
       
    47     .. autoexception:: UnknownEid
       
    48         :show-inheritance:
       
    49 
       
    50     .. autoexception:: UniqueTogetherError
       
    51         :show-inheritance:
       
    52 
       
    53     Security Exceptions
       
    54     ~~~~~~~~~~~~~~~~~~~
       
    55 
       
    56     .. autoexception:: Unauthorized
       
    57         :show-inheritance:
       
    58 
       
    59     .. autoexception:: Forbidden
       
    60         :show-inheritance:
       
    61 
       
    62     Source exceptions
       
    63     ~~~~~~~~~~~~~~~~~
       
    64 
       
    65     .. autoexception:: EidNotInSource
       
    66         :show-inheritance:
       
    67 
       
    68     Registry exceptions
       
    69     ~~~~~~~~~~~~~~~~~~~
       
    70 
       
    71     .. autoexception:: UnknownProperty
       
    72         :show-inheritance:
       
    73 
       
    74     Query exceptions
       
    75     ~~~~~~~~~~~~~~~~
       
    76 
       
    77     .. autoexception:: QueryError
       
    78         :show-inheritance:
       
    79 
       
    80     .. autoexception:: NotAnEntity
       
    81         :show-inheritance:
       
    82 
       
    83     .. autoexception:: MultipleResultsError
       
    84         :show-inheritance:
       
    85 
       
    86     .. autoexception:: NoResultError
       
    87         :show-inheritance:
       
    88 
       
    89     .. autoexception:: UndoTransactionException
       
    90         :show-inheritance:
       
    91 
       
    92 
       
    93     Misc
       
    94     ~~~~
       
    95 
       
    96     .. autoexception:: ConfigurationError
       
    97         :show-inheritance:
       
    98 
       
    99     .. autoexception:: ExecutionError
       
   100         :show-inheritance:
       
   101 
       
   102     .. autoexception:: BadCommandUsage
       
   103         :show-inheritance:
       
   104 
       
   105     .. autoexception:: ValidationError
       
   106         :show-inheritance:
       
   107 
       
   108 
       
   109     Utilities
       
   110     ---------
       
   111 
       
   112     .. autoclass:: Binary
       
   113     .. autoclass:: CubicWebEventManager
       
   114     .. autofunction:: onevent
       
   115     .. autofunction:: validation_error