add stubs for m3u8

pyrightconfig.stricter.json

@@ -59,6 +59,7 @@
         "stubs/jsonschema",
         "stubs/jwcrypto",
         "stubs/ldap3",
+        "stubs/m3u8",
         "stubs/Markdown",
         "stubs/mysqlclient",
         "stubs/netaddr/netaddr/core.pyi",

stubs/m3u8/@tests/stubtest_allowlist.txt

@@ -0,0 +1,17 @@
+# type check only
+m3u8.httpclient.HTTPSHandler.__new__
+# internal functions and attributes
+m3u8.M3U8.simple_attributes
+m3u8.model.M3U8.simple_attributes
+m3u8.model.denormalize_attribute
+m3u8.model.find_key
+m3u8.model.number_to_string
+m3u8.model.quoted
+m3u8.parser.cast_date_time
+m3u8.parser.format_date_time
+m3u8.parser.get_segment_custom_value
+m3u8.parser.normalize_attribute
+m3u8.parser.remove_quotes
+m3u8.parser.remove_quotes_parser
+m3u8.parser.save_segment_custom_value
+m3u8.parser.string_to_lines

stubs/m3u8/METADATA.toml

@@ -0,0 +1,2 @@
+version = "6.0.*"
+upstream_repository = "https://github.com/globocom/m3u8"

stubs/m3u8/m3u8/__init__.pyi

@@ -0,0 +1,74 @@
+from _typeshed import Incomplete
+from collections.abc import Callable, Mapping
+from typing import Any
+from typing_extensions import TypeAlias
+
+from m3u8.httpclient import _HTTPClientProtocol
+from m3u8.model import (
+    M3U8,
+    ContentSteering,
+    DateRange,
+    DateRangeList,
+    IFramePlaylist,
+    ImagePlaylist,
+    Key,
+    Media,
+    MediaList,
+    PartialSegment,
+    PartialSegmentList,
+    PartInformation,
+    Playlist,
+    PlaylistList,
+    PreloadHint,
+    RenditionReport,
+    RenditionReportList,
+    Segment,
+    SegmentList,
+    ServerControl,
+    Skip,
+    Start,
+    Tiles,
+)
+from m3u8.parser import ParseError, parse
+
+__all__ = (
+    "M3U8",
+    "Segment",
+    "SegmentList",
+    "PartialSegment",
+    "PartialSegmentList",
+    "Key",
+    "Playlist",
+    "IFramePlaylist",
+    "Media",
+    "MediaList",
+    "PlaylistList",
+    "Start",
+    "RenditionReport",
+    "RenditionReportList",
+    "ServerControl",
+    "Skip",
+    "PartInformation",
+    "PreloadHint",
+    "DateRange",
+    "DateRangeList",
+    "ContentSteering",
+    "ImagePlaylist",
+    "Tiles",
+    "loads",
+    "load",
+    "parse",
+    "ParseError",
+)
+
+_CustomTagsParser: TypeAlias = Callable[[str, int, dict[str, Any], dict[str, Any]], object]
+
+def loads(content: str, uri: str | None = None, custom_tags_parser: _CustomTagsParser | None = None) -> M3U8: ...
+def load(
+    uri: str,
+    timeout: Incomplete | None = None,
+    headers: Mapping[str, Any] = {},
+    custom_tags_parser: _CustomTagsParser | None = None,
+    http_client: _HTTPClientProtocol = ...,
+    verify_ssl: bool = True,
+) -> M3U8: ...

stubs/m3u8/m3u8/httpclient.pyi

@@ -0,0 +1,19 @@
+import urllib.request
+from typing import Any, Protocol, type_check_only
+
+@type_check_only
+class _HTTPClientProtocol(Protocol):  # noqa: Y046
+    def download(
+        self, uri: str, timeout: float | None = None, headers: dict[str, Any] = {}, verify_ssl: bool = True
+    ) -> tuple[str, str]: ...
+
+class DefaultHTTPClient:
+    proxies: dict[str, str] | None
+
+    def __init__(self, proxies: dict[str, str] | None = None) -> None: ...
+    def download(
+        self, uri: str, timeout: float | None = None, headers: dict[str, Any] = {}, verify_ssl: bool = True
+    ) -> tuple[str, str]: ...
+
+class HTTPSHandler:
+    def __new__(cls, verify_ssl: bool = True) -> urllib.request.HTTPSHandler: ...  # type: ignore

stubs/m3u8/m3u8/mixins.pyi

@@ -0,0 +1,27 @@
+# mypy: disable-error-code="attr-defined"
+
+from abc import ABCMeta
+from collections.abc import Iterable
+from typing import Protocol, TypeVar
+
+_T = TypeVar("_T")
+
+class BasePathMixin(Protocol):
+    uri: str | None
+    @property
+    def absolute_uri(self) -> str: ...
+    @property
+    def base_path(self) -> str: ...
+    @base_path.setter
+    def base_path(self, newbase_path: str) -> None: ...
+    def get_path_from_uri(self) -> str: ...
+
+class GroupedBasePathMixin(Iterable[_T], metaclass=ABCMeta):
+    @property
+    def base_uri(self) -> str: ...
+    @base_uri.setter
+    def base_uri(self, __new_url: str, /) -> None: ...
+    @property
+    def base_path(self) -> str: ...
+    @base_path.setter
+    def base_path(self, __new_url: str, /) -> None: ...