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.

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

Add typing.reveal_type #90572

Closed
JelleZijlstra opened this issue Jan 17, 2022 · 2 comments
Closed

Add typing.reveal_type #90572

JelleZijlstra opened this issue Jan 17, 2022 · 2 comments
Assignees
Labels
3.11 only security fixes stdlib Python modules in the Lib dir

Comments

@JelleZijlstra
Copy link
Member

BPO 46414
Nosy @gvanrossum, @srittau, @JelleZijlstra, @sobolevn, @Fidget-Spinner, @AlexWaygood, @cdce8p
PRs
  • bpo-46414: Add typing.reveal_type #30646
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/JelleZijlstra'
    closed_at = <Date 2022-03-05.17:53:23.394>
    created_at = <Date 2022-01-17.15:02:22.942>
    labels = ['library', '3.11']
    title = 'Add typing.reveal_type'
    updated_at = <Date 2022-03-05.17:53:23.394>
    user = 'https://github.com/JelleZijlstra'

    bugs.python.org fields:

    activity = <Date 2022-03-05.17:53:23.394>
    actor = 'JelleZijlstra'
    assignee = 'JelleZijlstra'
    closed = True
    closed_date = <Date 2022-03-05.17:53:23.394>
    closer = 'JelleZijlstra'
    components = ['Library (Lib)']
    creation = <Date 2022-01-17.15:02:22.942>
    creator = 'JelleZijlstra'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 46414
    keywords = ['patch']
    message_count = 2.0
    messages = ['410794', '412333']
    nosy_count = 7.0
    nosy_names = ['gvanrossum', 'srittau', 'JelleZijlstra', 'sobolevn', 'kj', 'AlexWaygood', 'cdce8p']
    pr_nums = ['30646']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue46414'
    versions = ['Python 3.11']

    @JelleZijlstra
    Copy link
    Member Author

    The reveal_type() primitive is injected by type checkers into the builtins. When the type checker sees a call, it prints the inferred type of the argument.

    This has been implemented across all type checkers, but adding an implementation to typing would help document the behavior and make it more discoverable for users. Also, it means code with reveal_type() calls can run without runtime errors, useful if you want to run your tests at the same time as you're debugging a typing issue.

    The runtime implementation can be very simple:

        def reveal_type(obj: _T, /) -> _T:
            print("Runtime type is", type(obj))
            return obj

    reveal_type() is supported by all type checkers that I'm aware of (docs include https://google.github.io/pytype/faq.html#can-i-find-out-what-pytype-thinks-the-type-of-my-expression-is for pytype and https://mypy.readthedocs.io/en/stable/common_issues.html#reveal-type for mypy).

    One area of divergence is the return value. Pyright returns the inferred type of the expression as a string (and uses that in its test suite for testing type inference). Mypy returns the argument, which has the advantage that you can insert reveal_type() in the middle of an expression without having to put it on its own line. Also, the Pyright behavior cannot sensibly be implemented at runtime. Therefore, I suggest using Mypy's behavior for typing.reveal_type.

    @JelleZijlstra JelleZijlstra added the 3.11 only security fixes label Jan 17, 2022
    @JelleZijlstra JelleZijlstra self-assigned this Jan 17, 2022
    @JelleZijlstra JelleZijlstra added stdlib Python modules in the Lib dir 3.11 only security fixes labels Jan 17, 2022
    @JelleZijlstra JelleZijlstra self-assigned this Jan 17, 2022
    @JelleZijlstra JelleZijlstra added the stdlib Python modules in the Lib dir label Jan 17, 2022
    @gvanrossum
    Copy link
    Member

    New changeset abcc3d7 by Jelle Zijlstra in branch 'main':
    bpo-46414: Add typing.reveal_type (bpo-30646)
    abcc3d7

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.11 only security fixes stdlib Python modules in the Lib dir
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants