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 ourterms of serviceand privacy statement.We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Feb 8, 2023

@erlend-aasland erlend-aasland changed the title Add NEWS gh-101693: In sqlite3, deprecate using named placeholders with parameters supplied as a sequence Feb 8, 2023
@erlend-aasland

This comment was marked as outdated.

@erlend-aasland erlend-aasland marked this pull request as ready for review February 8, 2023 18:08
@erlend-aasland
Copy link
Contributor Author

Alex, would you mind taking a look at the docs/NEWS/What's New changes? I feel the sentences grew to be a little bit too complex.

@erlend-aasland
Copy link
Contributor Author

Also, the text in the deprecation warning is perhaps a little bit too long 😶

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

I can't think of a case where a warning would be better than an exception, but so be it.

Modules/_sqlite/cursor.c Outdated Show resolved Hide resolved
Lib/test/test_sqlite3/test_dbapi.py Show resolved Hide resolved
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM.

Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
@erlend-aasland
Copy link
Contributor Author

Thanks for your review, Serhiy; highly appreciated.

@AlexWaygood,do you still want to take a look?

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

A few more minor points

Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
@@ -1442,6 +1442,12 @@ Cursor objects
and there is no open transaction,
a transaction is implicitly opened before executing *sql*.

.. 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

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 🙂

Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

The docs LGTM!

@erlend-aasland erlend-aasland merged commit8a2b7ee into python:main Feb 15, 2023
@erlend-aasland erlend-aasland deleted the no-numeric-placeholder-for-you branch February 15, 2023 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants