Add yt-dlp stubs #14216
Open
Add yt-dlp stubs #14216
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
|
Diff from mypy_primer, showing the effect of this PR on open source code: core (https://github.com/home-assistant/core)
+ homeassistant/components/media_extractor/__init__.py:63: error: Incompatible types (expression has type "Logger", TypedDict item "logger" has type "_LoggerProtocol") [typeddict-item]
+ homeassistant/components/media_extractor/__init__.py:63: note: "Logger" is missing following "_LoggerProtocol" protocol members:
+ homeassistant/components/media_extractor/__init__.py:63: note: stderr, stdout
+ homeassistant/components/media_extractor/__init__.py:63: note: Following member(s) of "Logger" have conflicts:
+ homeassistant/components/media_extractor/__init__.py:63: note: Expected:
+ homeassistant/components/media_extractor/__init__.py:63: note: def warning(self, message: str, *, once: bool = ..., only_once: bool = ...) -> None
+ homeassistant/components/media_extractor/__init__.py:63: note: Got:
+ homeassistant/components/media_extractor/__init__.py:63: note: def warning(self, msg: object, *args: object, exc_info: bool | tuple[type[BaseException], BaseException, TracebackType | None] | tuple[None, None, None] | BaseException | None = ..., stack_info: bool = ..., stacklevel: int = ..., extra: Mapping[str, object] | None = ...) -> None
+ homeassistant/components/media_extractor/__init__.py:69: error: Unexpected keyword argument "download" for "extract_info" of "YoutubeDL" [call-arg]
+ homeassistant/components/media_extractor/__init__.py:69: error: Unexpected keyword argument "process" for "extract_info" of "YoutubeDL" [call-arg]
+ homeassistant/components/media_extractor/__init__.py:186: error: Argument 1 to "YoutubeDL" has incompatible type "dict[str, object]"; expected "YDLOpts | None" [arg-type]
+ homeassistant/components/media_extractor/__init__.py:189: error: Unexpected keyword argument "process" for "extract_info" of "YoutubeDL" [call-arg]
+ homeassistant/components/media_extractor/__init__.py:196: error: No overload variant of "list" matches argument type "object" [call-overload]
+ homeassistant/components/media_extractor/__init__.py:196: note: Possible overload variants:
+ homeassistant/components/media_extractor/__init__.py:196: note: def [_T] __init__(self) -> list[_T]
+ homeassistant/components/media_extractor/__init__.py:196: note: def [_T] __init__(self, Iterable[_T], /) -> list[_T]
+ homeassistant/components/media_extractor/__init__.py:208: error: "YoutubeDL" has no attribute "params" [attr-defined]
+ homeassistant/components/media_extractor/__init__.py:209: error: "YoutubeDL" has no attribute "process_ie_result" [attr-defined]
|
|
Cheers for cc-ing me, appreciate it. It would indeed be nice to have the stubs maintained in typeshed and hence more easily discoverable for devs calling |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Porting over from https://github.com/Tatsh/yt-dlp-types.
Upstream is unlikely to have full types any time soon. Though it may seem like an insular project, there is utility in using yt-dlp outside as I do in some of my projects. Examples:
YoutubeDL.add_info_extractor()).It is normal to extend
yt_dlp.extractor.common.InfoExtractorand override its private methods so common ones are included, especially_real_extract()which is most important to override.These types are not complete but what is complete is what is included has been useful for me and others.
Once accepted I will deprecate and archive yt-dlp-types on Github and on PyPI.
cc @Sky-NiniKo @thcrt
Usages: