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-93057: Deprecate positional use of optional sqlite3.connect() params #107948

Merged

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Aug 14, 2023

@erlend-aasland

This comment was marked as outdated.

Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated 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.

There is an issue here. Positional parameters are only deprecated in the Connection constructor. But we want also to deprecate them in connect(). Currently you can bypass the deprecations if use the Connection subclass:

class MyConnection(Connection):
    def __init__(self, database, timeout=5.0, ...):
        super().__init__(database, timeout=timeout, ...)

connect(":memory:", 10.0, ..., factory=MyConnection)

But if we add the second deprecation warning in connect(), we will get two deprecation warning.

@erlend-aasland
Copy link
Contributor Author

There is an issue here. Positional parameters are only deprecated in the Connection constructor. But we want also to deprecate them in connect(). Currently you can bypass the deprecations if use the Connection subclass:

Ah, of course. That's tricky.

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.

Please add a test for connect() and mention this change in What's New and NEWS entries.

It is a wart that we will get two warnings, but there is no simple way to avoid it, except applying deprecations one at a time -- first in connect(), then (since 3.15) in Connection. Not sure if it it is worth.

We can also convert all positional arguments in connect() into keyword arguments for factory. It is a lot of complex code.

Lib/test/test_sqlite3/test_factory.py Outdated Show resolved Hide resolved
@erlend-aasland
Copy link
Contributor Author

We can also convert all positional arguments in connect() into keyword arguments for factory. It is a lot of complex code.

No, that is a backwards incompatible change.

@erlend-aasland
Copy link
Contributor Author

mention this change in What's New and NEWS entries.

Is the existing NEWS and What's New entries insufficient? In what way?

@serhiy-storchaka
Copy link
Member

Is the existing NEWS and What's New entries insufficient? In what way?

Ah, they already mention connect()! Then simply add "and the Connection constructor".

@erlend-aasland
Copy link
Contributor Author

Is the existing NEWS and What's New entries insufficient? In what way?

Ah, they already mention connect()! Then simply add "and the Connection constructor".

Yeah, that's useful information. I'll add that; thanks.

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.

@erlend-aasland
Copy link
Contributor Author

Thanks for the review, Serhiy. Much appreciated.

@erlend-aasland erlend-aasland enabled auto-merge (squash) August 15, 2023 07:40
@erlend-aasland erlend-aasland merged commit 13c36dc into python:main Aug 15, 2023
19 checks passed
@erlend-aasland erlend-aasland deleted the sqlite/deprecate-optional-parameters branch August 15, 2023 08:13
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Aug 15, 2023

@felixxm, sorry, I forgot to ping you; I hope not these deprecations will create havoc for Django.

@felixxm
Copy link
Contributor

felixxm commented Aug 15, 2023

@felixxm, sorry, I forgot to ping you; I hope not these deprecations will create havoc for Django.

All good, Django doesn't pass these positional params, only a database name. Thanks 👍

iritkatriel pushed a commit to iritkatriel/cpython that referenced this pull request Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants