mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-61162: Clarify sqlite3 connection context manager docs (GH-93890)

Browse source 
Explicitly note that transactions are only closed if there is an open
transation at `__exit__`, and that transactions are not implicitly
opened during `__enter__`.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:erlend-aasland
This commit is contained in:
Erlend Egeberg Aasland 2022-06-19 22:17:43 +02:00 • committed by GitHub
parent 6446592c89
commit 8e08978141
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Doc/library/sqlite3.rst
View file

@ -1430,13 +1430,27 @@ case-insensitively by name:
.. literalinclude:: ../includes/sqlite3/rowclass.py .. literalinclude:: ../includes/sqlite3/rowclass.py
.. _sqlite3-connection-context-manager:
Using the connection as a context manager Using the connection as a context manager
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Connection objects can be used as context managers A :class:`Connection` object can be used as a context manager that
that automatically commit or rollback transactions. In the event of an automatically commits or rolls back open transactions when leaving the body of
exception, the transaction is rolled back; otherwise, the transaction is the context manager.
committed: If the body of the :keyword:`with` statement finishes without exceptions,
the transaction is committed.
If this commit fails,
or if the body of the ``with`` statement raises an uncaught exception,
the transaction is rolled back.
If there is no open transaction upon leaving the body of the ``with`` statement,
the context manager is a no-op.
.. note::
The context manager neither implicitly opens a new transaction
nor closes the connection.
.. literalinclude:: ../includes/sqlite3/ctx_manager.py .. literalinclude:: ../includes/sqlite3/ctx_manager.py

1
Misc/NEWS.d/next/Documentation/2022-06-16-10-10-59.gh-issue-61162.1ypkG8.rst Normal file
View file

@ -0,0 +1 @@
Clarify :mod:`sqlite3` behavior when :ref:`sqlite3-connection-context-manager`.