Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Start PEP 728 implementation #519

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 19 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from 9 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
137 changes: 99 additions & 38 deletions 137 src/test_typing_extensions.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
Never,
NewType,
NoDefault,
NoExtraItems,
NoReturn,
NotRequired,
Optional,
Expand Down Expand Up @@ -128,6 +129,8 @@
# 3.13.0.rc1 fixes a problem with @deprecated
TYPING_3_13_0_RC = sys.version_info[:4] >= (3, 13, 0, "candidate")

TYPING_3_14_0 = sys.version_info[:3] >= (3, 14, 0)

# https://github.com/python/cpython/pull/27017 was backported into some 3.9 and 3.10
# versions, but not all
HAS_FORWARD_MODULE = "module" in inspect.signature(typing._type_check).parameters
Expand Down Expand Up @@ -4051,18 +4054,25 @@ def test_basics_keywords_syntax(self):
def test_typeddict_special_keyword_names(self):
with self.assertWarns(DeprecationWarning):
TD = TypedDict("TD", cls=type, self=object, typename=str, _typename=int,
fields=list, _fields=dict)
fields=list, _fields=dict,
closed=bool, extra_items=bool)
self.assertEqual(TD.__name__, 'TD')
self.assertEqual(TD.__annotations__, {'cls': type, 'self': object, 'typename': str,
'_typename': int, 'fields': list, '_fields': dict})
'_typename': int, 'fields': list, '_fields': dict,
'closed': bool, 'extra_items': bool})
self.assertIs(TD.__closed__, None)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertIs(TD.__extra_items__, NoExtraItems)
a = TD(cls=str, self=42, typename='foo', _typename=53,
fields=[('bar', tuple)], _fields={'baz', set})
fields=[('bar', tuple)], _fields={'baz', set},
closed=None, extra_items="tea pot")
self.assertEqual(a['cls'], str)
self.assertEqual(a['self'], 42)
self.assertEqual(a['typename'], 'foo')
self.assertEqual(a['_typename'], 53)
self.assertEqual(a['fields'], [('bar', tuple)])
self.assertEqual(a['_fields'], {'baz', set})
self.assertEqual(a['closed'], None)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertEqual(a['extra_items'], "tea pot")

def test_typeddict_create_errors(self):
with self.assertRaises(TypeError):
Expand Down Expand Up @@ -4294,24 +4304,6 @@ class ChildWithInlineAndOptional(Untotal, Inline):
{'inline': bool, 'untotal': str, 'child': bool},
)

class Closed(TypedDict, closed=True):
__extra_items__: None

class Unclosed(TypedDict, closed=False):
...

class ChildUnclosed(Closed, Unclosed):
...

self.assertFalse(ChildUnclosed.__closed__)
self.assertEqual(ChildUnclosed.__extra_items__, type(None))

class ChildClosed(Unclosed, Closed):
...

self.assertFalse(ChildClosed.__closed__)
self.assertEqual(ChildClosed.__extra_items__, type(None))

wrong_bases = [
(One, Regular),
(Regular, One),
Expand All @@ -4328,6 +4320,55 @@ class ChildClosed(Unclosed, Closed):
class Wrong(*bases):
pass

def test_closed_values(self):
class Implicit(TypedDict): ...
class ExplicitTrue(TypedDict, closed=True): ...
class ExplicitFalse(TypedDict, closed=False): ...

self.assertIs(Implicit.__closed__, None)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertIs(ExplicitTrue.__closed__, True)
self.assertIs(ExplicitFalse.__closed__, False)


@skipIf(TYPING_3_14_0, "only supported on older versions")
def test_closed_typeddict_compat(self):
class Closed(TypedDict, closed=True):
__extra_items__: None

class Unclosed(TypedDict, closed=False):
...

with self.assertWarns(DeprecationWarning):
class ChildUnclosed(Closed, Unclosed):
...

self.assertFalse(ChildUnclosed.__closed__)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertEqual(ChildUnclosed.__extra_items__, NoExtraItems)

with self.assertWarns(DeprecationWarning):
class ChildClosed(Unclosed, Closed):
...

self.assertFalse(ChildClosed.__closed__)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertEqual(ChildClosed.__extra_items__, NoExtraItems)

def test_extra_items_class_arg(self):
class TD(TypedDict, extra_items=int):
a: str

self.assertEqual(TD.__extra_items__, int)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
self.assertEqual(TD.__annotations__, {'a': str})
self.assertEqual(TD.__required_keys__, frozenset({'a'}))
self.assertEqual(TD.__optional_keys__, frozenset())

class NoExtra(TypedDict):
a: str

self.assertIs(NoExtra.__extra_items__, NoExtraItems)
self.assertEqual(NoExtra.__annotations__, {'a': str})
self.assertEqual(NoExtra.__required_keys__, frozenset({'a'}))
self.assertEqual(NoExtra.__optional_keys__, frozenset())

def test_is_typeddict(self):
self.assertIs(is_typeddict(Point2D), True)
self.assertIs(is_typeddict(Point2Dor3D), True)
Expand Down Expand Up @@ -4683,23 +4724,39 @@ class AllTheThings(TypedDict):
},
)

def test_extra_keys_non_readonly(self):
@skipIf(TYPING_3_14_0, "Old syntax only supported on <3.14")
def test_extra_keys_non_readonly_compat(self):
class Base(TypedDict, closed=True):
__extra_items__: str

class Child(Base):
a: NotRequired[int]
with self.assertWarns(DeprecationWarning):
class Child(Base):
a: NotRequired[int]

self.assertEqual(Child.__required_keys__, frozenset({}))
self.assertEqual(Child.__optional_keys__, frozenset({'a'}))
self.assertEqual(Child.__readonly_keys__, frozenset({}))
self.assertEqual(Child.__mutable_keys__, frozenset({'a'}))

