Skip to content

Commit

Permalink
bpo-46553: allow bare typing.ClassVar annotations (#30983)
Browse files Browse the repository at this point in the history
These are used in the wild and covered by dataclasses unit tests.
Several static type checkers support this pattern.
  • Loading branch information
GBeauregard committed Jan 28, 2022
1 parent 45faf15 commit 5445e17
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
6 changes: 5 additions & 1 deletion Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -2071,7 +2071,7 @@ def test_fail_with_bare_union(self):
with self.assertRaises(TypeError):
Tuple[Optional]
with self.assertRaises(TypeError):
ClassVar[ClassVar]
ClassVar[ClassVar[int]]
with self.assertRaises(TypeError):
List[ClassVar[int]]

Expand Down Expand Up @@ -2896,12 +2896,16 @@ def test_special_forms_forward(self):
class C:
a: Annotated['ClassVar[int]', (3, 5)] = 4
b: Annotated['Final[int]', "const"] = 4
x: 'ClassVar' = 4
y: 'Final' = 4

class CF:
b: List['Final[int]'] = 4

self.assertEqual(get_type_hints(C, globals())['a'], ClassVar[int])
self.assertEqual(get_type_hints(C, globals())['b'], Final[int])
self.assertEqual(get_type_hints(C, globals())['x'], ClassVar)
self.assertEqual(get_type_hints(C, globals())['y'], Final)
with self.assertRaises(TypeError):
get_type_hints(CF, globals()),

Expand Down
2 changes: 1 addition & 1 deletion Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ def _type_check(arg, msg, is_argument=True, module=None, *, allow_special_forms=
if (isinstance(arg, _GenericAlias) and
arg.__origin__ in invalid_generic_forms):
raise TypeError(f"{arg} is not valid as type argument")
if arg in (Any, NoReturn, Final):
if arg in (Any, NoReturn, ClassVar, Final):
return arg
if isinstance(arg, _SpecialForm) or arg in (Generic, Protocol):
raise TypeError(f"Plain {arg} is not valid as type argument")
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
In :func:`typing.get_type_hints`, support evaluating bare stringified ``ClassVar`` annotations. Patch by Gregory Beauregard.

0 comments on commit 5445e17

Please sign in to comment.