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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-104050: Improve some typing around defaults and sentinel values #104626

Merged
merged 6 commits into from
May 18, 2023
Merged

gh-104050: Improve some typing around defaults and sentinel values #104626

merged 6 commits into from
May 18, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented May 18, 2023 •
edited
Loading

  • Convert unspecified and unknown to be members of a Sentinels enum, rather than instances of bespoke classes.
    • An enum feels more idiomatic here, and works better with type checkers.
    • Convert some == and != checks for these values to identity checks, which are more idiomatic with sentinels.
    • Don't do the same for Null, as this needs to be a distinct type due to its usage in clinic.py.
  • Use object as the annotation for default across clinic.py. default can be literally any object, so object is the correct annotation here.

@bedevere-bot bedevere-bot mentioned this pull request May 18, 2023
Closed
@AlexWaygood
Copy link
Member Author

Not sure if converting the unspecified and unknown sentinels to become enum members is entirely worth it; now that default is typed as object anywhere, the benefits aren't so obvious. I do think it still makes the code a little cleaner, but you tell me whether you think it's worth the churn @erlend-aasland :)

@AlexWaygood AlexWaygood enabled auto-merge (squash) May 18, 2023 21:49
@erlend-aasland
Copy link
Contributor

Not sure if converting the unspecified and unknown sentinels to become enum members is entirely worth it; now that default is typed as object anywhere, the benefits aren't so obvious. I do think it still makes the code a little cleaner, but you tell me whether you think it's worth the churn @erlend-aasland :)

IMO, the more readable we can get clinic.py, the better. We should thread a little careful here, since test_clinic has pretty low coverage. Some of the paths modified are not tested. However, the CI does make clinic (for the check-generated-files job), and that would blow up if semantics changed for the code in question, so we're fine for now.

@AlexWaygood
Copy link
Member Author

IMO, the more readable we can get clinic.py, the better. We should thread a little careful here, since test_clinic has pretty low coverage. Some of the paths modified are not tested. However, the CI does make clinic (for the check-generated-files job), and that would blow up if semantics changed for the code in question, so we're fine for now.

Fab. Thanks for the review!

@AlexWaygood AlexWaygood merged commit 1c55e8d into python:main May 18, 2023
@AlexWaygood AlexWaygood deleted the sentinels-clinic branch May 18, 2023 22:42
carljm added a commit to carljm/cpython that referenced this pull request May 18, 2023
@carljm
Merge branch 'main' into nestedcomps
54095f0 
* main:
  pythongh-74690: Don't set special protocol attributes on non-protocol subclasses of protocols (python#104622)
  pythongh-104623: Update Windows installer to use SQLite 3.42.0 (python#104625)
  pythongh-104050: Add more type annotations to Argument Clinic (python#104628)
  pythongh-104629: Don't skip test_clinic if _testclinic is missing (python#104630)
  pythongh-104549: Set __module__ on TypeAliasType (python#104550)
  pythongh-104050: Improve some typing around `default`s and sentinel values (python#104626)
  pythongh-104146: Remove unused vars from Argument Clinic (python#104627)
  pythongh-104615: don't make unsafe swaps in apply_static_swaps (python#104620)
  pythonGH-104484: Add case_sensitive argument to `pathlib.PurePath.match()` (pythonGH-104565)
  pythonGH-96803: Document and test new unstable internal frame API functions (pythonGH-104211)
  pythonGH-104580: Don't cache eval breaker in interpreter (pythonGH-104581)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erlend-aasland erlend-aasland erlend-aasland approved these changes

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AlexWaygood @erlend-aasland @bedevere-bot