Skip to content

Improve sqlite3 documentation of the new autocommit attribute #99435

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

Closed
geryogam wants to merge 9 commits into from
Closed

Improve sqlite3 documentation of the new autocommit attribute #99435

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bb30103
Remove an unnecessary lambda in tests
geryogam Nov 13, 2022
261f21b
Clarify that implicit open or roll back happens in the same method call
geryogam Nov 13, 2022
d864934
Add connect() to the list of implicit-transaction-opening methods
geryogam Nov 21, 2022
8b250c0
Recommend commit() and rollback() in legacy manual commit mode
geryogam Nov 21, 2022
d11dcfb
Clarify PEP-249-compliant vs legacy transaction control
geryogam Nov 21, 2022
3750bf0
Improve wording consistency
geryogam Nov 21, 2022
b9034b1
Remove two ambiguous ‘underlying’
geryogam Nov 13, 2022
55a28c8
Normalize ‘open transaction’
geryogam Nov 13, 2022
6db7b57
Normalize ’transaction control’
geryogam Nov 13, 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
Prev Previous commit
Next Next commit
Clarify that implicit open or roll back happens in the same method call
  • Loading branch information
@geryogam
geryogam committed Nov 21, 2022
commit 261f21b905eb5ee9c8289255e910346d210d2f73
14 changes: 7 additions & 7 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,24 +637,24 @@ Connection objects
Commit any pending transaction to the database.
If :attr:`autocommit` is ``True``, or there is no open transaction,
this method does nothing.
If :attr:`!autocommit` is ``False``, a new transaction is implicitly
opened if a pending transaction was committed by this method.
If :attr:`!autocommit` is ``False``, this method implicitly opens
a new transaction after committing.

.. method:: rollback()

Roll back to the start of any pending transaction.
If :attr:`autocommit` is ``True``, or there is no open transaction,
this method does nothing.
If :attr:`!autocommit` is ``False``, a new transaction is implicitly
opened if a pending transaction was rolled back by this method.
If :attr:`!autocommit` is ``False``, this method implicitly opens
a new transaction after rolling back.

.. method:: close()

Close the database connection.
If :attr:`autocommit` is ``False``,
any pending transaction is implicitly rolled back.
If :attr:`autocommit` is ``False``, this method implicitly rolls back
any open transaction before closing.
If :attr:`!autocommit` is ``True`` or :data:`LEGACY_TRANSACTION_CONTROL`,
no implicit transaction control is executed.
this method does not execute any implicit transaction control.
Make sure to :meth:`commit` before closing
to avoid losing pending changes.

Expand Down