8000 gh-61162: Clarify sqlite3 connection context manager docs by erlend-aasland · Pull Request #93890 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-61162: Clarify sqlite3 connection context manager docs #93890

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

Merged
merged 16 commits into from
Jun 19, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Next Next commit
gh-61162: Clarify sqlite3 connection context manager docs
Explicitly note that transactions are only closed if there is an open
transation, and that transactions are _not_ implicitly opened in
context manager __enter__.
  • Loading branch information
erlend-aasland committed Jun 16, 2022
commit 672ce97bdf606744a3990423afb28ce939dc5a21
12 changes: 9 additions & 3 deletions Doc/library/sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1435,9 +1435,15 @@ Using the connection as a context manager
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Connection objects can be used as context managers
that automatically commit or rollback transactions. In the event of an
exception, the transaction is rolled back; otherwise, the transaction is
committed:
that automatically commit or rollback transactions,
*if* there is an open transaction.
If there is no open transaction, the context manager is a no-op.
In the event of an exception, the transaction is rolled back;
otherwise, the transaction is committed:

.. note::

The context manager does not implicitly start a new transaction.

.. literalinclude:: ../includes/sqlite3/ctx_manager.py

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify :mod:`sqlite3` connection context manager behaviour.
0