Make regex methods accept all buffer types as inputs

stdlib/_typeshed/__init__.pyi

@@ -190,6 +190,8 @@ WriteableBuffer = Union[bytearray, memoryview, array.array[Any], mmap.mmap, ctyp
 # Same as _WriteableBuffer, but also includes read-only buffer types (like bytes).
 ReadableBuffer = Union[ReadOnlyBuffer, WriteableBuffer]  # stable
 
+StrOrBuffer = TypeVar("StrOrBuffer", str, ReadOnlyBuffer, WriteableBuffer)  # noqa Y001
+
 # stable
 if sys.version_info >= (3, 10):
     from types import NoneType as NoneType

stdlib/re.pyi

@@ -1,7 +1,8 @@
 import enum
 import sys
+from _typeshed import StrOrBuffer
 from sre_constants import error as error
-from typing import Any, AnyStr, Callable, Iterator, Union, overload
+from typing import Any, Callable, Iterator, Union, overload
 
 # ----- re variables and constants -----
 if sys.version_info >= (3, 7):
@@ -52,66 +53,90 @@ if sys.version_info < (3, 7):
     _pattern_type: type
 
 @overload
-def compile(pattern: AnyStr, flags: _FlagsType = ...) -> Pattern[AnyStr]: ...
+def compile(pattern: StrOrBuffer, flags: _FlagsType = ...) -> Pattern[StrOrBuffer]: ...
 @overload
-def compile(pattern: Pattern[AnyStr], flags: _FlagsType = ...) -> Pattern[AnyStr]: ...
+def compile(pattern: Pattern[StrOrBuffer], flags: _FlagsType = ...) -> Pattern[StrOrBuffer]: ...
 @overload
-def search(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def search(pattern: StrOrBuffer, string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 @overload
-def search(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def search(pattern: Pattern[StrOrBuffer], string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 @overload
-def match(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def match(pattern: StrOrBuffer, string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 @overload
-def match(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def match(pattern: Pattern[StrOrBuffer], string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 
 # New in Python 3.4
 @overload
-def fullmatch(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def fullmatch(pattern: StrOrBuffer, string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 @overload
-def fullmatch(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Match[AnyStr] | None: ...
+def fullmatch(pattern: Pattern[StrOrBuffer], string: StrOrBuffer, flags: _FlagsType = ...) -> Match[StrOrBuffer] | None: ...
 @overload
-def split(pattern: AnyStr, string: AnyStr, maxsplit: int = ..., flags: _FlagsType = ...) -> list[AnyStr | Any]: ...
+def split(pattern: StrOrBuffer, string: StrOrBuffer, maxsplit: int = ..., flags: _FlagsType = ...) -> list[StrOrBuffer | Any]: ...
 @overload
-def split(pattern: Pattern[AnyStr], string: AnyStr, maxsplit: int = ..., flags: _FlagsType = ...) -> list[AnyStr | Any]: ...
+def split(
+    pattern: Pattern[StrOrBuffer], string: StrOrBuffer, maxsplit: int = ..., flags: _FlagsType = ...
+) -> list[StrOrBuffer | Any]: ...
 @overload
-def findall(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> list[Any]: ...
+def findall(pattern: StrOrBuffer, string: StrOrBuffer, flags: _FlagsType = ...) -> list[Any]: ...
 @overload
-def findall(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> list[Any]: ...
+def findall(pattern: Pattern[StrOrBuffer], string: StrOrBuffer, flags: _FlagsType = ...) -> list[Any]: ...
 
 # Return an iterator yielding match objects over all non-overlapping matches
 # for the RE pattern in string. The string is scanned left-to-right, and
 # matches are returned in the order found. Empty matches are included in the
 # result unless they touch the beginning of another match.
 @overload
-def finditer(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Iterator[Match[AnyStr]]: ...
+def finditer(pattern: StrOrBuffer, string: StrOrBuffer, flags: _FlagsType = ...) -> Iterator[Match[StrOrBuffer]]: ...
 @overload
-def finditer(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Iterator[Match[AnyStr]]: ...
+def finditer(pattern: Pattern[StrOrBuffer], string: StrOrBuffer, flags: _FlagsType = ...) -> Iterator[Match[StrOrBuffer]]: ...
 @overload
-def sub(pattern: AnyStr, repl: AnyStr, string: AnyStr, count: int = ..., flags: _FlagsType = ...) -> AnyStr: ...
+def sub(
+    pattern: StrOrBuffer, repl: StrOrBuffer, string: StrOrBuffer, count: int = ..., flags: _FlagsType = ...
+) -> StrOrBuffer: ...
 @overload
 def sub(
-    pattern: AnyStr, repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ..., flags: _FlagsType = ...
-) -> AnyStr: ...
+    pattern: StrOrBuffer,
+    repl: Callable[[Match[StrOrBuffer]], StrOrBuffer],
+    string: StrOrBuffer,
+    count: int = ...,
+    flags: _FlagsType = ...,
+) -> StrOrBuffer: ...
 @overload
-def sub(pattern: Pattern[AnyStr], repl: AnyStr, string: AnyStr, count: int = ..., flags: _FlagsType = ...) -> AnyStr: ...
+def sub(
+    pattern: Pattern[StrOrBuffer], repl: StrOrBuffer, string: StrOrBuffer, count: int = ..., flags: _FlagsType = ...
+) -> StrOrBuffer: ...
 @overload
 def sub(
-    pattern: Pattern[AnyStr], repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ..., flags: _FlagsType = ...
-) -> AnyStr: ...
+    pattern: Pattern[StrOrBuffer],
+    repl: Callable[[Match[StrOrBuffer]], StrOrBuffer],
+    string: StrOrBuffer,
+    count: int = ...,
+    flags: _FlagsType = ...,
+) -> StrOrBuffer: ...
 @overload
-def subn(pattern: AnyStr, repl: AnyStr, string: AnyStr, count: int = ..., flags: _FlagsType = ...) -> tuple[AnyStr, int]: ...
+def subn(
+    pattern: StrOrBuffer, repl: StrOrBuffer, string: StrOrBuffer, count: int = ..., flags: _FlagsType = ...
+) -> tuple[StrOrBuffer, int]: ...
 @overload
 def subn(
-    pattern: AnyStr, repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ..., flags: _FlagsType = ...
-) -> tuple[AnyStr, int]: ...
+    pattern: StrOrBuffer,
+    repl: Callable[[Match[StrOrBuffer]], StrOrBuffer],
+    string: StrOrBuffer,
+    count: int = ...,
+    flags: _FlagsType = ...,
+) -> tuple[StrOrBuffer, int]: ...
 @overload
 def subn(
-    pattern: Pattern[AnyStr], repl: AnyStr, string: AnyStr, count: int = ..., flags: _FlagsType = ...
-) -> tuple[AnyStr, int]: ...
+    pattern: Pattern[StrOrBuffer], repl: StrOrBuffer, string: StrOrBuffer, count: int = ..., flags: _FlagsType = ...
+) -> tuple[StrOrBuffer, int]: ...
 @overload
 def subn(
-    pattern: Pattern[AnyStr], repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ..., flags: _FlagsType = ...
-) -> tuple[AnyStr, int]: ...
-def escape(pattern: AnyStr) -> AnyStr: ...
+    pattern: Pattern[StrOrBuffer],
+    repl: Callable[[Match[StrOrBuffer]], StrOrBuffer],
+    string: StrOrBuffer,
+    count: int = ...,
+    flags: _FlagsType = ...,
+) -> tuple[StrOrBuffer, int]: ...
+def escape(pattern: StrOrBuffer) -> StrOrBuffer: ...
 def purge() -> None: ...
-def template(pattern: AnyStr | Pattern[AnyStr], flags: _FlagsType = ...) -> Pattern[AnyStr]: ...
+def template(pattern: StrOrBuffer | Pattern[StrOrBuffer], flags: _FlagsType = ...) -> Pattern[StrOrBuffer]: ...

stdlib/typing.pyi

@@ -1,6 +1,6 @@
 import collections  # Needed by aliases like DefaultDict, see mypy issue 2986
 import sys
-from _typeshed import Self, SupportsKeysAndGetItem
+from _typeshed import Self, StrOrBuffer, SupportsKeysAndGetItem
 from abc import ABCMeta, abstractmethod
 from types import BuiltinFunctionType, CodeType, FrameType, FunctionType, MethodType, ModuleType, TracebackType
 from typing_extensions import Literal as _Literal, ParamSpec as _ParamSpec, final as _final
@@ -587,69 +587,71 @@ class TextIO(IO[str]):
 class ByteString(Sequence[int], metaclass=ABCMeta): ...
 
 @_final
-class Match(Generic[AnyStr]):
+class Match(Generic[StrOrBuffer]):
     pos: int
     endpos: int
     lastindex: int | None
     lastgroup: str | None
-    string: AnyStr
+    string: StrOrBuffer
 
     # The regular expression object whose match() or search() method produced
     # this match instance.
-    re: Pattern[AnyStr]
-    def expand(self, template: AnyStr) -> AnyStr: ...
-    # group() returns "AnyStr" or "AnyStr | None", depending on the pattern.
+    re: Pattern[StrOrBuffer]
+    def expand(self, template: StrOrBuffer) -> StrOrBuffer: ...
+    # group() returns "StrOrBuffer" or "StrOrBuffer | None", depending on the pattern.
     @overload
-    def group(self, __group: _Literal[0] = ...) -> AnyStr: ...
+    def group(self, __group: _Literal[0] = ...) -> StrOrBuffer: ...
     @overload
-    def group(self, __group: str | int) -> AnyStr | Any: ...
+    def group(self, __group: str | int) -> StrOrBuffer | Any: ...
     @overload
-    def group(self, __group1: str | int, __group2: str | int, *groups: str | int) -> tuple[AnyStr | Any, ...]: ...
-    # Each item of groups()'s return tuple is either "AnyStr" or
-    # "AnyStr | None", depending on the pattern.
+    def group(self, __group1: str | int, __group2: str | int, *groups: str | int) -> tuple[StrOrBuffer | Any, ...]: ...
+    # Each item of groups()'s return tuple is either "StrOrBuffer" or
+    # "StrOrBuffer | None", depending on the pattern.
     @overload
-    def groups(self) -> tuple[AnyStr | Any, ...]: ...
+    def groups(self) -> tuple[StrOrBuffer | Any, ...]: ...
     @overload
-    def groups(self, default: _T) -> tuple[AnyStr | _T, ...]: ...
-    # Each value in groupdict()'s return dict is either "AnyStr" or
-    # "AnyStr | None", depending on the pattern.
+    def groups(self, default: _T) -> tuple[StrOrBuffer | _T, ...]: ...
+    # Each value in groupdict()'s return dict is either "StrOrBuffer" or
+    # "StrOrBuffer | None", depending on the pattern.
     @overload
-    def groupdict(self) -> dict[str, AnyStr | Any]: ...
+    def groupdict(self) -> dict[str, StrOrBuffer | Any]: ...
     @overload
-    def groupdict(self, default: _T) -> dict[str, AnyStr | _T]: ...
+    def groupdict(self, default: _T) -> dict[str, StrOrBuffer | _T]: ...
     def start(self, __group: int | str = ...) -> int: ...
     def end(self, __group: int | str = ...) -> int: ...
     def span(self, __group: int | str = ...) -> tuple[int, int]: ...
     @property
     def regs(self) -> tuple[tuple[int, int], ...]: ...  # undocumented
-    # __getitem__() returns "AnyStr" or "AnyStr | None", depending on the pattern.
+    # __getitem__() returns "StrOrBuffer" or "StrOrBuffer | None", depending on the pattern.
     @overload
-    def __getitem__(self, __key: _Literal[0]) -> AnyStr: ...
+    def __getitem__(self, __key: _Literal[0]) -> StrOrBuffer: ...
     @overload
-    def __getitem__(self, __key: int | str) -> AnyStr | Any: ...
+    def __getitem__(self, __key: int | str) -> StrOrBuffer | Any: ...
     if sys.version_info >= (3, 9):
         def __class_getitem__(cls, item: Any) -> GenericAlias: ...
 
 @_final
-class Pattern(Generic[AnyStr]):
+class Pattern(Generic[StrOrBuffer]):
     flags: int
     groupindex: Mapping[str, int]
     groups: int
-    pattern: AnyStr
-    def search(self, string: AnyStr, pos: int = ..., endpos: int = ...) -> Match[AnyStr] | None: ...
-    def match(self, string: AnyStr, pos: int = ..., endpos: int = ...) -> Match[AnyStr] | None: ...
-    def fullmatch(self, string: AnyStr, pos: int = ..., endpos: int = ...) -> Match[AnyStr] | None: ...
-    def split(self, string: AnyStr, maxsplit: int = ...) -> list[AnyStr | Any]: ...
-    def findall(self, string: AnyStr, pos: int = ..., endpos: int = ...) -> list[Any]: ...
-    def finditer(self, string: AnyStr, pos: int = ..., endpos: int = ...) -> Iterator[Match[AnyStr]]: ...
+    pattern: StrOrBuffer
+    def search(self, string: StrOrBuffer, pos: int = ..., endpos: int = ...) -> Match[StrOrBuffer] | None: ...
+    def match(self, string: StrOrBuffer, pos: int = ..., endpos: int = ...) -> Match[StrOrBuffer] | None: ...
+    def fullmatch(self, string: StrOrBuffer, pos: int = ..., endpos: int = ...) -> Match[StrOrBuffer] | None: ...
+    def split(self, string: StrOrBuffer, maxsplit: int = ...) -> list[StrOrBuffer | Any]: ...
+    def findall(self, string: StrOrBuffer, pos: int = ..., endpos: int = ...) -> list[Any]: ...
+    def finditer(self, string: StrOrBuffer, pos: int = ..., endpos: int = ...) -> Iterator[Match[StrOrBuffer]]: ...
     @overload
-    def sub(self, repl: AnyStr, string: AnyStr, count: int = ...) -> AnyStr: ...
+    def sub(self, repl: StrOrBuffer, string: StrOrBuffer, count: int = ...) -> StrOrBuffer: ...
     @overload
-    def sub(self, repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ...) -> AnyStr: ...
+    def sub(self, repl: Callable[[Match[StrOrBuffer]], StrOrBuffer], string: StrOrBuffer, count: int = ...) -> StrOrBuffer: ...
     @overload
-    def subn(self, repl: AnyStr, string: AnyStr, count: int = ...) -> tuple[AnyStr, int]: ...
+    def subn(self, repl: StrOrBuffer, string: StrOrBuffer, count: int = ...) -> tuple[StrOrBuffer, int]: ...
     @overload
-    def subn(self, repl: Callable[[Match[AnyStr]], AnyStr], string: AnyStr, count: int = ...) -> tuple[AnyStr, int]: ...
+    def subn(
+        self, repl: Callable[[Match[StrOrBuffer]], StrOrBuffer], string: StrOrBuffer, count: int = ...
+    ) -> tuple[StrOrBuffer, int]: ...
     if sys.version_info >= (3, 9):
         def __class_getitem__(cls, item: Any) -> GenericAlias: ...