Update various comments now non-types dependencies are allowed (#9527)

python · Jan 14, 2023 · 1a9aa3f · 1a9aa3f
1 parent cd56735
commit 1a9aa3f
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 16 deletions.
diff --git a/stubs/D3DShot/d3dshot/capture_output.pyi b/stubs/D3DShot/d3dshot/capture_output.pyi
@@ -7,10 +7,8 @@ from typing_extensions import Literal, TypeAlias
 from PIL import Image
 
 _Frame: TypeAlias = Image.Image | Incomplete
-# TODO: Complete types once we can import non-types dependencies
-# See: #5768
+# stub_uploader doesn't allow numpy and torch because D3DShot doesn't declare it as a dependency
 # from torch import Tensor
-# from comtypes import IUnknown
 # import numpy.typing as npt
 # _Frame: TypeAlias = Image.Image | npt.NDArray[np.int32] | npt.NDArray[np.float32] | Tensor
 

diff --git a/stubs/D3DShot/d3dshot/capture_outputs/numpy_capture_output.pyi b/stubs/D3DShot/d3dshot/capture_outputs/numpy_capture_output.pyi
@@ -6,8 +6,7 @@ from typing_extensions import Literal, TypeAlias
 from d3dshot.capture_output import CaptureOutput
 from PIL import Image
 
-# TODO: Complete types once we can import non-types dependencies
-# See: #5768
+# stub_uploader doesn't allow numpy because D3DShot doesn't declare it as a dependency
 # import numpy as np
 # import numpy.typing as npt
 # _NDArray: TypeAlias = npt.NDArray[np.int32]

diff --git a/stubs/D3DShot/d3dshot/capture_outputs/numpy_float_capture_output.pyi b/stubs/D3DShot/d3dshot/capture_outputs/numpy_float_capture_output.pyi
@@ -1,5 +1,5 @@
 from d3dshot.capture_outputs.numpy_capture_output import NumpyCaptureOutput
 
-# TODO: Once we can import non-types dependencies, this CaptureOutput should be float based
-# See: #5768
+# stub_uploader doesn't allow numpy because D3DShot doesn't declare it as a dependency
+# this CaptureOutput should be float based
 class NumpyFloatCaptureOutput(NumpyCaptureOutput): ...
diff --git a/stubs/D3DShot/d3dshot/capture_outputs/pytorch_capture_output.pyi b/stubs/D3DShot/d3dshot/capture_outputs/pytorch_capture_output.pyi
@@ -6,8 +6,7 @@ from typing_extensions import Literal, TypeAlias
 from d3dshot.capture_output import CaptureOutput
 from PIL import Image
 
-# TODO: Complete types once we can import non-types dependencies
-# See: https://github.com/python/typeshed/issues/5768
+# stub_uploader doesn't allow torch because D3DShot doesn't declare it as a dependency
 # from torch import Tensor
 _Tensor: TypeAlias = Incomplete
 

diff --git a/stubs/D3DShot/d3dshot/dll/__init__.pyi b/stubs/D3DShot/d3dshot/dll/__init__.pyi
@@ -20,8 +20,8 @@ if sys.platform == "win32":
 else:
     _HRESULT: TypeAlias = Incomplete
 
-# TODO: Use comtypes.IUnknown once we can import non-types dependencies
-# See: #5768
+# comtypes is not typed
+# from comtypes import IUnknown
 class _IUnknown(_CData):
     def QueryInterface(self, interface: type, iid: _CData | None = ...) -> _HRESULT: ...
     def AddRef(self) -> c_ulong: ...

diff --git a/stubs/Pillow/@tests/stubtest_allowlist.txt b/stubs/Pillow/@tests/stubtest_allowlist.txt
@@ -1,7 +1,7 @@
 PIL.FpxImagePlugin
 PIL.ImageQt.ImageQt
 PIL.MicImagePlugin
-# Requires Pyside or PyQt to be installed.
+# Requires PySide or PyQt to be installed.
 # We don't install either in stubtest so it can't see it
 PIL.ImageQt.QImage
 PIL.ImageQt.QPixmap
diff --git a/stubs/PyScreeze/pyscreeze/__init__.pyi b/stubs/PyScreeze/pyscreeze/__init__.pyi
@@ -9,8 +9,12 @@ from PIL import Image
 _Unused: TypeAlias = object
 _P = ParamSpec("_P")
 _R = TypeVar("_R")
-# TODO: cv2.Mat is not available as a type yet: https://github.com/microsoft/python-type-stubs/issues/211
+# TODO: cv2.Mat is not available as a type yet:
+# https://github.com/microsoft/python-type-stubs/issues/211
+# https://github.com/microsoft/python-type-stubs/tree/main/cv2
+# https://github.com/opencv/opencv/pull/20370
 # cv2.Mat is just an alias for a numpy NDArray, but can't import that either.
+# Because pyscreeze does not declare it as a dependency, stub_uploader won't let it.
 _Mat: TypeAlias = Incomplete
 
 useOpenCV: bool
@@ -37,6 +41,7 @@ class RGB(NamedTuple):
 class PyScreezeException(Exception): ...
 class ImageNotFoundException(PyScreezeException): ...
 
+# _locateAll_opencv
 def requiresPillow(wrappedFunction: Callable[_P, _R]) -> Callable[_P, _R]: ...
 @overload
 def locate(

diff --git a/stubs/pyinstaller/PyInstaller/lib/modulegraph/modulegraph.pyi b/stubs/pyinstaller/PyInstaller/lib/modulegraph/modulegraph.pyi
@@ -1,10 +1,12 @@
+# Partial typing of the vendored modulegraph package.
+# We reference the vendored package rather than depending on the original untyped module.
+# Anything not referenced in the PyInstaller stubs doesn't need to be added here.
+
 from typing import Any, Protocol
 
 class _SupportsGraphident(Protocol):
     graphident: str
 
-# TODO: For typing purposes, once #5768 is complete, it'll be easier to use the modulegraph package directly.
-
 # code, filename and packagepath are always initialized to None. But they can be given a value later.
 class Node:
     # Compiled code. See stdlib.builtins.compile

diff --git a/tests/mypy_test.py b/tests/mypy_test.py
@@ -264,7 +264,7 @@ def run_mypy(
             # Stub completion is checked by pyright (--allow-*-defs)
             "--allow-untyped-defs",
             "--allow-incomplete-defs",
-            "--allow-subclassing-any",  # TODO: Do we still need this now that non-types dependencies are allowed? (#5768)
+            "--allow-subclassing-any",  # See #9491
             "--enable-error-code",
             "ignore-without-code",
             "--config-file",