GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-104050: Improve some typing around `default`s and sentinel values by AlexWaygood · Pull Request #104626 · python/cpython

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented May 18, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • 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.
  • Issue: Add type annotations to clinic.py #104050

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
erlend-aasland and others added 6 commits May 17, 2023 22:31
@erlend-aasland
pythongh-104050: Add type annotations to sentinels in Argument Clinic
3b12493
@AlexWaygood
Merge branch 'main' into typed-clinic/sentinels
5c1c2df
@erlend-aasland
Fix stuff
d145ff8 
- Fix variable names
- Add NullType
- Fix instance check
@erlend-aasland
Revert unneeded change
5833421
@erlend-aasland
Fix local rebase and write nicer if for line 2700
703c417
@AlexWaygood
Fixening
657fcbd
@AlexWaygood AlexWaygood added the skip news label May 18, 2023
@AlexWaygood
AlexWaygood requested a review from erlend-aasland May 18, 2023 21:28
@bedevere-bot bedevere-bot added the awaiting core review label May 18, 2023
@bedevere-bot bedevere-bot mentioned this pull request May 18, 2023
Add type annotations to clinic.py #104050
Closed
@AlexWaygood

AlexWaygood commented May 18, 2023

Copy link
Copy Markdown
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 :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland
erlend-aasland approved these changes May 18, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels May 18, 2023
@AlexWaygood
AlexWaygood enabled auto-merge (squash) May 18, 2023 21:49
@erlend-aasland

erlend-aasland commented May 18, 2023

Copy link
Copy Markdown
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 reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood

AlexWaygood commented May 18, 2023

Copy link
Copy Markdown
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!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood
AlexWaygood merged commit 1c55e8d into python:main May 18, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label 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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@AlexWaygood @erlend-aasland @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.