Docs: use parameter list for sqlite3.Cursor.execute* by erlend-aasland · Pull Request #101782 · python/cpython

erlend-aasland · 2023-02-10T13:23:09Z

No description provided.

erlend-aasland · 2023-02-10T13:25:45Z

I'm not sure if this is an improvement; I need new eyes to tell me :) Also, I'm in doubt of how to use the :raises Sphinx param here; execute*() can raise a heck of a lot of exceptions; should we write all of them down here, or just a subset? Perhaps just point to the reference for sqlite3 exceptions?

AlexWaygood

I think this is a nice improvement! I find it much easier to understand when parameters should be a sequence and when it should be a dict with this change

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

there's a slight difference

AlexWaygood

The set of "all Python iterables" is a superset of the set of "all Python sequences" and a superset of the set of "all Python sequences". All sequences are by definition also iterables; all iterators are by definition also iterables.

(sorry, reviewing on my phone — think I screwed up my last suggestion!)

erlend-aasland · 2023-02-10T17:40:03Z

Correct! I had to go re-read the glossary. Thanks for the heads-up.

AlexWaygood · 2023-02-10T17:50:39Z

Correct! I had to go re-read the glossary. Thanks for the heads-up.

Pro tip: reading the source code for _collections_abc.py is often more informative than reading the glossary entry, I find!

AlexWaygood

Looks great!

erlend-aasland · 2023-02-10T17:53:17Z

Pro tip: reading the source code for _collections_abc.py is often more informative than reading the glossary entry, I find!

Ouch, we can't have it that way; in that case we need to improve the glossary. I haven't read a lot of the .py files in Lib; I'm more into the Modules dir :) But I'll take a look; thanks for the tip!

erlend-aasland · 2023-02-10T17:53:50Z

Thanks for the helpful review; highly appreciated!

miss-islington · 2023-02-10T17:54:08Z

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington · 2023-02-10T17:54:14Z

Sorry, @erlend-aasland, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2037ebf81bd4bbe5421421b822bd57cfd665a1e9 3.10

bedevere-bot · 2023-02-10T17:54:16Z

GH-101803 is a backport of this pull request to the 3.11 branch.

erlend-aasland · 2023-02-10T17:54:59Z

(I'll fix the 3.10 backport later today)

(cherry picked from commit 2037ebf) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

AlexWaygood · 2023-02-10T18:00:19Z

Ouch, we can't have it that way; in that case we need to improve the glossary.

I know what you mean, but I actually wonder if it's possible in this case to convey the same information as tersely and as precisely in the glossary. I find the inheritance structures in _collections_abc.py very descriptive and quite elegant. It's possible you could replicate that with some kind of diagram in the docs somewhere, but I'm not sure.

There's also the fact that it's nice to have all the collections-related concepts described together in a separate file. The glossary interspersed these terms with completely unrelated concepts (as a glossary should! This is its nature — but for understanding these concepts specifically, I find it unhelpful)

(cherry picked from commit 2037ebf) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* main: Docs: Fix getstatus() -> getcode() typos (python#101296) Docs: use parameter list for sqlite3.Cursor.execute* (python#101782) pythongh-101763: Update bundled copy of libffi to 3.4.4 on Windows (pythonGH-101784) pythongh-101517: make bdb avoid looking up in linecache with lineno=None (python#101787) pythongh-101759: Update Windows installer to SQLite 3.40.1 (python#101762) pythongh-101277: Finalise isolating itertools (pythonGH-101305) pythongh-101759: Update macOS installer to SQLite 3.40.1 (python#101761)

…-101782) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>. (cherry picked from commit 2037ebf) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

bedevere-bot · 2023-02-10T20:57:22Z

GH-101808 is a backport of this pull request to the 3.10 branch.

… (#101808) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 2037ebf)

Docs: use parameter list for sqlite3.Cursor.execute*
84aa865

erlend-aasland requested a review from berkerpeksag as a code owner February 10, 2023 13:23

erlend-aasland added skip issue skip news needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Feb 10, 2023

erlend-aasland requested a review from AlexWaygood February 10, 2023 13:23

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Feb 10, 2023

AlexWaygood reviewed Feb 10, 2023
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst
Comment threadDoc/library/sqlite3.rst
Comment threadDoc/library/sqlite3.rst Outdated

Address review
9d1fb1d

AlexWaygood reviewed Feb 10, 2023
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

erlend-aaslandand others added 2 commits February 10, 2023 17:58

Update Doc/library/sqlite3.rst
bedcfd3
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

... or iterator
ed08eab
there's a slight difference

AlexWaygood reviewed Feb 10, 2023
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated

Amend
9dcc5da

AlexWaygood approved these changes Feb 10, 2023
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Feb 10, 2023

erlend-aasland merged commit 2037ebf into python:mainFeb 10, 2023

bedevere-bot removed the awaiting merge label Feb 10, 2023

miss-islington assigned erlend-aasland Feb 10, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 10, 2023

erlend-aasland deleted the sqlite-docs/execute-params-best-practice branch February 10, 2023 17:54

bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 10, 2023

erlend-aasland added a commit that referenced this pull request Feb 10, 2023
[3.10] Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)…
a565cd5
… (#101808) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 2037ebf)

tom93 mentioned this pull request Nov 27, 2023
Docs: fix typo in doc for sqlite3.Cursor.execute #112442
Merged

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Feb 10, 2023

Uh oh!

erlend-aasland commented Feb 10, 2023

Uh oh!

AlexWaygood left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlexWaygood left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Feb 10, 2023

Uh oh!

AlexWaygood commented Feb 10, 2023

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Feb 10, 2023

Uh oh!

erlend-aasland commented Feb 10, 2023

Uh oh!

miss-islington commented Feb 10, 2023

Uh oh!

miss-islington commented Feb 10, 2023

Uh oh!

bedevere-bot commented Feb 10, 2023

Uh oh!

erlend-aasland commented Feb 10, 2023

Uh oh!

AlexWaygood commented Feb 10, 2023

Uh oh!

bedevere-bot commented Feb 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AlexWaygood left a comment •
edited
Loading

AlexWaygood left a comment •
edited
Loading