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

gh-99824: Document that sqlite3.connect implicitly open a transaction if autocommit=False #99825

Merged
merged 8 commits into from
Nov 30, 2022

Conversation

geryogam
Copy link
Contributor

@geryogam geryogam commented Nov 27, 2022

Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@geryogam
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@erlend-aasland: please review the changes made to this pull request.

@geryogam geryogam marked this pull request as ready for review November 28, 2022 18:23
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, after taking some time to carefully consider both the current discussion on the issue and practical implementation here, my current view from a non-expert reader perspective is that it should in fact be mentioned in the autocommit-mode transaction control explanation with the other behavior details, and possibly elided from the autocommit parameter to connect, based on the following rationale:

  • It would be quite concise to mention it there (only adding a few words), whereas it would be a whole sentence in what should be a much more austere reference, particularly one that is otherwise heavily abridged with almost all the details explained elsewhere
  • Likewise, to me it feels like a better fit with the existing text/phrasing there, requiring only adding one more item in a prose list of places transactions are implicitly opened, as opposed to adding a sentence that seems somewhat out of place with the rest of the paragraph's content
  • It seems to be of more use to readers as a part of a holistic explanation of the module's PEP 249-compliant mode of transaction behavior, as opposed to an isolated mention which seems less useful or potentially even confusing away from the explanation of the rest of the behavior.
  • It also highlights a particular contrast when versus the legacy behavior that explanation implicitly contrasts it with, which it doesn't really do here on its own

Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
@erlend-aasland erlend-aasland changed the title gh-99824: Document sqlite3.connect() as implicitly opening transactions in the new PEP-249 manual commit mode gh-99824: Document that sqlite3.connect implicitly open a transaction if autocommit=False Nov 30, 2022
@erlend-aasland erlend-aasland merged commit 19c3880 into python:main Nov 30, 2022
@geryogam
Copy link
Contributor Author

Thanks for the review!

@geryogam geryogam deleted the sqlite3/implicit-transactions branch November 30, 2022 11:59
@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 30, 2022

Thanks, all.

While no longer directly related to the topic of this PR, IMO it's still worth adding the one-line summaries to the two parameter descriptions, as the primary rationale for them is independent of the added sentence (and for the same reasons we agreed on doing the same for row_factory in #99507 , despite it also having a detailed how-to):

While we want to keep the parameter descriptions as concise as practical, they're missing a brief one-line summary of this parameter's purpose (to control legacy/PEP 249 transaction handling behavior) to give the reader at least a basic idea of what it is actually for, and whether it might be prudent to read more about it in the linked references.

@erlend-aasland if you agree, I can open a new PR to add those.

@erlend-aasland
Copy link
Contributor

@erlend-aasland if you agree, I can open a new PR to add those.

Please do.

@CAM-Gerlach
Copy link
Member

Thanks, opened as PR #99917

carljm added a commit to carljm/cpython that referenced this pull request Dec 1, 2022
* main: (112 commits)
  pythongh-99894: Ensure the local names don't collide with the test file in traceback suggestion error checking (python#99895)
  pythongh-99612: Fix PyUnicode_DecodeUTF8Stateful() for ASCII-only data (pythonGH-99613)
  Doc: Add summary line to isolation_level & autocommit sqlite3.connect params (python#99917)
  pythonGH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (pythonGH-98916)
  pythongh-89189: More compact range iterator (pythonGH-27986)
  bpo-47220: Document the optional callback parameter of weakref.WeakMethod (pythonGH-25491)
  pythonGH-99905: Fix output of misses in summarize_stats.py execution counts (pythonGH-99906)
  pythongh-99845: PEP 670: Convert PyObject macros to functions (python#99850)
  pythongh-99845: Use size_t type in __sizeof__() methods (python#99846)
  pythonGH-99877)
  Fix typo in exception message in `multiprocessing.pool` (python#99900)
  pythongh-87092: move all localsplus preparation into separate function called from assembler stage (pythonGH-99869)
  pythongh-99891: Fix infinite recursion in the tokenizer when showing warnings (pythonGH-99893)
  pythongh-99824: Document that sqlite3.connect implicitly open a transaction if autocommit=False (python#99825)
  pythonGH-81057: remove static state from suggestions.c (python#99411)
  Improve zip64 limit error message (python#95892)
  pythongh-98253: Break potential reference cycles in external code worsened by typing.py lru_cache (python#98591)
  pythongh-99127: Allow some features of syslog to the main interpreter only (pythongh-99128)
  pythongh-82836: fix private network check (python#97733)
  Docs: improve accuracy of socketserver reference (python#24767)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants