Allow any sliceable sequence as getopt args (#13116)

Author: Avasam

stdlib/distutils/fancy_getopt.pyi

@@ -1,10 +1,10 @@
 from collections.abc import Iterable, Mapping
+from getopt import _SliceableT, _StrSequenceT_co
 from re import Pattern
 from typing import Any, Final, overload
 from typing_extensions import TypeAlias
 
 _Option: TypeAlias = tuple[str, str | None, str]
-_GR: TypeAlias = tuple[list[str], OptionDummy]
 
 longopt_pat: Final = r"[a-zA-Z](?:[a-zA-Z0-9-]*)"
 longopt_re: Final[Pattern[str]]
@@ -15,15 +15,25 @@ class FancyGetopt:
     def __init__(self, option_table: list[_Option] | None = None) -> None: ...
     # TODO kinda wrong, `getopt(object=object())` is invalid
     @overload
-    def getopt(self, args: list[str] | None = None) -> _GR: ...
+    def getopt(
+        self, args: _SliceableT[_StrSequenceT_co] | None = None, object: None = None
+    ) -> tuple[_StrSequenceT_co, OptionDummy]: ...
     @overload
-    def getopt(self, args: list[str] | None, object: Any) -> list[str]: ...
+    def getopt(
+        self, args: _SliceableT[_StrSequenceT_co] | None, object: Any
+    ) -> _StrSequenceT_co: ...  # object is an arbitrary non-slotted object
     def get_option_order(self) -> list[tuple[str, str]]: ...
     def generate_help(self, header: str | None = None) -> list[str]: ...
 
+# Same note as FancyGetopt.getopt
+@overload
 def fancy_getopt(
-    options: list[_Option], negative_opt: Mapping[_Option, _Option], object: Any, args: list[str] | None
-) -> list[str] | _GR: ...
+    options: list[_Option], negative_opt: Mapping[_Option, _Option], object: None, args: _SliceableT[_StrSequenceT_co] | None
+) -> tuple[_StrSequenceT_co, OptionDummy]: ...
+@overload
+def fancy_getopt(
+    options: list[_Option], negative_opt: Mapping[_Option, _Option], object: Any, args: _SliceableT[_StrSequenceT_co] | None
+) -> _StrSequenceT_co: ...
 
 WS_TRANS: Final[dict[int, str]]
 

stdlib/getopt.pyi

@@ -1,10 +1,22 @@
-from collections.abc import Iterable
+from collections.abc import Iterable, Sequence
+from typing import Protocol, TypeVar, overload, type_check_only
+
+_StrSequenceT_co = TypeVar("_StrSequenceT_co", covariant=True, bound=Sequence[str])
+
+@type_check_only
+class _SliceableT(Protocol[_StrSequenceT_co]):
+    @overload
+    def __getitem__(self, key: int, /) -> str: ...
+    @overload
+    def __getitem__(self, key: slice, /) -> _StrSequenceT_co: ...
 
 __all__ = ["GetoptError", "error", "getopt", "gnu_getopt"]
 
-def getopt(args: list[str], shortopts: str, longopts: Iterable[str] | str = []) -> tuple[list[tuple[str, str]], list[str]]: ...
+def getopt(
+    args: _SliceableT[_StrSequenceT_co], shortopts: str, longopts: Iterable[str] | str = []
+) -> tuple[list[tuple[str, str]], _StrSequenceT_co]: ...
 def gnu_getopt(
-    args: list[str], shortopts: str, longopts: Iterable[str] | str = []
+    args: Sequence[str], shortopts: str, longopts: Iterable[str] | str = []
 ) -> tuple[list[tuple[str, str]], list[str]]: ...
 
 class GetoptError(Exception):