@skipIf(TYPING_3_14_0, "Only supported on <3.14")
def test_extra_keys_readonly(self):
class Base(TypedDict, closed=True):
__extra_items__: ReadOnly[str]

class Child(Base):
with self.assertWarns(DeprecationWarning):
class Child(Base):
a: NotRequired[str]

self.assertEqual(Child.__required_keys__, frozenset({}))
self.assertEqual(Child.__optional_keys__, frozenset({'a'}))
self.assertEqual(Child.__readonly_keys__, frozenset({}))
self.assertEqual(Child.__mutable_keys__, frozenset({'a'}))
@skipIf(TYPING_3_14_0, "Only supported on <3.14")
def test_extra_keys_readonly_explicit_closed(self):
class Base(TypedDict, closed=True):
__extra_items__: ReadOnly[str]

class Child(Base, closed=True):
a: NotRequired[str]

self.assertEqual(Child.__required_keys__, frozenset({}))
Expand Down Expand Up @@ -4728,7 +4785,7 @@ class ExtraReadOnly(TypedDict):
self.assertEqual(ExtraReadOnly.__optional_keys__, frozenset({}))
self.assertEqual(ExtraReadOnly.__readonly_keys__, frozenset({'__extra_items__'}))
self.assertEqual(ExtraReadOnly.__mutable_keys__, frozenset({}))
self.assertEqual(ExtraReadOnly.__extra_items__, None)
self.assertEqual(ExtraReadOnly.__extra_items__, NoExtraItems)
self.assertFalse(ExtraReadOnly.__closed__)

class ExtraRequired(TypedDict):
Expand All @@ -4738,7 +4795,7 @@ class ExtraRequired(TypedDict):
self.assertEqual(ExtraRequired.__optional_keys__, frozenset({}))
self.assertEqual(ExtraRequired.__readonly_keys__, frozenset({}))
self.assertEqual(ExtraRequired.__mutable_keys__, frozenset({'__extra_items__'}))
self.assertEqual(ExtraRequired.__extra_items__, None)
self.assertEqual(ExtraRequired.__extra_items__, NoExtraItems)
self.assertFalse(ExtraRequired.__closed__)

class ExtraNotRequired(TypedDict):
Expand All @@ -4748,7 +4805,7 @@ class ExtraNotRequired(TypedDict):
self.assertEqual(ExtraNotRequired.__optional_keys__, frozenset({'__extra_items__'}))
self.assertEqual(ExtraNotRequired.__readonly_keys__, frozenset({}))
self.assertEqual(ExtraNotRequired.__mutable_keys__, frozenset({'__extra_items__'}))
self.assertEqual(ExtraNotRequired.__extra_items__, None)
self.assertEqual(ExtraNotRequired.__extra_items__, NoExtraItems)
self.assertFalse(ExtraNotRequired.__closed__)

def test_closed_inheritance(self):
Expand All @@ -4763,34 +4820,34 @@ class Base(TypedDict, closed=True):
self.assertEqual(Base.__extra_items__, ReadOnly[Union[str, None]])
self.assertTrue(Base.__closed__)

class Child(Base):
class Child(Base, closed=True):
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
a: int
__extra_items__: int

self.assertEqual(Child.__required_keys__, frozenset({'a', "__extra_items__"}))
self.assertEqual(Child.__required_keys__, frozenset({'a'}))
self.assertEqual(Child.__optional_keys__, frozenset({}))
self.assertEqual(Child.__readonly_keys__, frozenset({}))
self.assertEqual(Child.__mutable_keys__, frozenset({'a', "__extra_items__"}))
self.assertEqual(Child.__annotations__, {"__extra_items__": int, "a": int})
self.assertEqual(Child.__extra_items__, ReadOnly[Union[str, None]])
self.assertFalse(Child.__closed__)
self.assertEqual(Child.__mutable_keys__, frozenset({'a'}))
self.assertEqual(Child.__annotations__, {"a": int})
self.assertEqual(Child.__extra_items__, int)
self.assertTrue(Child.__closed__)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved

class GrandChild(Child, closed=True):
__extra_items__: str

self.assertEqual(GrandChild.__required_keys__, frozenset({'a', "__extra_items__"}))
self.assertEqual(GrandChild.__required_keys__, frozenset({'a'}))
self.assertEqual(GrandChild.__optional_keys__, frozenset({}))
self.assertEqual(GrandChild.__readonly_keys__, frozenset({}))
self.assertEqual(GrandChild.__mutable_keys__, frozenset({'a', "__extra_items__"}))
self.assertEqual(GrandChild.__annotations__, {"__extra_items__": int, "a": int})
self.assertEqual(GrandChild.__mutable_keys__, frozenset({'a'}))
self.assertEqual(GrandChild.__annotations__, {"a": int})
self.assertEqual(GrandChild.__extra_items__, str)
self.assertTrue(GrandChild.__closed__)

def test_implicit_extra_items(self):
class Base(TypedDict):
a: int

self.assertEqual(Base.__extra_items__, None)
self.assertEqual(Base.__extra_items__, NoExtraItems)
self.assertFalse(Base.__closed__)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved

class ChildA(Base, closed=True):
Expand All @@ -4799,6 +4856,10 @@ class ChildA(Base, closed=True):
self.assertEqual(ChildA.__extra_items__, Never)
self.assertTrue(ChildA.__closed__)
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved

@skipIf(TYPING_3_14_0, "Backwards compatibility only for Python 3.13")
def test_implicit_extra_items_before_3_14(self):
class Base(TypedDict):
a: int
class ChildB(Base, closed=True):
__extra_items__: None

Expand Down
Loading
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.