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

Lib/inspect.py: Avoid wild replacement in formatannotation #96073

Closed
Aug 18, 2022 · 1 comment
Closed

Lib/inspect.py: Avoid wild replacement in formatannotation #96073

Aug 18, 2022 · 1 comment
Assignees
@JelleZijlstra
Labels
type-bug An unexpected behavior, bug, or error

Comments

Copy link
Contributor

Aug 18, 2022 •
edited
Loading

Bug report

Source:

cpython/Lib/inspect.py

Lines 1449 to 1458 in 91afe66

def formatannotation(annotation, base_module=None):
if getattr(annotation, '__module__', None) == 'typing':
return repr(annotation).replace('typing.', '')
if isinstance(annotation, types.GenericAlias):
return str(annotation)
if isinstance(annotation, type):
if annotation.__module__ in ('builtins', base_module):
return annotation.__qualname__
return annotation.__module__+'.'+annotation.__qualname__
return repr(annotation)

An error replacement happens in:

repr(annotation).replace('typing.', '')

Suppose that I define a class or Protocol under foo/typing.py:

class A:
    pass

Then Union[int, A] will turn to Union[int, foo.A], but expected result is Union[int, foo.typing.A]

Any module with suffix like xxtyping will be replaced, such as nptyping.

Solution

Replace the line to:

        def repl(match):
            text = match.group()
            if text.startswith('typing.'):
                    return text[len('typing.'):]
            return text
        return re.sub(r'[\w\.]+', repl, repr(annotation))
