gh-101561: Add typing.override decorator #101564

stroxler · 2023-02-04T16:27:08Z

The code is pulled almost unchanged from typing_extensions:

Question that came up was where to put the type variable and what to name it:

In typing_extensions the type variables use underscore prefixes to indicate that they are not public, but typing doesn't appear to use that convention so I named the type variable F.
I couldn't put the type variable next to all of the other ones (used in generic container definitions) because it relies on Callable which is defined below. If this is a problem I could correct it using a forward reference, or we could try to rearrange the module to put special forms above type variables.

Testing the code:

First set up the repo, following instructions
at https://devguide.python.org/ by running:

./configure --with-pydebug && make -j

Then run the typing tests:

./python -m test test_typing -v

I ran the full test suite with

./python -m test -j3

and it came back clean except for a test_grp failure which I seem to get on trunk as well - likely something in my build is misconfigured but I'm pretty sure it is unrelated to the changes here.

Issue: Add typing.override decorator #101561

Make sure the docs build:

cd Doc
make venv
make html

bedevere-bot · 2023-02-04T16:27:12Z

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

bedevere-bot · 2023-02-04T16:30:47Z

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

AlexWaygood

Thanks! Haven't looked in depth yet at all, but we'll also need:

A news entry, as @bedevere-bot says
An entry in Doc/whatsnew/3.12.rst
(optionally) you can add your name to Misc/ACKS

Doc/library/typing.rst

Misc/NEWS.d/next/Library/2023-02-04-16-35-46.gh-issue-101561.Xo6pIZ.rst

Lib/typing.py

Fidget-Spinner · 2023-02-07T01:58:34Z

The implementation for override LGTM.

Summary: THe `typing_extensions.override` was added a few months ago, we should support it. The `typing.override` decorator isn't landed yet, but that's okay - we should support it in override checks; it will still raise a "no such name" method when Pyre is being run against a typeshed that doens't have it yet. The PR to add `typing.override` to CPython is out for review now: https://github.com/python/cpython/pull/101564` Reviewed By: grievejia Differential Revision: D43055550 fbshipit-source-id: 3f51f643063afea75bf54ef38ae3a48681b99bd9

Testing: First set up the repo, following instructions at https://devguide.python.org/ by running: ``` ./configure --with-pydebug && make -j ``` Then run the typing tests: ``` ./python -m test test_typing -v ``` I ran the full test suite with ``` ./python -m test -j3 ``` and it came back clean except for a `test_grp` failure which I seem to get on trunk as well - likely something in my build is misconfigured but I'm pretty sure it is unrelated to the changes here.

Correct `s/final/override` (from reusing a similar block of documentation on the `@final` decorator) Co-authored-by: Jelle Zijlstra <[email protected]>

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

…o6pIZ.rst Co-authored-by: Alex Waygood <[email protected]>

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

stroxler · 2023-02-27T19:56:33Z

(Rebase on main)

@gvanrossum I think this is waiting on review from you

JelleZijlstra

Sorry for dropping this; I have a few nits but I'm happy to merge the PR. I'll leave it open for a few days in case Guido does want to take a look himself.

Doc/whatsnew/3.12.rst

Misc/NEWS.d/next/Library/2023-02-04-16-35-46.gh-issue-101561.Xo6pIZ.rst

gvanrossum · 2023-02-27T20:04:19Z

I defer to @JelleZijlstra if that's okay.

Thanks, looks good Co-authored-by: Jelle Zijlstra <[email protected]>

sobolevn · 2023-02-28T13:12:42Z

Sorry for being late with a review, I've opened a follow-up for this: #102324

Thanks a lot for adding this decorator! Great work, it would be very useful! 👍

