Visitar URL original
gh-89018: Improve documentation of `sqlite3` exceptions by erlend-aasland · Pull Request #27645 · python/cpython · GitHub
Skip to content

gh-89018: Improve documentation of sqlite3 exceptions #27645

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.

Sign up for GitHub

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

Merged
erlend-aasland merged 19 commits into from
Jun 6, 2022
Merged

gh-89018: Improve documentation of sqlite3 exceptions #27645

Changes from 2 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1cee1d0
Document all sqlite3 exceptions
Aug 6, 2021
0e6af97
Add markup for except keyword
Aug 6, 2021
b3ae237
Address review: adjust DataError wording
Aug 7, 2021
defa180
Merge branch 'main' into sqlite-doc-exceptions
Apr 7, 2022
86baece
WIP
Apr 12, 2022
1c20bf5
Merge branch 'main' into sqlite-doc-exceptions
erlend-aasland May 25, 2022
7951b1c
Sync with main
erlend-aasland May 25, 2022
18d701e
Update Doc/library/sqlite3.rst
May 31, 2022
7a12a7b
Update Doc/library/sqlite3.rst
May 31, 2022
9fec685
Update Doc/library/sqlite3.rst
May 31, 2022
e0cc0d4
Update Doc/library/sqlite3.rst
May 31, 2022
1ceb02f
Update Doc/library/sqlite3.rst
May 31, 2022
91494dd
Address review
erlend-aasland May 31, 2022
aa140d4
Reword ProgrammingError
erlend-aasland Jun 1, 2022
59dcdbd
Reword Waning
erlend-aasland Jun 1, 2022
9c112a8
Revert incorrect change
erlend-aasland Jun 1, 2022
8b7293e
Revert "Revert incorrect change"
erlend-aasland Jun 1, 2022
c25c95e
Update Doc/library/sqlite3.rst
Jun 1, 2022
7c1bd6c
Adjust a couple of more inconsistencies
erlend-aasland Jun 1, 2022
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
View file
Open in desktop
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`.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

.. 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
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
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
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
: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