Erste Version
This commit is contained in:
commit
782b1850a3
1641 files changed
+512713
No files matched your search
@@ -0,0 +1,75 @@
|
||||
"""Set of common pygame type aliases for proper typehint annotations"""
|
||||
|
||||
# NOTE: `src_py/typing.py` and `buildconfig/stubs/pygame/typing.pyi` must be duplicates.
|
||||
# Use the command `python buildconfig/stubs/gen_stubs.py` to copy typing.py to typing.pyi
|
||||
|
||||
__all__ = [
|
||||
"RectLike",
|
||||
"SequenceLike",
|
||||
"FileLike",
|
||||
"ColorLike",
|
||||
"Point",
|
||||
"IntPoint",
|
||||
]
|
||||
|
||||
from abc import abstractmethod
|
||||
from collections.abc import Callable
|
||||
from os import PathLike as _PathProtocol
|
||||
from typing import IO, Protocol, TypeAlias, TypeVar
|
||||
|
||||
from pygame.color import Color
|
||||
from pygame.rect import FRect, Rect
|
||||
|
||||
# For functions that take a file name
|
||||
_PathLike: TypeAlias = str | bytes | _PathProtocol[str] | _PathProtocol[bytes]
|
||||
# Most pygame functions that take a file argument should be able to handle a FileLike type
|
||||
FileLike: TypeAlias = _PathLike | IO[bytes] | IO[str]
|
||||
|
||||
_T_co = TypeVar("_T_co", covariant=True)
|
||||
|
||||
|
||||
class SequenceLike(Protocol[_T_co]):
|
||||
"""
|
||||
Variant of the standard `Sequence` ABC that only requires `__getitem__` and `__len__`.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def __getitem__(self, index: int, /) -> _T_co: ...
|
||||
@abstractmethod
|
||||
def __len__(self) -> int: ...
|
||||
|
||||
|
||||
# Modify typehints when it is possible to annotate sizes
|
||||
|
||||
# Pygame handles float without errors in most cases where a point is expected,
|
||||
# usually rounding to int. Also, 'int | float == float'
|
||||
Point: TypeAlias = SequenceLike[float]
|
||||
# This is used where ints are strictly required
|
||||
IntPoint: TypeAlias = SequenceLike[int]
|
||||
|
||||
ColorLike: TypeAlias = Color | SequenceLike[int] | str | int
|
||||
|
||||
|
||||
class _HasRectAttribute(Protocol):
|
||||
# An object that has a rect attribute that is either a rect, or a function
|
||||
# that returns a rect conforms to the rect protocol
|
||||
@property
|
||||
def rect(self) -> "RectLike | Callable[[], RectLike]": ...
|
||||
|
||||
|
||||
RectLike: TypeAlias = (
|
||||
Rect | FRect | SequenceLike[float] | SequenceLike[Point] | _HasRectAttribute
|
||||
)
|
||||
|
||||
|
||||
# cleanup namespace
|
||||
del (
|
||||
abstractmethod,
|
||||
Color,
|
||||
Rect,
|
||||
FRect,
|
||||
IO,
|
||||
Callable,
|
||||
TypeVar,
|
||||
Protocol,
|
||||
)
|
||||
Reference in new issue
Block a user