Add yt-dlp stubs

Author: Tatsh

stubs/yt-dlp/@tests/stubtest_allowlist.txt

@@ -0,0 +1,40 @@
+# Extractors do not need to be stubbed.
+yt_dlp.extractor.*
+# Postprocessors will not be stubbed at this time.
+yt_dlp.postprocessor.*
+# Won't be covered.
+yt_dlp.__main__
+yt_dlp.__pyinstaller.*
+yt_dlp.compat.shutil.*
+yt_dlp.compat.types.*
+yt_dlp.compat.urllib.*
+yt_dlp.dependencies.*
+yt_dlp.downloader.FileDownloader.parse_bytes
+yt_dlp.jsinterp.Debugger.sys
+yt_dlp.utils.xattr
+yt_dlp.networking.impersonate.ImpersonateTarget._DT
+yt_dlp.downloader.bunnycdn
+# Deprecated
+yt_dlp.networking.common.Response.getcode
+yt_dlp.networking.common.Response.code
+yt_dlp.networking.common.Response.getheader
+yt_dlp.networking.common.Response.geturl
+yt_dlp.networking.common.Response.info
+yt_dlp.networking.Response.code
+yt_dlp.networking.Response.getcode
+yt_dlp.networking.Response.geturl
+yt_dlp.networking.Response.getheader
+yt_dlp.networking.Response.info
+yt_dlp.utils._legacy.decode_png
+# except IndexError is sufficient.
+yt_dlp.utils._utils.PlaylistEntries.IndexError
+yt_dlp.utils._utils.PagedList.IndexError
+yt_dlp.utils._utils.LazyList.IndexError
+yt_dlp.utils.LazyList.IndexError
+yt_dlp.utils.PagedList.IndexError
+yt_dlp.utils.PlaylistEntries.IndexError
+# Custom __all__
+yt_dlp.utils.__all__
+yt_dlp.networking.__all__
+# websockets is not typed or stubbed.
+yt_dlp.networking._websockets

stubs/yt-dlp/METADATA.toml

@@ -0,0 +1,2 @@
+version = "2025.05.*"
+upstream_repository = "https://github.com/yt-dlp/yt-dlp"

stubs/yt-dlp/yt_dlp/YoutubeDL.pyi

