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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to ourterms of serviceand privacy statement.We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-101693: In sqlite3, deprecate using named placeholders with parameters supplied as a sequence #101698

Merged
merged 16 commits into from
Feb 15, 2023
Merged

gh-101693: In sqlite3, deprecate using named placeholders with parameters supplied as a sequence #101698

Changes from1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b693895
gh-101698: Deprecate using named placeholders with sequences
erlend-aaslandFeb 8, 2023
483e4d6
Update docs
erlend-aaslandFeb 8, 2023
e826428
Document deprecation in reference
erlend-aaslandFeb 8, 2023
132a6ee
Also test executemany
erlend-aaslandFeb 8, 2023
31cc188
Revert "Also test executemany"
erlend-aaslandFeb 8, 2023
660a742
Sync with main
erlend-aaslandFeb 9, 2023
a18d0bb
Address review: add test for query with more than one named param
erlend-aaslandFeb 9, 2023
3f94201
Address review: add PyErr_WarnFormat error handling
erlend-aaslandFeb 9, 2023
997ccc6
Sync with main
erlend-aaslandFeb 10, 2023
cb091af
Pull in main
erlend-aaslandFeb 14, 2023
450cdcc
Fixup
erlend-aaslandFeb 14, 2023
841e8a4
Apply Serhiy's suggestion
erlend-aaslandFeb 14, 2023
3e7b680
Pull in main
erlend-aaslandFeb 14, 2023
38d1110
Address Alex's review
erlend-aaslandFeb 14, 2023
cf3cfc8
Also amend NEWS and What's New
erlend-aaslandFeb 14, 2023
1687b65
Use deprecated-removed
erlend-aaslandFeb 14, 2023
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
Pull in main
  • Loading branch information
@erlend-aasland
erlend-aasland committed Feb 14, 2023
commitcb091af8beb1ee1323b952a4f7fdf369e51afbd3
9 changes: 8 additions & 1 deletion Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,10 @@ Cursor objects
:raises ProgrammingError:
If *sql* contains more than one SQL statement.

:raises DeprecationWarning:
erlend-aaslandmarked this conversation as resolved.
Show resolved Hide resolved
If:ref:`named placeholders <sqlite3-placeholders>` are used
and *parameters* is a sequence.

If:attr:`~Connection.autocommit` is
:data:`LEGACY_TRANSACTION_CONTROL`,
:attr:`~Connection.isolation_level` is not ``None``,
Expand All @@ -1444,10 +1448,13 @@ Cursor objects

.. versionchanged:: 3.12
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
..versionchanged::3.12
..deprecated-removed::3.123.14

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you sure about that? The API itself is not deprecated, we're just changing it. I'm not sure what's the recommended practice here.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I know what you mean. I feel like ideally this notice would be phrased along the lines of "X behaviour/practice is now deprecated" rather than "a DeprecationWarning is now emitted". That would be more to-the-point, and it would also work more naturally with this directive (X behaviour/practice is deprecated in 3.12, and will be removed entirely in 3.14).

But I was struggling to come to with a concrete suggestion for how to reword these notices:/

Copy link
Member

Choose a reason for hiding this comment

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

(The whatsnew and NEWS entries look great btw, it's just the notices in the API docs that feelslightlyclunky to me)

Copy link
Contributor Author

@erlend-aasland erlend-aasland Feb 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I feel like ideally this notice would be phrased along the lines of "X behaviour/practice is now deprecated" rather than "a DeprecationWarning is now emitted". That would be more to-the-point, and it would also work more naturally with this directive (X behaviour/practice is deprecated in 3.12, and will be removed entirely in 3.14).

Yes, but documented as deprecated and emitting aDeprecationWarningare similar, but not equal, things 🙂 With the former, we don't need to emit a warning in the code.

Copy link
Member

Choose a reason for hiding this comment

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

To your original question, btw: I think it's pretty standard to use.. deprecatedor.. deprecated-removed,even if it's just a particular usage of an API, rather than the API itself. See e.g.https://docs.python.org/3.12/library/asyncio-policy.html#asyncio.DefaultEventLoopPolicy,where the directive is used even though the class itself hasn't been deprecated at all; or#19867,which deprecated just a specific parameter; or lots of other examples in our docs 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Aight! I'll try to reword it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated it to usedeprecated-removed,and I put in an extra line regarding what happens in 3.14. I'm too tired to reword the text 🙂


:exc:`DeprecationWarning` is raised if
:exc:`DeprecationWarning` is raised
if
:ref:`named placeholders <sqlite3-placeholders>` are used
and *parameters* is a sequence.
erlend-aaslandmarked this conversation as resolved.
Show resolved Hide resolved

Use:meth:`executescript` to execute multiple SQL statements.

.. method:: executemany(sql, parameters, /)

For every item in *parameters*,
Expand Down
You are viewing a condensed version of this merge commit. You can view thefull changes here.