Skip to content

gh-132805 - annotationlib - Fix unions of real types and forward references. #132806

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+51 −6
Open

gh-132805 - annotationlib - Fix unions of real types and forward references. #132806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fba5efa
Add a test for union forward references
DavidCEllis Apr 22, 2025
d810953
Make stringifiers create unions if create_unions is True
DavidCEllis Apr 22, 2025
1908a4a
modify broken test, move test to forwardref format group
DavidCEllis Apr 22, 2025
97abdc7
Apparently trim trailing whitespace was turned off
DavidCEllis Apr 22, 2025
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
29 changes: 25 additions & 4 deletions Lib/annotationlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,12 +392,19 @@ def binop(self, other):
__mod__ = _make_binop(ast.Mod())
__lshift__ = _make_binop(ast.LShift())
__rshift__ = _make_binop(ast.RShift())
__or__ = _make_binop(ast.BitOr())
__xor__ = _make_binop(ast.BitXor())
__and__ = _make_binop(ast.BitAnd())
__floordiv__ = _make_binop(ast.FloorDiv())
__pow__ = _make_binop(ast.Pow())

def __or__(self, other):
if self.__stringifier_dict__.create_unions:
return types.UnionType[self, other]

return self.__make_new(
ast.BinOp(self.__get_ast(), ast.BitOr(), self.__convert_to_ast(other))
)

del _make_binop

def _make_rbinop(op: ast.AST):
Expand All @@ -416,12 +423,19 @@ def rbinop(self, other):
__rmod__ = _make_rbinop(ast.Mod())
__rlshift__ = _make_rbinop(ast.LShift())
__rrshift__ = _make_rbinop(ast.RShift())
__ror__ = _make_rbinop(ast.BitOr())
__rxor__ = _make_rbinop(ast.BitXor())
__rand__ = _make_rbinop(ast.BitAnd())
__rfloordiv__ = _make_rbinop(ast.FloorDiv())
__rpow__ = _make_rbinop(ast.Pow())

def __ror__(self, other):
if self.__stringifier_dict__.create_unions:
return types.UnionType[other, self]

return self.__make_new(
ast.BinOp(self.__convert_to_ast(other), ast.BitOr(), self.__get_ast())
)

del _make_rbinop

def _make_compare(op):
Expand Down Expand Up @@ -459,12 +473,13 @@ def unary_op(self):


class _StringifierDict(dict):
def __init__(self, namespace, globals=None, owner=None, is_class=False):
def __init__(self, namespace, globals=None, owner=None, is_class=False, create_unions=False):
super().__init__(namespace)
self.namespace = namespace
self.globals = globals
self.owner = owner
self.is_class = is_class
self.create_unions = create_unions
self.stringifiers = []

def __missing__(self, key):
Expand Down Expand Up @@ -569,7 +584,13 @@ def call_annotate_function(annotate, format, *, owner=None, _is_evaluate=False):
# that returns a bool and an defined set of attributes.
namespace = {**annotate.__builtins__, **annotate.__globals__}
is_class = isinstance(owner, type)
globals = _StringifierDict(namespace, annotate.__globals__, owner, is_class)
globals = _StringifierDict(
namespace,
annotate.__globals__,
owner,
is_class,
create_unions=True
)
if annotate.__closure__:
freevars = annotate.__code__.co_freevars
new_closure = []
Expand Down
28 changes: 26 additions & 2 deletions Lib/test/test_annotationlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,11 @@ def f(
self.assertEqual(z_anno, support.EqualToForwardRef("some(module)", owner=f))

alpha_anno = anno["alpha"]
self.assertIsInstance(alpha_anno, ForwardRef)
self.assertEqual(alpha_anno, support.EqualToForwardRef("some | obj", owner=f))
self.assertIsInstance(alpha_anno, Union)
self.assertEqual(
typing.get_args(alpha_anno),
(support.EqualToForwardRef("some", owner=f), support.EqualToForwardRef("obj", owner=f))
)

beta_anno = anno["beta"]
self.assertIsInstance(beta_anno, ForwardRef)
Expand All @@ -126,6 +129,27 @@ def f(
self.assertIsInstance(gamma_anno, ForwardRef)
self.assertEqual(gamma_anno, support.EqualToForwardRef("some < obj", owner=f))

def test_partially_nonexistent_union(self):
# Test unions with '|' syntax equal unions with typing.Union[] with some forwardrefs
class UnionForwardrefs:
pipe: str | undefined
union: Union[str, undefined]

annos = get_annotations(UnionForwardrefs, format=Format.FORWARDREF)

match = (
str,
support.EqualToForwardRef("undefined", is_class=True, owner=UnionForwardrefs)
)

self.assertEqual(
typing.get_args(annos["pipe"]),
typing.get_args(annos["union"])
)

self.assertEqual(typing.get_args(annos["pipe"]), match)
self.assertEqual(typing.get_args(annos["union"]), match)


class TestSourceFormat(unittest.TestCase):
def test_closure(self):
Expand Down
Loading