Add defaults for params and constants in pyscreeze (#9641)

This commit is contained in:
Avasam
2023-01-31 20:56:29 -05:00
committed by GitHub
parent 2539649560
commit 0e7365a7ef

View File

@@ -1,7 +1,7 @@
from _typeshed import Incomplete, StrOrBytesPath
from collections.abc import Callable, Generator
from typing import NamedTuple, SupportsFloat, TypeVar, overload
from typing_extensions import Literal, ParamSpec, SupportsIndex, TypeAlias
from typing_extensions import Final, ParamSpec, SupportsIndex, TypeAlias
from PIL import Image
@@ -16,11 +16,12 @@ _R = TypeVar("_R")
# Because pyscreeze does not declare it as a dependency, stub_uploader won't let it.
_Mat: TypeAlias = Incomplete
useOpenCV: bool
RUNNING_PYTHON_2: Literal[False]
GRAYSCALE_DEFAULT: Literal[False]
useOpenCV: Final[bool]
RUNNING_PYTHON_2: Final = False
GRAYSCALE_DEFAULT: Final = False
scrotExists: Final[bool]
# Meant to be overridable for backward-compatibility
USE_IMAGE_NOT_FOUND_EXCEPTION: bool
scrotExists: bool
class Box(NamedTuple):
left: int
@@ -47,11 +48,11 @@ def locate(
needleImage: str | Image.Image | _Mat,
haystackImage: str | Image.Image | _Mat,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Box | None: ...
# _locateAll_python / _locateAll_pillow
@@ -60,37 +61,37 @@ def locate(
needleImage: str | Image.Image,
haystackImage: str | Image.Image,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: None = None,
) -> Box | None: ...
# _locateAll_opencv
@overload
def locateOnScreen(
image: str | Image.Image | _Mat,
minSearchTime: float = ...,
minSearchTime: float = 0,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Box | None: ...
# _locateAll_python / _locateAll_pillow
@overload
def locateOnScreen(
image: str | Image.Image,
minSearchTime: float = ...,
minSearchTime: float = 0,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: None = None,
) -> Box | None: ...
# _locateAll_opencv
@@ -98,11 +99,11 @@ def locateOnScreen(
def locateAllOnScreen(
image: str | Image.Image | _Mat,
*,
grayscale: bool | None = ...,
limit: int = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: int = 1000,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Generator[Box, None, None]: ...
# _locateAll_python / _locateAll_pillow
@@ -110,11 +111,11 @@ def locateAllOnScreen(
def locateAllOnScreen(
image: str | Image.Image,
*,
grayscale: bool | None = ...,
limit: int | None = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: int | None = None,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: None = None,
) -> Generator[Box, None, None]: ...
# _locateAll_opencv
@@ -123,11 +124,11 @@ def locateCenterOnScreen(
image: str | Image.Image | _Mat,
*,
minSearchTime: float,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Point | None: ...
# _locateAll_python / _locateAll_pillow
@@ -136,11 +137,11 @@ def locateCenterOnScreen(
image: str | Image.Image,
*,
minSearchTime: float,
grayscale: bool | None = ...,
limit: _Unused = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: None = None,
) -> Point | None: ...
# _locateAll_opencv
@@ -149,10 +150,10 @@ def locateOnWindow(
image: str | Image.Image | _Mat,
title: str,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Box | None: ...
# _locateAll_python / _locateAll_pillow
@@ -161,18 +162,20 @@ def locateOnWindow(
image: str | Image.Image,
title: str,
*,
grayscale: bool | None = ...,
limit: _Unused = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: _Unused = 1,
step: int = 1,
confidence: None = None,
) -> Box | None: ...
def showRegionOnScreen(region: tuple[int, int, int, int], outlineColor: str = ..., filename: str = ...) -> None: ...
def showRegionOnScreen(
region: tuple[int, int, int, int], outlineColor: str = "red", filename: str = "_showRegionOnScreen.png"
) -> None: ...
def center(coords: tuple[int, int, int, int]) -> Point: ...
def pixelMatchesColor(
x: int, y: int, expectedRGBColor: tuple[int, int, int] | tuple[int, int, int, int], tolerance: int = ...
x: int, y: int, expectedRGBColor: tuple[int, int, int] | tuple[int, int, int, int], tolerance: int = 0
) -> bool: ...
def pixel(x: int, y: int) -> tuple[int, int, int]: ...
def screenshot(imageFilename: StrOrBytesPath | None = ..., region: tuple[int, int, int, int] | None = ...) -> Image.Image: ...
def screenshot(imageFilename: StrOrBytesPath | None = None, region: tuple[int, int, int, int] | None = None) -> Image.Image: ...
grab = screenshot
# _locateAll_opencv
@@ -180,11 +183,11 @@ grab = screenshot
def locateAll(
needleImage: str | Image.Image | _Mat,
haystackImage: str | Image.Image | _Mat,
grayscale: bool | None = ...,
limit: int = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: SupportsFloat | SupportsIndex | str = ...,
grayscale: bool | None = None,
limit: int = 1000,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: SupportsFloat | SupportsIndex | str = 0.999,
) -> Generator[Box, None, None]: ...
# _locateAll_python / _locateAll_pillow
@@ -192,9 +195,9 @@ def locateAll(
def locateAll(
needleImage: str | Image.Image,
haystackImage: str | Image.Image,
grayscale: bool | None = ...,
limit: int | None = ...,
region: tuple[int, int, int, int] | None = ...,
step: int = ...,
confidence: None = ...,
grayscale: bool | None = None,
limit: int | None = None,
region: tuple[int, int, int, int] | None = None,
step: int = 1,
confidence: None = None,
) -> Generator[Box, None, None]: ...