Skip to content

bpo-41792 / typing#751 - Add is_typeddict function to typing.py #22254

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

Merged
merged 4 commits into from
Sep 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Doc/library/typing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,20 @@ Introspection helpers

.. versionadded:: 3.8

.. function:: is_typeddict(tp)

Check if an annotation is a TypedDict class.

For example::
class Film(TypedDict):
title: str
year: int

is_typeddict(Film) # => True
is_typeddict(Union[list, str]) # => False

.. versionadded:: 3.10

.. class:: ForwardRef

A class used for internal typing representation of string forward references.
Expand Down
7 changes: 7 additions & 0 deletions Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from typing import cast, runtime_checkable
from typing import get_type_hints
from typing import get_origin, get_args
from typing import is_typeddict
from typing import no_type_check, no_type_check_decorator
from typing import Type
from typing import NewType
Expand Down Expand Up @@ -3900,6 +3901,12 @@ class Cat(Animal):
'voice': str,
}

def test_is_typeddict(self):
assert is_typeddict(Point2D) is True
assert is_typeddict(Union[str, int]) is False
# classes, not instances
assert is_typeddict(Point2D()) is False


class IOTests(BaseTestCase):

Expand Down
15 changes: 15 additions & 0 deletions Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@
'get_args',
'get_origin',
'get_type_hints',
'is_typeddict',
'NewType',
'no_type_check',
'no_type_check_decorator',
Expand Down Expand Up @@ -1479,6 +1480,20 @@ def get_args(tp):
return ()


def is_typeddict(tp):
"""Check if an annotation is a TypedDict class

For example::
class Film(TypedDict):
title: str
year: int

is_typeddict(Film) # => True
is_typeddict(Union[list, str]) # => False
"""
return isinstance(tp, _TypedDictMeta)


def no_type_check(arg):
"""Decorator to indicate that annotations are not type hints.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Add is_typeddict function to typing.py to check if a type is a TypedDict
class

Previously there was no way to check that without using private API. See the
`relevant issue in python/typing
<https://github.com/python/typing/issues/751>`