opencv-python stubs

pyrightconfig.stricter.json

@@ -52,6 +52,7 @@
         "stubs/protobuf",
         "stubs/google-cloud-ndb",
         "stubs/influxdb-client",
+        "stubs/opencv-python/cv2/cv2.pyi",
         "stubs/passlib",
         "stubs/peewee",
         "stubs/pika",

stubs/opencv-python/@tests/stubtest_allowlist.txt

@@ -0,0 +1,18 @@
+# Partial files inserted in code when generating config.
+cv2.config-?.*
+
+# Python 2
+cv2.load_config_py2
+
+# Specific args and kwargs definition
+cv2.GMat.__init__
+cv2.cv2.GMat.__init__
+cv2.mat_wrapper.Mat.__init__
+cv2.mat_wrapper.Mat.__new__
+
+# In actual execution, these wouldn't be None during error handling
+(cv2\.)?cv2.error\..*
+
+# cv2.Mat is not a Union
+# We cheat the Mat type because of variance issues
+cv2.Mat

stubs/opencv-python/METADATA.toml

@@ -0,0 +1,5 @@
+# Can't bump to 4.6 until https://github.com/opencv/opencv-python/issues/676 is fixed.
+version = "4.5.*"
+
+[tool.stubtest]
+ignore_missing_stub = false

stubs/opencv-python/cv2/Error.pyi

@@ -0,0 +1,110 @@
+BAD_ALIGN: int
+BAD_ALPHA_CHANNEL: int
+BAD_CALL_BACK: int
+BAD_COI: int
+BAD_DATA_PTR: int
+BAD_DEPTH: int
+BAD_IMAGE_SIZE: int
+BAD_MODEL_OR_CH_SEQ: int
+BAD_NUM_CHANNEL1U: int
+BAD_NUM_CHANNELS: int
+BAD_OFFSET: int
+BAD_ORDER: int
+BAD_ORIGIN: int
+BAD_ROISIZE: int
+BAD_STEP: int
+BAD_TILE_SIZE: int
+BadAlign: int
+BadAlphaChannel: int
+BadCOI: int
+BadCallBack: int
+BadDataPtr: int
+BadDepth: int
+BadImageSize: int
+BadModelOrChSeq: int
+BadNumChannel1U: int
+BadNumChannels: int
+BadOffset: int
+BadOrder: int
+BadOrigin: int
+BadROISize: int
+BadStep: int
+BadTileSize: int
+GPU_API_CALL_ERROR: int
+GPU_NOT_SUPPORTED: int
+GpuApiCallError: int
+GpuNotSupported: int
+HEADER_IS_NULL: int
+HeaderIsNull: int
+MASK_IS_TILED: int
+MaskIsTiled: int
+OPEN_CLAPI_CALL_ERROR: int
+OPEN_CLDOUBLE_NOT_SUPPORTED: int
+OPEN_CLINIT_ERROR: int
+OPEN_CLNO_AMDBLAS_FFT: int
+OPEN_GL_API_CALL_ERROR: int
+OPEN_GL_NOT_SUPPORTED: int
+OpenCLApiCallError: int
+OpenCLDoubleNotSupported: int
+OpenCLInitError: int
+OpenCLNoAMDBlasFft: int
+OpenGlApiCallError: int
+OpenGlNotSupported: int
+STS_ASSERT: int
+STS_AUTO_TRACE: int
+STS_BACK_TRACE: int
+STS_BAD_ARG: int
+STS_BAD_FLAG: int
+STS_BAD_FUNC: int
+STS_BAD_MASK: int
+STS_BAD_MEM_BLOCK: int
+STS_BAD_POINT: int
+STS_BAD_SIZE: int
+STS_DIV_BY_ZERO: int
+STS_ERROR: int
+STS_FILTER_OFFSET_ERR: int
+STS_FILTER_STRUCT_CONTENT_ERR: int
+STS_INPLACE_NOT_SUPPORTED: int
+STS_INTERNAL: int
+STS_KERNEL_STRUCT_CONTENT_ERR: int
+STS_NOT_IMPLEMENTED: int
+STS_NO_CONV: int
+STS_NO_MEM: int
+STS_NULL_PTR: int
+STS_OBJECT_NOT_FOUND: int
+STS_OK: int
+STS_OUT_OF_RANGE: int
+STS_PARSE_ERROR: int
+STS_UNMATCHED_FORMATS: int
+STS_UNMATCHED_SIZES: int
+STS_UNSUPPORTED_FORMAT: int
+STS_VEC_LENGTH_ERR: int
+StsAssert: int
+StsAutoTrace: int
+StsBackTrace: int
+StsBadArg: int
+StsBadFlag: int
+StsBadFunc: int
+StsBadMask: int
+StsBadMemBlock: int
+StsBadPoint: int
+StsBadSize: int
+StsDivByZero: int
+StsError: int
+StsFilterOffsetErr: int
+StsFilterStructContentErr: int
+StsInplaceNotSupported: int
+StsInternal: int
+StsKernelStructContentErr: int
+StsNoConv: int
+StsNoMem: int
+StsNotImplemented: int
+StsNullPtr: int
+StsObjectNotFound: int
+StsOk: int
+StsOutOfRange: int
+StsParseError: int
+StsUnmatchedFormats: int
+StsUnmatchedSizes: int
+StsUnsupportedFormat: int
+StsVecLengthErr: int

stubs/opencv-python/cv2/__init__.pyi

