Skip to content

gh-95065: Add Argument Clinic support for deprecating positional use of parameters - #95151

Merged
erlend-aasland merged 95 commits into
python:mainfrom
erlend-aasland:ac-deprecate
Aug 7, 2023
Merged

gh-95065: Add Argument Clinic support for deprecating positional use of parameters#95151
erlend-aasland merged 95 commits into
python:mainfrom
erlend-aasland:ac-deprecate

Conversation

@erlend-aasland

@erlend-aaslanderlend-aasland commented Jul 22, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Add support for deprecating positional use of optional parameters by
introducing the * [from X.Y] syntax, meaning the following parameters
will be keyword-only starting with Python version X.Y. Code that emits
DeprecationWarnings and compile time messages will be automatically
generated.

Multiple * [from X.Y] lines are not allowed (yet).

@erlend-aasland

erlend-aasland commented Jul 22, 2022

Copy link
Copy Markdown
ContributorAuthor

Disclaimer: there's probably a lot of corner cases I haven't thought of yet. This is very much a draft.

@erlend-aasland
erlend-aasland marked this pull request as ready for review July 26, 2022 11:45
@erlend-aasland

erlend-aasland commented Jul 26, 2022

Copy link
Copy Markdown
ContributorAuthor

@zware, are you interested in reviewing this?

This is probably quite crude, but my Argument Clinic knowledge is minimal, so I think getting a round of reviews is needed for me to move forward with this.

@erlend-aasland

erlend-aasland commented Jul 26, 2022

Copy link
Copy Markdown
ContributorAuthor

cc. @arhadthedev, if you would like to review this.

arhadthedev
arhadthedev previously approved these changes Jul 26, 2022
View reviewed changes

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

if you would like to review this

I have neither objections nor extra ideas here. Also, I fully agree that [...] we should create separate issues for each feature later, not here and now.

@bedevere-botbedevere-bot mentioned this pull request Feb 21, 2023
Closed
@erlend-aasland
erlend-aasland marked this pull request as draft April 29, 2023 19:09
@erlend-aasland
erlend-aasland dismissed arhadthedev’s stale reviewJuly 2, 2023 21:48

The feature is not ready yet; dismissing premature approval.

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

@serhiy-storchakaserhiy-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.

LGTM, besides few nitpicks.

Comment threadTools/clinic/clinic.py Outdated
Comment threadTools/clinic/clinic.py Outdated
Comment threadTools/clinic/clinic.py Outdated
@erlend-aasland

erlend-aasland commented Aug 7, 2023

Copy link
Copy Markdown
ContributorAuthor

LGTM, besides few nitpicks.

Thank you all so much for helping out with this PR. I learned some new tricks, and it was very good with some extra pairs of eyes on this.

@erlend-aasland

erlend-aasland commented Aug 7, 2023

Copy link
Copy Markdown
ContributorAuthor

I improved the NEWS entry, but I also think we should promote this feature in What's New. I'm not sure where in What's New, though.

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

@serhiy-storchakaserhiy-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.

No, I do not think that it should be in What's New. Argument Clinic is an implementation detail. Everything made with Argument Clinic can be made without Argument Clinic. Only the end result is important for users.

Comment threadMisc/NEWS.d/next/Tools-Demos/2022-07-23-00-33-28.gh-issue-95065.NfCCpp.rst Outdated
@erlend-aasland@serhiy-storchaka
Update Misc/NEWS.d/next/Tools-Demos/2022-07-23-00-33-28.gh-issue-9506…
52e7078
…5.NfCCpp.rst
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@erlend-aasland

erlend-aasland commented Aug 7, 2023

Copy link
Copy Markdown
ContributorAuthor

Thanks again. I'll wait for Alex's approval before landing.

@erlend-aaslanderlend-aasland mentioned this pull request Aug 7, 2023
Closed
AlexWaygood
AlexWaygood reviewed Aug 7, 2023
View reviewed changes

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

The grammar in one of the deprecation messages in the tests is still not ideal — here's a way to fix it:

Comment threadLib/test/clinic.test.c Outdated
Comment threadTools/clinic/clinic.py Outdated
AlexWaygood
AlexWaygood reviewed Aug 7, 2023
View reviewed changes
Comment threadTools/clinic/clinic.py
AlexWaygood
AlexWaygood approved these changes Aug 7, 2023
View reviewed changes

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

LGTM

@erlend-aasland
erlend-aasland enabled auto-merge (squash) August 7, 2023 10:40
@erlend-aasland
Revert "Fix fixup code and add test"
b21bc32
This reverts commit d2130ab,
but keeps the test.
@erlend-aasland
erlend-aasland enabled auto-merge (squash) August 7, 2023 11:01
@erlend-aasland
erlend-aasland merged commit 33cb0b0 into python:mainAug 7, 2023
@erlend-aasland
erlend-aasland deleted the ac-deprecate branch August 7, 2023 11:28
@Zac-HDZac-HD mentioned this pull request Aug 8, 2023
Closed
@erlend-aaslanderlend-aasland mentioned this pull request Aug 8, 2023
Merged
erlend-aasland added a commit to erlend-aasland/devguide that referenced this pull request Sep 8, 2023
@erlend-aasland@AlexWaygood@serhiy-storchaka
gh-95065: Add Argument Clinic support for deprecating positional use …
33b77a5
…of parameters (python/cpython#95151)
It is now possible to deprecate passing parameters positionally with
Argument Clinic, using the new '* [from X.Y]' syntax.
(To be read as "keyword-only from Python version X.Y")
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Sep 13, 2023
@erlend-aasland@AlexWaygood@serhiy-storchaka
python/cpython#95065: Add Argument Clinic support for deprecating pos…
eec5f46
…itional use of parameters (python/cpython#95151)
It is now possible to deprecate passing parameters positionally with
Argument Clinic, using the new '* [from X.Y]' syntax.
(To be read as "keyword-only from Python version X.Y")
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
erlend-aasland added a commit to python/devguide that referenced this pull request Sep 26, 2023
@erlend-aasland@AlexWaygood@serhiy-storchaka
python/cpython#95065: Add Argument Clinic support for deprecating pos…
62b9d34
…itional use of parameters (python/cpython#95151)
It is now possible to deprecate passing parameters positionally with
Argument Clinic, using the new '* [from X.Y]' syntax.
(To be read as "keyword-only from Python version X.Y")
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes
@sobolevnsobolevnsobolevn left review comments
@AlexWaygoodAlexWaygoodAlexWaygood approved these changes
@arhadthedevarhadthedevarhadthedev left review comments
@hauntsaninjahauntsaninjaAwaiting requested review from hauntsaninja
@zwarezwareAwaiting requested review from zware
@berkerpeksagberkerpeksagAwaiting requested review from berkerpeksag

Assignees

No one assigned

Labels

topic-argument-clinic

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@erlend-aasland@serhiy-storchaka@sobolevn@arhadthedev@AlexWaygood@CAM-Gerlach@bedevere-bot