type-bug An unexpected behavior, bug, or error label Aug 18, 2022
Aug 18, 2022
pythonGH-96073: Fix wild replacement in formatannotation
f14fcb4
@bedevere-bot bedevere-bot mentioned this issue Aug 18, 2022
Merged
JelleZijlstra added a commit that referenced this issue Oct 7, 2022
@JelleZijlstra
GH-96073: Fix wild replacement in inspect.formatannotation (#96074)
d5fea01 
Co-authored-by: Jelle Zijlstra <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 7, 2022
@miss-islington
pythonGH-96073: Fix wild replacement in inspect.formatannotation (pyt…
ec569d1 
…honGH-96074)

Co-authored-by: Jelle Zijlstra <[email protected]>
(cherry picked from commit d5fea01)

Co-authored-by: Anh71me <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 7, 2022
@miss-islington
pythonGH-96073: Fix wild replacement in inspect.formatannotation (pyt…
d58c82e 
…honGH-96074)

Co-authored-by: Jelle Zijlstra <[email protected]>
(cherry picked from commit d5fea01)

Co-authored-by: Anh71me <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
@JelleZijlstra JelleZijlstra self-assigned this Oct 7, 2022
miss-islington added a commit that referenced this issue Oct 7, 2022
@miss-islington
GH-96073: Fix wild replacement in inspect.formatannotation (GH-96074)
107ba92 
Co-authored-by: Jelle Zijlstra <[email protected]>
(cherry picked from commit d5fea01)

Co-authored-by: Anh71me <[email protected]>
miss-islington added a commit that referenced this issue Oct 7, 2022
@miss-islington
GH-96073: Fix wild replacement in inspect.formatannotation (GH-96074)
a3a3701 
Co-authored-by: Jelle Zijlstra <[email protected]>
(cherry picked from commit d5fea01)

Co-authored-by: Anh71me <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
JelleZijlstra added a commit to JelleZijlstra/cpython that referenced this issue Oct 7, 2022
@JelleZijlstra
pythongh-96073: fix backticks in NEWS entry
2209cc4
miss-islington pushed a commit that referenced this issue Oct 7, 2022
@JelleZijlstra
gh-96073: fix backticks in NEWS entry (GH-98056)
0f111f5 
Automerge-Triggered-By: GH:JelleZijlstra
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 7, 2022
@JelleZijlstra @miss-islington
pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
550c7ad 
Automerge-Triggered-By: GH:JelleZijlstra
(cherry picked from commit 0f111f5)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 7, 2022
@JelleZijlstra @miss-islington
pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
5710f6c 
Automerge-Triggered-By: GH:JelleZijlstra
(cherry picked from commit 0f111f5)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
miss-islington added a commit that referenced this issue Oct 7, 2022
@miss-islington @JelleZijlstra
gh-96073: fix backticks in NEWS entry (GH-98056)
8c81d33 
Automerge-Triggered-By: GH:JelleZijlstra
(cherry picked from commit 0f111f5)

Co-authored-by: Jelle Zijlstra <[email protected]>
miss-islington added a commit that referenced this issue Oct 7, 2022
@miss-islington @JelleZijlstra
gh-96073: fix backticks in NEWS entry (GH-98056)
9dea4e2 
Automerge-Triggered-By: GH:JelleZijlstra
(cherry picked from commit 0f111f5)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
JelleZijlstra added a commit that referenced this issue Oct 7, 2022
@JelleZijlstra
[3.10] gh-96073: Fix installed tests by adding to Makefile.pre.in
957c796 
This was broken in #98045 but already fixed on main.
@bedevere-bot bedevere-bot mentioned this issue Oct 7, 2022
Merged
JelleZijlstra added a commit that referenced this issue Oct 8, 2022
@JelleZijlstra
[3.10] gh-96073: Fix installed tests by adding to Makefile.pre.in (#9…
f50e3a7 
…8072)

This was broken in #98045 but already fixed on main.
JelleZijlstra added a commit that referenced this issue Oct 8, 2022
@JelleZijlstra
[3.11] gh-96073: Fix installed tests by adding to Makefile.pre.in (#9…
52dab90 
…8071)

[3.11] Fix installed tests by adding to Makefile.pre.in

This was broken in #98045 but already fixed on main.
carljm added a commit to carljm/cpython that referenced this issue Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
27a4980 
* main: (38 commits)
  pythongh-92886: make test_ast pass with -O (assertions off) (pythonGH-98058)
  pythongh-92886: make test_coroutines pass with -O (assertions off) (pythonGH-98060)
  pythongh-57179: Add note on symlinks for os.walk (python#94799)
  pythongh-94808: Fix regex on exotic platforms (python#98036)
  pythongh-90085: Remove vestigial -t and -c timeit options (python#94941)
  pythonGH-83901: Improve Signature.bind error message for missing keyword-only params (python#95347)
  pythongh-61105: Add default param, note on using cookiejar subclass (python#95427)
  pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (python#96271)
  pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
  pythongh-92886: [clinic.py] raise exception on invalid input instead of assertion (pythonGH-98051)
  pythongh-97997: Add col_offset field to tokenizer and use that for AST nodes (python#98000)
  pythonGH-88968: Reject socket that is already used as a transport (python#98010)
  pythongh-96346: Use double caching for re._compile() (python#96347)
  pythongh-91708: Revert params note in urllib.parse.urlparse table (python#96699)
  pythongh-96265: Fix some formatting in faq/design.rst (python#96924)
  pythongh-73196: Add namespace/scope clarification for inheritance section (python#92840)
  pythongh-97646: Change `.js` and `.mjs` files mimetype to conform to RFC 9239 (python#97934)
  pythongh-97923: Always run Ubuntu SSL tests with others in CI (python#97940)
  pythongh-97956: Mention `generate_global_objects.py` in `AC How-To` (python#97957)
  pythongh-96959: Update HTTP links which are redirected to HTTPS (python#98039)
  ...
Oct 11, 2022
@JelleZijlstra
pythonGH-96073: Fix wild replacement in inspect.formatannotation (pyt…
41b8172 
…hon#96074)

Co-authored-by: Jelle Zijlstra <[email protected]>
Oct 11, 2022
@JelleZijlstra
pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
875841a 
Automerge-Triggered-By: GH:JelleZijlstra
@hauntsaninja
Copy link
Contributor

Thanks, looks like this has been completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JelleZijlstra JelleZijlstra

Labels
type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JelleZijlstra @hauntsaninja