X Tutup
The Wayback Machine - https://web.archive.org/web/20221223103850/https://github.com/python/cpython/issues/99828
Skip to content
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

Jump to bottom

Clarify sqlite3 documentation of PEP 249 compliance for commit modes #99828

Closed
maggyero opened this issue Nov 27, 2022 · 2 comments
Closed

Clarify sqlite3 documentation of PEP 249 compliance for commit modes #99828

maggyero opened this issue Nov 27, 2022 · 2 comments
Labels
docs Documentation in the Doc dir expert-sqlite3 pending The issue will be closed if no feedback is provided

Comments

@maggyero
Copy link
Contributor

maggyero commented Nov 27, 2022 •
edited by bedevere-bot

Documentation

The sqlite3 documentation for the new Connection.autocommit attribute introduced in PR #93823 states:

   .. attribute:: autocommit

      This attribute controls :pep:`249`-compliant transaction behaviour.
      :attr:`!autocommit` has three allowed values:

      * ``False``: Select :pep:`249`-compliant transaction behaviour,
        implying that :mod:`!sqlite3` ensures a transaction is always open.

        This is the recommended value of :attr:`!autocommit`.

      * ``True``: Use SQLite's `autocommit mode`_.
        :meth:`commit` and :meth:`rollback` have no effect in this mode.

      * :data:`LEGACY_TRANSACTION_CONTROL`:
        Pre-Python 3.12 (non-:pep:`249`-compliant) transaction control.
        See :attr:`isolation_level` for more details.

The sentence ‘This attribute controls :pep:249-compliant transaction behaviour.’ is misleading as only the new manual commit mode (autocommit=False) is PEP-249-compliant, since PEP 249 specifies only the manual commit mode.

Likewise, the sentence ‘Pre-Python 3.12 (non-:pep:249-compliant) transaction control.’ is misleading as only the legacy manual commit mode (isolation_level='DEFERRED', isolation_level='EXCLUSIVE', or isolation_level='IMMEDIATE') is non-PEP-249-compliant, since PEP 249 specifies only the manual commit mode.

Linked PRs
@maggyero maggyero added the docs Documentation in the Doc dir label Nov 27, 2022
@bedevere-bot bedevere-bot mentioned this issue Nov 27, 2022
Closed
@erlend-aasland
Copy link
Contributor

erlend-aasland commented Nov 28, 2022

The sentence ‘This attribute controls :pep:249-compliant transaction behaviour.’ is misleading as only the new manual commit mode (autocommit=False) is PEP-249-compliant, since PEP 249 specifies only the manual commit mode.

It is not misleading. PEP-249 says that autocommit is True implies leaving the "autocommitting" to SQLite. That is what we do, and there is nothing "non-PEP-249-compliant" about that.

Likewise, the sentence ‘Pre-Python 3.12 (non-:pep:249-compliant) transaction control.’ is misleading as only the legacy manual commit mode (isolation_level='DEFERRED', isolation_level='EXCLUSIVE', or isolation_level='IMMEDIATE') is non-PEP-249-compliant, since PEP 249 specifies only the manual commit mode.

Ditto. IMO, this is perfectly fine.

AFAICS, there is no need to change those wordings; suggesting to close this issue.

Thanks for your interest in improving the docs!

@erlend-aasland erlend-aasland added the pending The issue will be closed if no feedback is provided label Nov 28, 2022
@maggyero
Copy link
Contributor Author

maggyero commented Nov 28, 2022

Fair enough. Thanks for the discussion.

@erlend-aasland erlend-aasland closed this as not planned Won't fix, can't repro, duplicate, stale Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir expert-sqlite3 pending The issue will be closed if no feedback is provided
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@erlend-aasland @maggyero
X Tutup