@@ -0,0 +1,21 @@
+from typing_extensions import TypeAlias
+
+from cv2 import (
+    Error as Error,
+    data as data,
+    gapi as gapi,
+    mat_wrapper as mat_wrapper,
+    misc as misc,
+    utils as utils,
+    version as version,
+)
+from cv2.cv2 import *
+from cv2.mat_wrapper import Mat as _WrappedMat, _NDArray, _NDArrayF
+
+__all__: list[str] = []
+
+def bootstrap() -> None: ...
+
+Mat: TypeAlias = _WrappedMat | _NDArray
+# TODO: Make Mat generic with int or float
+_MatF: TypeAlias = _WrappedMat | _NDArrayF  # noqa: Y047

stubs/opencv-python/cv2/cuda.pyi

@@ -0,0 +1,78 @@
+from typing import TypeVar, overload
+
+from cv2 import Mat
+from cv2.cv2 import _Boolean, _NumericScalar, _UMat, cuda_Event, cuda_GpuMat, cuda_GpuMat_Allocator, cuda_Stream
+
+_TGpuMat = TypeVar("_TGpuMat", bound=cuda_GpuMat | _UMat)
+
+DEVICE_INFO_COMPUTE_MODE_DEFAULT: int
+DEVICE_INFO_COMPUTE_MODE_EXCLUSIVE: int
+DEVICE_INFO_COMPUTE_MODE_EXCLUSIVE_PROCESS: int
+DEVICE_INFO_COMPUTE_MODE_PROHIBITED: int
+DYNAMIC_PARALLELISM: int
+DeviceInfo_ComputeModeDefault: int
+DeviceInfo_ComputeModeExclusive: int
+DeviceInfo_ComputeModeExclusiveProcess: int
+DeviceInfo_ComputeModeProhibited: int
+EVENT_BLOCKING_SYNC: int
+EVENT_DEFAULT: int
+EVENT_DISABLE_TIMING: int
+EVENT_INTERPROCESS: int
+Event_BLOCKING_SYNC: int
+Event_DEFAULT: int
+Event_DISABLE_TIMING: int
+Event_INTERPROCESS: int
+FEATURE_SET_COMPUTE_10: int
+FEATURE_SET_COMPUTE_11: int
+FEATURE_SET_COMPUTE_12: int
+FEATURE_SET_COMPUTE_13: int
+FEATURE_SET_COMPUTE_20: int
+FEATURE_SET_COMPUTE_21: int
+FEATURE_SET_COMPUTE_30: int
+FEATURE_SET_COMPUTE_32: int
+FEATURE_SET_COMPUTE_35: int
+FEATURE_SET_COMPUTE_50: int
+GLOBAL_ATOMICS: int
+HOST_MEM_PAGE_LOCKED: int
+HOST_MEM_SHARED: int
+HOST_MEM_WRITE_COMBINED: int
+HostMem_PAGE_LOCKED: int
+HostMem_SHARED: int
+HostMem_WRITE_COMBINED: int
+NATIVE_DOUBLE: int
+SHARED_ATOMICS: int
+WARP_SHUFFLE_FUNCTIONS: int
+
+def Event_elapsedTime(start: cuda_Event, end: cuda_Event) -> float: ...
+def GpuMat_defaultAllocator() -> cuda_GpuMat_Allocator: ...
+def GpuMat_setDefaultAllocator(allocator: cuda_GpuMat_Allocator) -> None: ...
+def Stream_Null() -> cuda_Stream: ...
+def TargetArchs_has(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasBin(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasEqualOrGreater(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasEqualOrGreaterBin(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasEqualOrGreaterPtx(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasEqualOrLessPtx(major: int | None, minor: int | None) -> bool: ...
+def TargetArchs_hasPtx(major: int | None, minor: int | None) -> bool: ...
+@overload
+def createContinuous(rows: int, cols: int, type: int, arr: _NumericScalar) -> Mat: ...  # type: ignore[misc]  # https://github.com/python/mypy/issues/8881
+@overload
+def createContinuous(rows: int, cols: int, type: int, arr: _TGpuMat) -> _TGpuMat: ...  # type: ignore[misc]  # https://github.com/python/mypy/issues/8881
+@overload
+def createContinuous(rows: int | None, cols: int | None, type: int | None, arr: cuda_GpuMat | _UMat = ...) -> None: ...
+@overload
+def ensureSizeIsEnough(rows: int, cols: int, type: int, arr: _NumericScalar) -> Mat: ...  # type: ignore[misc]  # https://github.com/python/mypy/issues/8881
+@overload
+def ensureSizeIsEnough(rows: int, cols: int, type: int, arr: _TGpuMat) -> _TGpuMat: ...  # type: ignore[misc]  # https://github.com/python/mypy/issues/8881
+@overload
+def ensureSizeIsEnough(rows: int | None, cols: int | None, type: int | None, arr: cuda_GpuMat | _UMat = ...) -> None: ...
+def getCudaEnabledDeviceCount() -> int: ...
+def getDevice() -> int: ...
+def printCudaDeviceInfo(device: int | None) -> None: ...
+def printShortCudaDeviceInfo(device: int | None) -> None: ...
+def registerPageLocked(m: Mat | _NumericScalar) -> None: ...
+def resetDevice() -> None: ...
+def setBufferPoolConfig(deviceId: int | None, stackSize: int | None, stackCount: int | None) -> None: ...
+def setBufferPoolUsage(on: _Boolean) -> None: ...
+def setDevice(device: int | None) -> None: ...
+def unregisterPageLocked(m: Mat | _NumericScalar) -> None: ...