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.

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
merged 16 commits into from
Jun 19, 2022
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
672ce97
gh-61162: Clarify sqlite3 connection context manager docs
erlend-aasland Jun 16, 2022
61b31f9
Update Doc/library/sqlite3.rst
Jun 16, 2022
2434ba2
Address Adam's review: focus on the happy path
erlend-aasland Jun 16, 2022
71f2f45
Remove the now obsolete note
erlend-aasland Jun 16, 2022
76319b7
Clarify?
erlend-aasland Jun 16, 2022
20a100a
Update sqlite3.rst
Jun 16, 2022
28c435f
Add context manager anchor
Jun 16, 2022
6baac81
Use anchor in NEWS entry
Jun 16, 2022
8808fb9
Update Doc/library/sqlite3.rst
Jun 16, 2022
7237399
Add connection class link
Jun 16, 2022
6218dba
Make it more concise
Jun 16, 2022
32beb9f
Adjust wording and reflow for 79 chars
erlend-aasland Jun 17, 2022
a64fad4
Update Doc/library/sqlite3.rst
Jun 17, 2022
420c8ce
Object is singular
Jun 17, 2022
8000 9fc3801
Reflow to 79 char limit
erlend-aasland Jun 17, 2022
b2ae22c
Finishing touch: Use neither...nor instead of does not...or
erlend-aasland Jun 19, 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
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
erlend-aasland committed Jun 16, 2022
commit 672ce97bdf606744a3990423afb28ce939dc5a21
12 changes: 9 additions & 3 deletions Doc/library/sqlite3.rst
View file
Open in desktop
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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2022-06-16-10-10-59.gh-issue-61162.1ypkG8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify :mod:`sqlite3` connection context manager behaviour.
0