* main: (67 commits) pythongh-99108: Add missing md5/sha1 defines to Modules/Setup (python#102308) pythongh-100227: Move _str_replace_inf to PyInterpreterState (pythongh-102333) pythongh-100227: Move the dtoa State to PyInterpreterState (pythongh-102331) pythonGH-102305: Expand some macros in generated_cases.c.h (python#102309) Migrate to new PSF mailgun account (python#102284) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives (in Python/) (python#102193) pythonGH-90744: Fix erroneous doc links in the sys module (python#101319) pythongh-87092: Make jump target label equal to the offset of the target in the instructions sequence (python#102093) pythongh-101101: Unstable C API tier (PEP 689) (pythonGH-101102) IDLE: Simplify DynOptionsMenu __init__code (python#101371) pythongh-101561: Add typing.override decorator (python#101564) pythongh-101825: Clarify that as_integer_ratio() output is always normalized (python#101843) pythongh-101773: Optimize creation of Fractions in private methods (python#101780) pythongh-102251: Updates to test_imp Toward Fixing Some Refleaks (pythongh-102254) pythongh-102296 Document that inspect.Parameter kinds support ordering (pythonGH-102297) pythongh-102250: Fix double-decref in COMPARE_AND_BRANCH error case (pythonGH-102287) pythongh-101100: Fix sphinx warnings in `types` module (python#102274) pythongh-91038: Change default argument value to `False` instead of `0` (python#31621) pythongh-101765: unicodeobject: use Py_XDECREF correctly (python#102283) [doc] Improve grammar/fix missing word (pythonGH-102060) ...

Fixes #101564

stroxler requested review from gvanrossum, Fidget-Spinner, JelleZijlstra and AlexWaygood as code owners February 4, 2023 16:27

bedevere-bot added the awaiting review label Feb 4, 2023

stroxler changed the title ~~PEP 698: Add typing.override decorator~~ gh-101561: Add typing.override decorator Feb 4, 2023

bedevere-bot mentioned this pull request Feb 4, 2023

Add typing.override decorator #101561

Closed

AlexWaygood reviewed Feb 4, 2023

View reviewed changes

JelleZijlstra reviewed Feb 4, 2023

View reviewed changes

Doc/library/typing.rst Outdated Show resolved Hide resolved

arhadthedev added stdlib Python modules in the Lib dir topic-typing labels Feb 4, 2023

AlexWaygood added type-feature A feature request or enhancement 3.12 bugs and security fixes labels Feb 4, 2023

AlexWaygood reviewed Feb 4, 2023

View reviewed changes

Misc/NEWS.d/next/Library/2023-02-04-16-35-46.gh-issue-101561.Xo6pIZ.rst Outdated Show resolved Hide resolved

TeamSpen210 reviewed Feb 4, 2023

View reviewed changes

Lib/typing.py Outdated Show resolved Hide resolved

bersbersbers mentioned this pull request Feb 12, 2023

nuitka is incompatible with overrides Nuitka/Nuitka#2048

Closed

stroxler and others added 9 commits February 27, 2023 11:55

Add missing For example:: in the rst doc

bd3b6ac

📜🤖 Added by blurb_it.

c3b9b7f

Update Doc/library/typing.rst

c7cecf8

Correct `s/final/override` (from reusing a similar block of documentation on the `@final` decorator) Co-authored-by: Jelle Zijlstra <[email protected]>

Add whatsnew entry, as per Alex Waygood's suggestion

2acf32f

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

Add ACKS entry, fix rst errors

6bd3356

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

Fix title underline length in whatisnew doc.

42277cb

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

Update Misc/NEWS.d/next/Library/2023-02-04-16-35-46.gh-issue-101561.X…

afb74de

…o6pIZ.rst Co-authored-by: Alex Waygood <[email protected]>

Use a positional-only argument named method

090d9d2

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

stroxler force-pushed the gh-101561-typing-override branch from 4a04527 to 090d9d2 Compare February 27, 2023 19:56

JelleZijlstra approved these changes Feb 27, 2023

View reviewed changes

Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved

Misc/NEWS.d/next/Library/2023-02-04-16-35-46.gh-issue-101561.Xo6pIZ.rst Outdated Show resolved Hide resolved

bedevere-bot added awaiting merge and removed awaiting review labels Feb 27, 2023

JelleZijlstra self-assigned this Feb 27, 2023

Apply suggestions from code review

f6c00e5

Thanks, looks good Co-authored-by: Jelle Zijlstra <[email protected]>

JelleZijlstra merged commit 0f89acf into python:main Feb 27, 2023

bedevere-bot removed the awaiting merge label Feb 27, 2023

sobolevn mentioned this pull request Feb 28, 2023

gh-102324: Improve tests of typing.override #102325

Merged

JelleZijlstra pushed a commit that referenced this pull request Mar 3, 2023

gh-102324: Improve tests of typing.override (#102325)

12011dd

Fixes #101564

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-101561: Add typing.override decorator #101564

gh-101561: Add typing.override decorator #101564

stroxler commented Feb 4, 2023 •

edited

Loading

bedevere-bot commented Feb 4, 2023

bedevere-bot commented Feb 4, 2023

AlexWaygood left a comment

Fidget-Spinner commented Feb 7, 2023

stroxler commented Feb 27, 2023

JelleZijlstra left a comment

gvanrossum commented Feb 27, 2023

sobolevn commented Feb 28, 2023 •

edited

Loading

gh-101561: Add typing.override decorator #101564

gh-101561: Add typing.override decorator #101564

Conversation

stroxler commented Feb 4, 2023 • edited Loading

Testing the code:

Make sure the docs build:

bedevere-bot commented Feb 4, 2023

bedevere-bot commented Feb 4, 2023

AlexWaygood left a comment

Choose a reason for hiding this comment

Fidget-Spinner commented Feb 7, 2023

stroxler commented Feb 27, 2023

JelleZijlstra left a comment

Choose a reason for hiding this comment

gvanrossum commented Feb 27, 2023

sobolevn commented Feb 28, 2023 • edited Loading

stroxler commented Feb 4, 2023 •

edited

Loading

sobolevn commented Feb 28, 2023 •

edited

Loading