@@ -0,0 +1,107 @@
+from _typeshed import Incomplete
+from collections.abc import Collection
+from functools import cached_property
+from typing_extensions import Self
+
+from . import _Params
+from .extractor.common import InfoExtractor
+
+class YoutubeDL:
+    params: Incomplete
+    cache: Incomplete
+    format_selector: Incomplete
+    archive: Incomplete
+    def __init__(self, params: _Params | None = ..., auto_init: bool = ...) -> None: ...
+    def warn_if_short_id(self, argv) -> None: ...
+    def add_info_extractor(self, ie: InfoExtractor) -> None: ...
+    def get_info_extractor(self, ie_key: str) -> InfoExtractor: ...
+    def add_default_info_extractors(self) -> None: ...
+    def add_post_processor(self, pp, when: str = "post_process") -> None: ...
+    def add_post_hook(self, ph) -> None: ...
+    def add_close_hook(self, ch) -> None: ...
+    def add_progress_hook(self, ph) -> None: ...
+    def add_postprocessor_hook(self, ph) -> None: ...
+    def to_stdout(self, message, skip_eol: bool = False, quiet: Incomplete | None = None) -> None: ...
+    def to_screen(self, message, skip_eol: bool = False, quiet: Incomplete | None = None, only_once: bool = False) -> None: ...
+    def to_stderr(self, message, only_once: bool = False) -> None: ...
+    def to_console_title(
+        self, message: Incomplete | None = None, progress_state: Incomplete | None = None, percent: Incomplete | None = None
+    ) -> None: ...
+    def save_console_title(self) -> None: ...
+    def restore_console_title(self) -> None: ...
+    def __enter__(self) -> Self: ...
+    def save_cookies(self) -> None: ...
+    def __exit__(self, *args: object) -> None: ...
+    def close(self) -> None: ...
+    def trouble(self, message: Incomplete | None = None, tb: Incomplete | None = None, is_error: bool = True) -> None: ...
+    Styles: Incomplete
+    def report_warning(self, message, only_once: bool = False) -> None: ...
+    def deprecation_warning(self, message, *, stacklevel: int = 0) -> None: ...
+    def deprecated_feature(self, message) -> None: ...
+    def report_error(self, message, *args, **kwargs) -> None: ...
+    def write_debug(self, message, only_once: bool = False) -> None: ...
+    def report_file_already_downloaded(self, file_name) -> None: ...
+    def report_file_delete(self, file_name) -> None: ...
+    def raise_no_formats(self, info, forced: bool = False, *, msg: str | None = None) -> None: ...
+    def parse_outtmpl(self): ...
+    def get_output_path(self, dir_type: str = "", filename: str | None = None): ...
+    @staticmethod
+    def escape_outtmpl(outtmpl): ...
+    @classmethod
+    def validate_outtmpl(cls, outtmpl): ...
+    def prepare_outtmpl(self, outtmpl, info_dict, sanitize: bool = False): ...
+    def evaluate_outtmpl(self, outtmpl, info_dict, *args, **kwargs): ...
+    def prepare_filename(self, info_dict, dir_type: str = "", *, outtmpl: Incomplete | None = None, warn: bool = False): ...
+    @staticmethod
+    def add_extra_info(info_dict, extra_info) -> None: ...
+    def extract_info(
+        self,
+        url,
+        download: bool = True,
+        ie_key: str | None = None,
+        extra_info: object | None = None,
+        process: bool = True,
+        force_generic_extractor: bool = False,
+    ): ...
+    def add_default_extra_info(self, ie_result, ie, url) -> None: ...
+    def process_ie_result(self, ie_result, download: bool = True, extra_info: Incomplete | None = None): ...
+    tokens: Incomplete
+    counter: int
+    def build_format_selector(self, format_spec): ...
+    def sort_formats(self, info_dict) -> None: ...
+    def process_video_result(self, info_dict, download: bool = True): ...
+    def process_subtitles(self, video_id, normal_subtitles, automatic_captions): ...
+    def dl(self, name, info, subtitle: bool = False, test: bool = False): ...
+    def existing_file(self, filepaths, *, default_overwrite: bool = True): ...
+    def process_info(self, info_dict): ...
+    def download(self, url_list: Collection[str]) -> None: ...
+    def download_with_info_file(self, info_filename): ...
+    @staticmethod
+    def sanitize_info(info_dict, remove_private_keys: bool = False): ...
+    @staticmethod
+    def filter_requested_info(info_dict, actually_filter: bool = True): ...
+    @staticmethod
+    def post_extract(info_dict) -> None: ...
+    def run_pp(self, pp, infodict): ...
+    def run_all_pps(self, key, info, *, additional_pps: Incomplete | None = None): ...
+    def pre_process(self, ie_info, key: str = "pre_process", files_to_move: Incomplete | None = None): ...
+    def post_process(self, filename, info, files_to_move: Incomplete | None = None): ...
+    def in_download_archive(self, info_dict): ...
+    def record_download_archive(self, info_dict) -> None: ...
+    @staticmethod
+    def format_resolution(format, default: str = "unknown"): ...
+    def render_formats_table(self, info_dict): ...
+    def render_thumbnails_table(self, info_dict): ...
+    def render_subtitles_table(self, video_id, subtitles): ...
+    def list_formats(self, info_dict) -> None: ...
+    def list_thumbnails(self, info_dict) -> None: ...
+    def list_subtitles(self, video_id, subtitles, name: str = "subtitles") -> None: ...
+    def print_debug_header(self): ...
+    @cached_property
+    def proxies(self): ...
+    @cached_property
+    def cookiejar(self): ...
+    def urlopen(self, req): ...
+    def build_request_director(self, handlers, preferences: Incomplete | None = None): ...
+    def encode(self, s): ...
+    def get_encoding(self): ...