Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-89018: Improve documentation of sqlite3 exceptions #27645

Merged
merged 19 commits into from
Jun 6, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions Doc/library/sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -829,35 +829,55 @@ Exceptions

.. exception:: Warning

A subclass of :exc:`Exception`.
Exception raised for important warnings like data truncations while
inserting, etc. It is a subclass of :exc:`Exception`.
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved

.. exception:: Error

The base class of the other exceptions in this module. It is a subclass
of :exc:`Exception`.
The base class of the other error exceptions in this module. Use this to
catch all errors with one single :keyword:`except` statement. :exc:`Error`
is a subclass of :exc:`Exception`.

.. exception:: InterfaceError

Exception raised for errors that are related to the database interface
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved
rather than the database itself. It is a subclass of :exc:`Error`.

.. exception:: DatabaseError

Exception raised for errors that are related to the database.
Exception raised for errors that are related to the database. It is a
subclass of :exc:`Error`.

.. exception:: DataError

Exception raised for errors that are due to problems with the processed data
like division by zero, numeric value out of range, etc. It is a subclass of
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved
:exc:`DatabaseError`.

.. exception:: OperationalError

Exception raised for errors that are related to the database's operation
and not necessarily under the control of the programmer, e.g. an unexpected
disconnect occurs, the data source name is not found, a transaction could
not be processed, etc. It is a subclass of :exc:`DatabaseError`.

.. exception:: IntegrityError

Exception raised when the relational integrity of the database is affected,
e.g. a foreign key check fails. It is a subclass of :exc:`DatabaseError`.

.. exception:: InternalError

Exception raised when the database encounters an internal error, e.g. the
cursor is not valid anymore, the transaction is out of sync, etc. It is a
subclass of :exc:`DatabaseError`.

.. exception:: ProgrammingError

Exception raised for programming errors, e.g. table not found or already
exists, syntax error in the SQL statement, wrong number of parameters
specified, etc. It is a subclass of :exc:`DatabaseError`.

.. exception:: OperationalError

Exception raised for errors that are related to the database's operation
and not necessarily under the control of the programmer, e.g. an unexpected
disconnect occurs, the data source name is not found, a transaction could
not be processed, etc. It is a subclass of :exc:`DatabaseError`.

.. exception:: NotSupportedError

Exception raised in case a method or database API was used which is not
Expand Down