◐ Shell
reader mode source ↗
Skip to content

gh-93057: Deprecate positional use of optional sqlite3.connect() params#107948

Merged
erlend-aasland merged 8 commits into
python:mainfrom
erlend-aasland:sqlite/deprecate-optional-parameters
Aug 15, 2023
Merged

gh-93057: Deprecate positional use of optional sqlite3.connect() params#107948
erlend-aasland merged 8 commits into
python:mainfrom
erlend-aasland:sqlite/deprecate-optional-parameters

Conversation

@erlend-aasland

@erlend-aasland erlend-aasland commented Aug 14, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@bedevere-bot bedevere-bot mentioned this pull request Aug 11, 2023
Closed
@erlend-aasland

This comment was marked as outdated.

Sign in to view
serhiy-storchaka
serhiy-storchaka reviewed Aug 15, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

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

erlend-aasland commented Aug 15, 2023

Copy link
Copy Markdown
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.

serhiy-storchaka
serhiy-storchaka reviewed Aug 15, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

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.

@erlend-aasland

erlend-aasland commented Aug 15, 2023

Copy link
Copy Markdown
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

erlend-aasland commented Aug 15, 2023

Copy link
Copy Markdown
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

serhiy-storchaka commented Aug 15, 2023

Copy link
Copy Markdown
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

erlend-aasland commented Aug 15, 2023

Copy link
Copy Markdown
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.

serhiy-storchaka
serhiy-storchaka approved these changes Aug 15, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

LGTM.

@erlend-aasland

erlend-aasland commented Aug 15, 2023

Copy link
Copy Markdown
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
@erlend-aasland erlend-aasland deleted the sqlite/deprecate-optional-parameters branch August 15, 2023 08:13
@erlend-aasland

erlend-aasland commented Aug 15, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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

@felixxm

felixxm commented Aug 15, 2023

Copy link
Copy Markdown
Contributor

@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
@erlend-aasland @iritkatriel
pythongh-93057: Deprecate positional use of optional sqlite3.connect(… …
0d8c344 
…) params (python#107948)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag

+1 more reviewer

@Qadeem411 Qadeem411 Qadeem411 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@erlend-aasland @serhiy-storchaka @felixxm @Qadeem411 @bedevere-bot