Add import Union to stub file (python#12929)

mypy/stubgen.py

@@ -125,6 +125,7 @@
     TypeList,
     TypeStrVisitor,
     UnboundType,
+    UnionType,
     get_proper_type,
 )
 from mypy.visitor import NodeVisitor
@@ -461,6 +462,17 @@ def import_lines(self) -> List[str]:
         module_map: Mapping[str, List[str]] = defaultdict(list)
 
         for name in sorted(self.required_names):
+            # We don't want to ignore Union even if it's not listed in the import statement because for PEP 604 style of
+            # Union we're still generating explicit Union e.g.
+            #
+            # def foo(a: int | str):
+            #     print(a)
+            # ==>
+            # def foo(a: Union[int | str]): ...
+
+            if name == "Union":
+                self.module_for[name] = 'typing'
+
             # If we haven't seen this name in an import statement, ignore it
             if name not in self.module_for:
                 continue
@@ -693,6 +705,8 @@ def visit_func_def(
                 # Luckily, an argument explicitly annotated with "Any" has
                 # type "UnboundType" and will not match.
                 if not isinstance(get_proper_type(annotated_type), AnyType):
+                    if isinstance(get_proper_type(annotated_type), UnionType):
+                        self.add_typing_import("Union")
                     annotation = f": {self.print_annotation(annotated_type)}"
 
             if kind.is_named() and not any(arg.startswith("*") for arg in args):
@@ -722,6 +736,8 @@ def visit_func_def(
                 # type "UnboundType" and will enter the else branch.
                 retname = None  # implicit Any
             else:
+                if isinstance(get_proper_type(o.unanalyzed_type.ret_type), UnionType):
+                    self.add_typing_import("Union")
                 retname = self.print_annotation(o.unanalyzed_type.ret_type)
         elif isinstance(o, FuncDef) and (
             o.abstract_status == IS_ABSTRACT or o.name in METHODS_WITH_RETURN_VALUE

test-data/unit/stubgen.test

@@ -2705,3 +2705,19 @@ def f():
     return 0
 [out]
 def f(): ...
+
+[case testAddUnionImportForArgument]
+def foo(a: str | None):
+    pass
+[out]
+from typing import Union
+
+def foo(a: Union[str, None]): ...
+
+[case testAddUnionImportForReturn]
+def foo() -> str | None:
+    pass
+[out]
+from typing import Union
+
+def foo() -> Union[str, None]: ...