mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-08 21:14:48 +08:00
builtins: Audit bytes arguments (#7631)
Most use the C buffer protocol, so _typeshed.ReadableBuffer is the right type. A few check specifically for bytes and bytearray.
This commit is contained in:
Jelle Zijlstra
@@ -199,7 +199,7 @@ _NegativeInteger: TypeAlias = Literal[-1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -
|
||||
|
||||
class int:
|
||||
@overload
|
||||
def __new__(cls: type[Self], __x: str | bytes | SupportsInt | SupportsIndex | SupportsTrunc = ...) -> Self: ...
|
||||
def __new__(cls: type[Self], __x: str | ReadableBuffer | SupportsInt | SupportsIndex | SupportsTrunc = ...) -> Self: ...
|
||||
@overload
|
||||
def __new__(cls: type[Self], __x: str | bytes | bytearray, base: SupportsIndex) -> Self: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
@@ -222,7 +222,7 @@ class int:
|
||||
@classmethod
|
||||
def from_bytes(
|
||||
cls: type[Self],
|
||||
bytes: Iterable[SupportsIndex] | SupportsBytes, # TODO buffer object argument
|
||||
bytes: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer,
|
||||
byteorder: Literal["little", "big"],
|
||||
*,
|
||||
signed: bool = ...,
|
||||
@@ -288,7 +288,7 @@ class int:
|
||||
def __index__(self) -> int: ...
|
||||
|
||||
class float:
|
||||
def __new__(cls: type[Self], x: SupportsFloat | SupportsIndex | str | bytes | bytearray = ...) -> Self: ...
|
||||
def __new__(cls: type[Self], x: SupportsFloat | SupportsIndex | str | ReadableBuffer = ...) -> Self: ...
|
||||
def as_integer_ratio(self) -> tuple[int, int]: ...
|
||||
def hex(self) -> str: ...
|
||||
def is_integer(self) -> bool: ...
|
||||
@@ -382,7 +382,7 @@ class str(Sequence[str]):
|
||||
@overload
|
||||
def __new__(cls: type[Self], object: object = ...) -> Self: ...
|
||||
@overload
|
||||
def __new__(cls: type[Self], object: bytes, encoding: str = ..., errors: str = ...) -> Self: ...
|
||||
def __new__(cls: type[Self], object: ReadableBuffer, encoding: str = ..., errors: str = ...) -> Self: ...
|
||||
def capitalize(self) -> str: ...
|
||||
def casefold(self) -> str: ...
|
||||
def center(self, __width: SupportsIndex, __fillchar: str = ...) -> str: ...
|
||||
@@ -479,11 +479,14 @@ class bytes(ByteString):
|
||||
def capitalize(self) -> bytes: ...
|
||||
def center(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytes: ...
|
||||
def count(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def decode(self, encoding: str = ..., errors: str = ...) -> str: ...
|
||||
def endswith(
|
||||
self, __suffix: bytes | tuple[bytes, ...], __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self,
|
||||
__suffix: ReadableBuffer | tuple[ReadableBuffer, ...],
|
||||
__start: SupportsIndex | None = ...,
|
||||
__end: SupportsIndex | None = ...,
|
||||
) -> bool: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
def expandtabs(self, tabsize: SupportsIndex = ...) -> bytes: ...
|
||||
@@ -491,7 +494,7 @@ class bytes(ByteString):
|
||||
def expandtabs(self, tabsize: int = ...) -> bytes: ...
|
||||
|
||||
def find(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
def hex(self, sep: str | bytes = ..., bytes_per_sep: SupportsIndex = ...) -> str: ...
|
||||
@@ -499,7 +502,7 @@ class bytes(ByteString):
|
||||
def hex(self) -> str: ...
|
||||
|
||||
def index(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def isalnum(self) -> bool: ...
|
||||
def isalpha(self) -> bool: ...
|
||||
@@ -511,41 +514,44 @@ class bytes(ByteString):
|
||||
def isspace(self) -> bool: ...
|
||||
def istitle(self) -> bool: ...
|
||||
def isupper(self) -> bool: ...
|
||||
def join(self, __iterable_of_bytes: Iterable[ByteString | memoryview]) -> bytes: ...
|
||||
def ljust(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytes: ...
|
||||
def join(self, __iterable_of_bytes: Iterable[ReadableBuffer]) -> bytes: ...
|
||||
def ljust(self, __width: SupportsIndex, __fillchar: bytes | bytearray = ...) -> bytes: ...
|
||||
def lower(self) -> bytes: ...
|
||||
def lstrip(self, __bytes: bytes | None = ...) -> bytes: ...
|
||||
def partition(self, __sep: bytes) -> tuple[bytes, bytes, bytes]: ...
|
||||
def replace(self, __old: bytes, __new: bytes, __count: SupportsIndex = ...) -> bytes: ...
|
||||
def lstrip(self, __bytes: ReadableBuffer | None = ...) -> bytes: ...
|
||||
def partition(self, __sep: ReadableBuffer) -> tuple[bytes, bytes, bytes]: ...
|
||||
def replace(self, __old: ReadableBuffer, __new: ReadableBuffer, __count: SupportsIndex = ...) -> bytes: ...
|
||||
if sys.version_info >= (3, 9):
|
||||
def removeprefix(self, __prefix: bytes) -> bytes: ...
|
||||
def removesuffix(self, __suffix: bytes) -> bytes: ...
|
||||
def removeprefix(self, __prefix: ReadableBuffer) -> bytes: ...
|
||||
def removesuffix(self, __suffix: ReadableBuffer) -> bytes: ...
|
||||
|
||||
def rfind(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def rindex(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def rjust(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytes: ...
|
||||
def rpartition(self, __sep: bytes) -> tuple[bytes, bytes, bytes]: ...
|
||||
def rsplit(self, sep: bytes | None = ..., maxsplit: SupportsIndex = ...) -> list[bytes]: ...
|
||||
def rstrip(self, __bytes: bytes | None = ...) -> bytes: ...
|
||||
def split(self, sep: bytes | None = ..., maxsplit: SupportsIndex = ...) -> list[bytes]: ...
|
||||
def rjust(self, __width: SupportsIndex, __fillchar: bytes | bytearray = ...) -> bytes: ...
|
||||
def rpartition(self, __sep: ReadableBuffer) -> tuple[bytes, bytes, bytes]: ...
|
||||
def rsplit(self, sep: ReadableBuffer | None = ..., maxsplit: SupportsIndex = ...) -> list[bytes]: ...
|
||||
def rstrip(self, __bytes: ReadableBuffer | None = ...) -> bytes: ...
|
||||
def split(self, sep: ReadableBuffer | None = ..., maxsplit: SupportsIndex = ...) -> list[bytes]: ...
|
||||
def splitlines(self, keepends: bool = ...) -> list[bytes]: ...
|
||||
def startswith(
|
||||
self, __prefix: bytes | tuple[bytes, ...], __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self,
|
||||
__prefix: ReadableBuffer | tuple[ReadableBuffer, ...],
|
||||
__start: SupportsIndex | None = ...,
|
||||
__end: SupportsIndex | None = ...,
|
||||
) -> bool: ...
|
||||
def strip(self, __bytes: bytes | None = ...) -> bytes: ...
|
||||
def strip(self, __bytes: ReadableBuffer | None = ...) -> bytes: ...
|
||||
def swapcase(self) -> bytes: ...
|
||||
def title(self) -> bytes: ...
|
||||
def translate(self, __table: bytes | None, delete: bytes = ...) -> bytes: ...
|
||||
def translate(self, __table: ReadableBuffer | None, delete: bytes = ...) -> bytes: ...
|
||||
def upper(self) -> bytes: ...
|
||||
def zfill(self, __width: SupportsIndex) -> bytes: ...
|
||||
@classmethod
|
||||
def fromhex(cls: type[Self], __s: str) -> Self: ...
|
||||
@staticmethod
|
||||
def maketrans(__frm: bytes, __to: bytes) -> bytes: ...
|
||||
def maketrans(__frm: ReadableBuffer, __to: ReadableBuffer) -> bytes: ...
|
||||
def __len__(self) -> int: ...
|
||||
def __iter__(self) -> Iterator[int]: ...
|
||||
def __hash__(self) -> int: ...
|
||||
@@ -553,7 +559,7 @@ class bytes(ByteString):
|
||||
def __getitem__(self, __i: SupportsIndex) -> int: ...
|
||||
@overload
|
||||
def __getitem__(self, __s: slice) -> bytes: ...
|
||||
def __add__(self, __s: bytes) -> bytes: ...
|
||||
def __add__(self, __s: ReadableBuffer) -> bytes: ...
|
||||
def __mul__(self, __n: SupportsIndex) -> bytes: ...
|
||||
def __rmul__(self, __n: SupportsIndex) -> bytes: ...
|
||||
def __mod__(self, __value: Any) -> bytes: ...
|
||||
@@ -582,12 +588,15 @@ class bytearray(MutableSequence[int], ByteString):
|
||||
def capitalize(self) -> bytearray: ...
|
||||
def center(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytearray: ...
|
||||
def count(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def copy(self) -> bytearray: ...
|
||||
def decode(self, encoding: str = ..., errors: str = ...) -> str: ...
|
||||
def endswith(
|
||||
self, __suffix: bytes | tuple[bytes, ...], __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self,
|
||||
__suffix: ReadableBuffer | tuple[ReadableBuffer, ...],
|
||||
__start: SupportsIndex | None = ...,
|
||||
__end: SupportsIndex | None = ...,
|
||||
) -> bool: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
def expandtabs(self, tabsize: SupportsIndex = ...) -> bytearray: ...
|
||||
@@ -596,7 +605,7 @@ class bytearray(MutableSequence[int], ByteString):
|
||||
|
||||
def extend(self, __iterable_of_ints: Iterable[SupportsIndex]) -> None: ...
|
||||
def find(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
def hex(self, sep: str | bytes = ..., bytes_per_sep: SupportsIndex = ...) -> str: ...
|
||||
@@ -604,7 +613,7 @@ class bytearray(MutableSequence[int], ByteString):
|
||||
def hex(self) -> str: ...
|
||||
|
||||
def index(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def insert(self, __index: SupportsIndex, __item: SupportsIndex) -> None: ...
|
||||
def isalnum(self) -> bool: ...
|
||||
@@ -617,43 +626,46 @@ class bytearray(MutableSequence[int], ByteString):
|
||||
def isspace(self) -> bool: ...
|
||||
def istitle(self) -> bool: ...
|
||||
def isupper(self) -> bool: ...
|
||||
def join(self, __iterable_of_bytes: Iterable[ByteString | memoryview]) -> bytearray: ...
|
||||
def ljust(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytearray: ...
|
||||
def join(self, __iterable_of_bytes: Iterable[ReadableBuffer]) -> bytearray: ...
|
||||
def ljust(self, __width: SupportsIndex, __fillchar: bytes | bytearray = ...) -> bytearray: ...
|
||||
def lower(self) -> bytearray: ...
|
||||
def lstrip(self, __bytes: bytes | None = ...) -> bytearray: ...
|
||||
def partition(self, __sep: bytes) -> tuple[bytearray, bytearray, bytearray]: ...
|
||||
def lstrip(self, __bytes: ReadableBuffer | None = ...) -> bytearray: ...
|
||||
def partition(self, __sep: ReadableBuffer) -> tuple[bytearray, bytearray, bytearray]: ...
|
||||
def pop(self, __index: int = ...) -> int: ...
|
||||
def remove(self, __value: int) -> None: ...
|
||||
if sys.version_info >= (3, 9):
|
||||
def removeprefix(self, __prefix: bytes) -> bytearray: ...
|
||||
def removesuffix(self, __suffix: bytes) -> bytearray: ...
|
||||
def removeprefix(self, __prefix: ReadableBuffer) -> bytearray: ...
|
||||
def removesuffix(self, __suffix: ReadableBuffer) -> bytearray: ...
|
||||
|
||||
def replace(self, __old: bytes, __new: bytes, __count: SupportsIndex = ...) -> bytearray: ...
|
||||
def replace(self, __old: ReadableBuffer, __new: ReadableBuffer, __count: SupportsIndex = ...) -> bytearray: ...
|
||||
def rfind(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def rindex(
|
||||
self, __sub: bytes | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self, __sub: ReadableBuffer | SupportsIndex, __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
) -> int: ...
|
||||
def rjust(self, __width: SupportsIndex, __fillchar: bytes = ...) -> bytearray: ...
|
||||
def rpartition(self, __sep: bytes) -> tuple[bytearray, bytearray, bytearray]: ...
|
||||
def rsplit(self, sep: bytes | None = ..., maxsplit: SupportsIndex = ...) -> list[bytearray]: ...
|
||||
def rstrip(self, __bytes: bytes | None = ...) -> bytearray: ...
|
||||
def split(self, sep: bytes | None = ..., maxsplit: SupportsIndex = ...) -> list[bytearray]: ...
|
||||
def rjust(self, __width: SupportsIndex, __fillchar: bytes | bytearray = ...) -> bytearray: ...
|
||||
def rpartition(self, __sep: ReadableBuffer) -> tuple[bytearray, bytearray, bytearray]: ...
|
||||
def rsplit(self, sep: ReadableBuffer | None = ..., maxsplit: SupportsIndex = ...) -> list[bytearray]: ...
|
||||
def rstrip(self, __bytes: ReadableBuffer | None = ...) -> bytearray: ...
|
||||
def split(self, sep: ReadableBuffer | None = ..., maxsplit: SupportsIndex = ...) -> list[bytearray]: ...
|
||||
def splitlines(self, keepends: bool = ...) -> list[bytearray]: ...
|
||||
def startswith(
|
||||
self, __prefix: bytes | tuple[bytes, ...], __start: SupportsIndex | None = ..., __end: SupportsIndex | None = ...
|
||||
self,
|
||||
__prefix: ReadableBuffer | tuple[ReadableBuffer, ...],
|
||||
__start: SupportsIndex | None = ...,
|
||||
__end: SupportsIndex | None = ...,
|
||||
) -> bool: ...
|
||||
def strip(self, __bytes: bytes | None = ...) -> bytearray: ...
|
||||
def strip(self, __bytes: ReadableBuffer | None = ...) -> bytearray: ...
|
||||
def swapcase(self) -> bytearray: ...
|
||||
def title(self) -> bytearray: ...
|
||||
def translate(self, __table: bytes | None, delete: bytes = ...) -> bytearray: ...
|
||||
def translate(self, __table: ReadableBuffer | None, delete: bytes = ...) -> bytearray: ...
|
||||
def upper(self) -> bytearray: ...
|
||||
def zfill(self, __width: SupportsIndex) -> bytearray: ...
|
||||
@classmethod
|
||||
def fromhex(cls: type[Self], __string: str) -> Self: ...
|
||||
@staticmethod
|
||||
def maketrans(__frm: bytes, __to: bytes) -> bytes: ...
|
||||
def maketrans(__frm: ReadableBuffer, __to: ReadableBuffer) -> bytes: ...
|
||||
def __len__(self) -> int: ...
|
||||
def __iter__(self) -> Iterator[int]: ...
|
||||
__hash__: ClassVar[None] # type: ignore[assignment]
|
||||
@@ -666,14 +678,15 @@ class bytearray(MutableSequence[int], ByteString):
|
||||
@overload
|
||||
def __setitem__(self, __s: slice, __x: Iterable[SupportsIndex] | bytes) -> None: ...
|
||||
def __delitem__(self, __i: SupportsIndex | slice) -> None: ...
|
||||
def __add__(self, __s: bytes) -> bytearray: ...
|
||||
def __iadd__(self: Self, __s: Iterable[int]) -> Self: ...
|
||||
def __add__(self, __s: ReadableBuffer) -> bytearray: ...
|
||||
# The superclass wants us to accept Iterable[int], but that fails at runtime.
|
||||
def __iadd__(self: Self, __s: ReadableBuffer) -> Self: ... # type: ignore[override]
|
||||
def __mul__(self, __n: SupportsIndex) -> bytearray: ...
|
||||
def __rmul__(self, __n: SupportsIndex) -> bytearray: ...
|
||||
def __imul__(self: Self, __n: SupportsIndex) -> Self: ...
|
||||
def __mod__(self, __value: Any) -> bytes: ...
|
||||
# Incompatible with Sequence.__contains__
|
||||
def __contains__(self, __o: SupportsIndex | bytes) -> bool: ... # type: ignore[override]
|
||||
def __contains__(self, __o: SupportsIndex | ReadableBuffer) -> bool: ... # type: ignore[override]
|
||||
def __eq__(self, __x: object) -> bool: ...
|
||||
def __ne__(self, __x: object) -> bool: ...
|
||||
def __lt__(self, __x: bytes) -> bool: ...
|
||||
@@ -722,7 +735,7 @@ class memoryview(Sized, Sequence[int]):
|
||||
def __iter__(self) -> Iterator[int]: ...
|
||||
def __len__(self) -> int: ...
|
||||
@overload
|
||||
def __setitem__(self, __s: slice, __o: bytes) -> None: ...
|
||||
def __setitem__(self, __s: slice, __o: ReadableBuffer) -> None: ...
|
||||
@overload
|
||||
def __setitem__(self, __i: SupportsIndex, __o: SupportsIndex) -> None: ...
|
||||
if sys.version_info >= (3, 8):
|
||||
@@ -1086,8 +1099,8 @@ if sys.version_info >= (3, 10):
|
||||
# TODO: `compile` has a more precise return type in reality; work on a way of expressing that?
|
||||
if sys.version_info >= (3, 8):
|
||||
def compile(
|
||||
source: str | bytes | AST,
|
||||
filename: str | bytes | _PathLike[Any],
|
||||
source: str | ReadableBuffer | AST,
|
||||
filename: str | ReadableBuffer | _PathLike[Any],
|
||||
mode: str,
|
||||
flags: int = ...,
|
||||
dont_inherit: int = ...,
|
||||
@@ -1098,8 +1111,8 @@ if sys.version_info >= (3, 8):
|
||||
|
||||
else:
|
||||
def compile(
|
||||
source: str | bytes | AST,
|
||||
filename: str | bytes | _PathLike[Any],
|
||||
source: str | ReadableBuffer | AST,
|
||||
filename: str | ReadableBuffer | _PathLike[Any],
|
||||
mode: str,
|
||||
flags: int = ...,
|
||||
dont_inherit: int = ...,
|
||||
@@ -1118,12 +1131,12 @@ def divmod(__x: _T_contra, __y: SupportsRDivMod[_T_contra, _T_co]) -> _T_co: ...
|
||||
# The `globals` argument to `eval` has to be `dict[str, Any]` rather than `dict[str, object]` due to invariance.
|
||||
# (The `globals` argument has to be a "real dict", rather than any old mapping, unlike the `locals` argument.)
|
||||
def eval(
|
||||
__source: str | bytes | CodeType, __globals: dict[str, Any] | None = ..., __locals: Mapping[str, object] | None = ...
|
||||
__source: str | ReadableBuffer | CodeType, __globals: dict[str, Any] | None = ..., __locals: Mapping[str, object] | None = ...
|
||||
) -> Any: ...
|
||||
|
||||
# Comment above regarding `eval` applies to `exec` as well
|
||||
def exec(
|
||||
__source: str | bytes | CodeType, __globals: dict[str, Any] | None = ..., __locals: Mapping[str, object] | None = ...
|
||||
__source: str | ReadableBuffer | CodeType, __globals: dict[str, Any] | None = ..., __locals: Mapping[str, object] | None = ...
|
||||
) -> None: ...
|
||||
def exit(code: object = ...) -> NoReturn: ...
|
||||
|
||||
@@ -1351,7 +1364,7 @@ def open(
|
||||
closefd: bool = ...,
|
||||
opener: _Opener | None = ...,
|
||||
) -> IO[Any]: ...
|
||||
def ord(__c: str | bytes) -> int: ...
|
||||
def ord(__c: str | bytes | bytearray) -> int: ...
|
||||
|
||||
class _SupportsWriteAndFlush(SupportsWrite[_T_contra], Protocol[_T_contra]):
|
||||
def flush(self) -> None: ...
|
||||
@@ -1712,7 +1725,7 @@ class UnicodeDecodeError(UnicodeError):
|
||||
start: int
|
||||
end: int
|
||||
reason: str
|
||||
def __init__(self, __encoding: str, __object: bytes, __start: int, __end: int, __reason: str) -> None: ...
|
||||
def __init__(self, __encoding: str, __object: ReadableBuffer, __start: int, __end: int, __reason: str) -> None: ...
|
||||
|
||||
class UnicodeEncodeError(UnicodeError):
|
||||
encoding: str
|
||||
|
||||
Reference in New Issue
Block a user