Files
tryton/trytond/doc/ref/exceptions.rst
T

100 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2018-12-29 14:19:08 +01:00
.. _ref-exceptions:
.. module:: trytond.exceptions
Exceptions
==========
.. exception:: TrytonException
2022-03-27 16:06:09 +02:00
The base class for all Tryton exceptions.
2018-12-29 14:19:08 +01:00
2019-06-16 19:04:55 +02:00
.. exception:: UserError(message[, description[, domain]])
2018-12-29 14:19:08 +01:00
2022-03-27 16:06:09 +02:00
The base class for exceptions used to display an error message to users.
The domain may be a 2-tuple containing a :ref:`domain <topics-domain>` and a
dictionary of field definitions used to format the domain and append to the
description.
2018-12-29 14:19:08 +01:00
.. exception:: UserWarning(name, message[, description])
2022-03-27 16:06:09 +02:00
The base class for exceptions used to display a warning message to users.
2018-12-29 14:19:08 +01:00
.. exception:: LoginExceptions(name, message[, type])
2022-03-27 16:06:09 +02:00
The exception used to request ``name`` parameter for the login process.
2018-12-29 14:19:08 +01:00
.. exception:: ConcurrencyException(message)
2022-03-27 16:06:09 +02:00
The exception raised on concurrent modification.
2018-12-29 14:19:08 +01:00
.. exception:: RateLimitException
2022-03-27 16:06:09 +02:00
The exception raised when user has sent too many login requests.
2018-12-29 14:19:08 +01:00
.. exception:: MissingDependenciesException(missings)
2022-03-27 16:06:09 +02:00
The exception raised when modules are missing.
2018-12-29 14:19:08 +01:00
.. module:: trytond.model.exceptions
.. exception:: AccessError
2022-03-27 16:06:09 +02:00
The exception raised when trying to access a record without the rights.
2018-12-29 14:19:08 +01:00
.. exception:: AccessButtonError
2022-03-27 16:06:09 +02:00
The exception raised when trying to execute a button without the rights.
2018-12-29 14:19:08 +01:00
.. exception:: ButtonActionException
The exception raised to launch the ``action`` instead of executing the
button method.
The ``value`` attribute is the action value returned.
2018-12-29 14:19:08 +01:00
.. exception:: ImportDataError
2022-03-27 16:06:09 +02:00
The exception raises when importing data fails.
2018-12-29 14:19:08 +01:00
.. exception:: ValidationError
2022-03-27 16:06:09 +02:00
The base class for all record validation error.
2018-12-29 14:19:08 +01:00
.. exception:: DomainValidationError
2022-03-27 16:06:09 +02:00
The exception raised when the domain of a field is not valid.
2018-12-29 14:19:08 +01:00
.. exception:: RequiredValidationError
2022-03-27 16:06:09 +02:00
The exception raised when a required field is empty.
2018-12-29 14:19:08 +01:00
.. exception:: SizeValidationError
2022-03-27 16:06:09 +02:00
The exception raised when the size of a field is too big.
2018-12-29 14:19:08 +01:00
.. exception:: DigitsValidationError
2022-03-27 16:06:09 +02:00
The exception raised when the value of a field does not respect its digits.
2018-12-29 14:19:08 +01:00
.. exception:: SelectionValidationError
2022-03-27 16:06:09 +02:00
The exception raised when the value is not in the selection.
2018-12-29 14:19:08 +01:00
.. exception:: TimeFormatValidationError
2022-03-27 16:06:09 +02:00
The exception raised when the time format of a field is not respected.
2018-12-29 14:19:08 +01:00
.. exception:: ForeignKeyError
2022-03-27 16:06:09 +02:00
The exception raised when a foreign key is not respected.
2018-12-29 14:19:08 +01:00
.. exception:: SQLConstraintError
2022-03-27 16:06:09 +02:00
The exception raised when a :attr:`~trytond.model.ModelSQL._sql_constraints`
is not respected.
2018-12-29 14:19:08 +01:00
.. exception:: RecursionError
2022-03-27 16:06:09 +02:00
The exception raised by :class:`~trytond.model.TreeMixin.check_recursion`.