[ie/facebook] Fix formats extraction (#11513)
[yt-dlp3.git] / CONTRIBUTING.md
blobfd7b0f1210997542f7726886fbc3ac889f907d02
1 # CONTRIBUTING TO YT-DLP
3 - [OPENING AN ISSUE](#opening-an-issue)
4     - [Is the description of the issue itself sufficient?](#is-the-description-of-the-issue-itself-sufficient)
5     - [Are you using the latest version?](#are-you-using-the-latest-version)
6     - [Is the issue already documented?](#is-the-issue-already-documented)
7     - [Why are existing options not enough?](#why-are-existing-options-not-enough)
8     - [Have you read and understood the changes, between youtube-dl and yt-dlp](#have-you-read-and-understood-the-changes-between-youtube-dl-and-yt-dlp)
9     - [Is there enough context in your bug report?](#is-there-enough-context-in-your-bug-report)
10     - [Does the issue involve one problem, and one problem only?](#does-the-issue-involve-one-problem-and-one-problem-only)
11     - [Is anyone going to need the feature?](#is-anyone-going-to-need-the-feature)
12     - [Is your question about yt-dlp?](#is-your-question-about-yt-dlp)
13     - [Are you willing to share account details if needed?](#are-you-willing-to-share-account-details-if-needed)
14     - [Is the website primarily used for piracy](#is-the-website-primarily-used-for-piracy)
15 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
16     - [Adding new feature or making overarching changes](#adding-new-feature-or-making-overarching-changes)
17     - [Adding support for a new site](#adding-support-for-a-new-site)
18     - [yt-dlp coding conventions](#yt-dlp-coding-conventions)
19         - [Mandatory and optional metafields](#mandatory-and-optional-metafields)
20         - [Provide fallbacks](#provide-fallbacks)
21         - [Regular expressions](#regular-expressions)
22         - [Long lines policy](#long-lines-policy)
23         - [Quotes](#quotes)
24         - [Inline values](#inline-values)
25         - [Collapse fallbacks](#collapse-fallbacks)
26         - [Trailing parentheses](#trailing-parentheses)
27         - [Use convenience conversion and parsing functions](#use-convenience-conversion-and-parsing-functions)
28     - [My pull request is labeled pending-fixes](#my-pull-request-is-labeled-pending-fixes)
29 - [EMBEDDING YT-DLP](README.md#embedding-yt-dlp)
33 # OPENING AN ISSUE
35 Bugs and suggestions should be reported at: [yt-dlp/yt-dlp/issues](https://github.com/yt-dlp/yt-dlp/issues). Unless you were prompted to or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email. For discussions, join us in our [discord server](https://discord.gg/H5MNcFW63r).
37 **Please include the full output of yt-dlp when run with `-vU`**, i.e. **add** `-vU` flag to **your command line**, copy the **whole** output and post it in the issue body wrapped in \`\`\` for better formatting. It should look similar to this:
38 ```
39 $ yt-dlp -vU <your command line>
40 [debug] Command-line config: ['-vU', 'https://www.example.com/']
41 [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
42 [debug] yt-dlp version nightly@... from yt-dlp/yt-dlp-nightly-builds [1a176d874] (win_exe)
43 [debug] Python 3.10.11 (CPython AMD64 64bit) - Windows-10-10.0.20348-SP0 (OpenSSL 1.1.1t  7 Feb 2023)
44 [debug] exe versions: ffmpeg 7.0.2 (setts), ffprobe 7.0.2
45 [debug] Optional libraries: Cryptodome-3.21.0, brotli-1.1.0, certifi-2024.08.30, curl_cffi-0.5.10, mutagen-1.47.0, requests-2.32.3, sqlite3-3.40.1, urllib3-2.2.3, websockets-13.1
46 [debug] Proxy map: {}
47 [debug] Request Handlers: urllib, requests, websockets, curl_cffi
48 [debug] Loaded 1838 extractors
49 [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest
50 Latest version: nightly@... from yt-dlp/yt-dlp-nightly-builds
51 yt-dlp is up to date (nightly@... from yt-dlp/yt-dlp-nightly-builds)
52 ...
53 ```
54 **Do not post screenshots of verbose logs; only plain text is acceptable.**
56 The output (including the first lines) contains important debugging information. Issues without the full output are often not reproducible and therefore will be closed as `incomplete`.
58 The templates provided for the Issues, should be completed and **not removed**, this helps aide the resolution of the issue.
60 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
62 ### Is the description of the issue itself sufficient?
64 We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources.
66 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
68 - What the problem is
69 - How it could be fixed
70 - How your proposed solution would look like
72 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. We often get frustrated by these issues, since the only possible way for us to move forward on them is to ask for clarification over and over.
74 For bug reports, this means that your report should contain the **complete** output of yt-dlp when called with the `-vU` flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
76 If the error is `ERROR: Unable to extract ...` and you cannot reproduce it from multiple countries, add `--write-pages` and upload the `.dump` files you get [somewhere](https://gist.github.com).
78 **Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `https://www.youtube.com/watch?v=BaW_jenozKc`. There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. `https://www.youtube.com/`) is *not* an example URL.
80 ###  Are you using the latest version?
82 Before reporting any issue, type `yt-dlp -U`. This should report that you're up-to-date. This goes for feature requests as well.
84 ###  Is the issue already documented?
86 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or browse the [GitHub Issues](https://github.com/yt-dlp/yt-dlp/search?type=Issues) of this repository. If there is an issue, subscribe to it to be notified when there is any progress. Unless you have something useful to add to the conversation, please refrain from commenting.
88 Additionally, it is also helpful to see if the issue has already been documented in the [youtube-dl issue tracker](https://github.com/ytdl-org/youtube-dl/issues). If similar issues have already been reported in youtube-dl (but not in our issue tracker), links to them can be included in your issue report here.
90 ###  Why are existing options not enough?
92 Before requesting a new feature, please have a quick peek at [the list of supported options](README.md#usage-and-options). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
94 ###  Have you read and understood the changes, between youtube-dl and yt-dlp
96 There are many changes between youtube-dl and yt-dlp [(changes to default behavior)](README.md#differences-in-default-behavior), and some of the options available have a different behaviour in yt-dlp, or have been removed all together [(list of changes to options)](README.md#deprecated-options). Make sure you have read and understand the differences in the options and how this may impact your downloads before opening an issue.
98 ###  Is there enough context in your bug report?
100 People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
102 We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
104 ###  Does the issue involve one problem, and one problem only?
106 Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
108 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, White house podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of yt-dlp that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
110 ###  Is anyone going to need the feature?
112 Only post features that you (or an incapacitated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
114 ###  Is your question about yt-dlp?
116 Some bug reports are completely unrelated to yt-dlp and relate to a different, or even the reporter's own, application. Please make sure that you are actually using yt-dlp. If you are using a UI for yt-dlp, report the bug to the maintainer of the actual application providing the UI. In general, if you are unable to provide the verbose log, you should not be opening the issue here.
118 If the issue is with `youtube-dl` (the upstream fork of yt-dlp) and not with yt-dlp, the issue should be raised in the youtube-dl project.
120 ### Are you willing to share account details if needed?
122 The maintainers and potential contributors of the project often do not have an account for the website you are asking support for. So any developer interested in solving your issue may ask you for account details. It is your personal discretion whether you are willing to share the account in order for the developer to try and solve your issue. However, if you are unwilling or unable to provide details, they obviously cannot work on the issue and it cannot be solved unless some developer who both has an account and is willing/able to contribute decides to solve it.
124 By sharing an account with anyone, you agree to bear all risks associated with it. The maintainers and yt-dlp can't be held responsible for any misuse of the credentials.
126 While these steps won't necessarily ensure that no misuse of the account takes place, these are still some good practices to follow.
128 - Look for people with `Member` (maintainers of the project) or `Contributor` (people who have previously contributed code) tag on their messages.
129 - Change the password before sharing the account to something random (use [this](https://passwordsgenerator.net/) if you don't have a random password generator).
130 - Change the password after receiving the account back.
132 ### Is the website primarily used for piracy?
134 We follow [youtube-dl's policy](https://github.com/ytdl-org/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free) to not support services that is primarily used for infringing copyright. Additionally, it has been decided to not to support porn sites that specialize in fakes. We also cannot support any service that serves only [DRM protected content](https://en.wikipedia.org/wiki/Digital_rights_management).
139 # DEVELOPER INSTRUCTIONS
141 Most users do not need to build yt-dlp and can [download the builds](https://github.com/yt-dlp/yt-dlp/releases), get them via [the other installation methods](README.md#installation) or directly run it using `python -m yt_dlp`.
143 `yt-dlp` uses [`hatch`](<https://hatch.pypa.io>) as a project management tool.
144 You can easily install it using [`pipx`](<https://pipx.pypa.io>) via `pipx install hatch`, or else via `pip` or your package manager of choice. Make sure you are using at least version `1.10.0`, otherwise some functionality might not work as expected.
146 If you plan on contributing to `yt-dlp`, best practice is to start by running the following command:
148 ```shell
149 $ hatch run setup
152 The above command will install a `pre-commit` hook so that required checks/fixes (linting, formatting) will run automatically before each commit. If any code needs to be linted or formatted, then the commit will be blocked and the necessary changes will be made; you should review all edits and re-commit the fixed version.
154 After this you can use `hatch shell` to enable a virtual environment that has `yt-dlp` and its development dependencies installed.
156 In addition, the following script commands can be used to run simple tasks such as linting or testing (without having to run `hatch shell` first):
157 * `hatch fmt`: Automatically fix linter violations and apply required code formatting changes
158     * See `hatch fmt --help` for more info
159 * `hatch test`: Run extractor or core tests
160     * See `hatch test --help` for more info
162 See item 6 of [new extractor tutorial](#adding-support-for-a-new-site) for how to run extractor specific test cases.
164 While it is strongly recommended to use `hatch` for yt-dlp development, if you are unable to do so, alternatively you can manually create a virtual environment and use the following commands:
166 ```shell
167 # To only install development dependencies:
168 $ python -m devscripts.install_deps --include dev
170 # Or, for an editable install plus dev dependencies:
171 $ python -m pip install -e ".[default,dev]"
173 # To setup the pre-commit hook:
174 $ pre-commit install
176 # To be used in place of `hatch test`:
177 $ python -m devscripts.run_tests
179 # To be used in place of `hatch fmt`:
180 $ ruff check --fix .
181 $ autopep8 --in-place .
183 # To only check code instead of applying fixes:
184 $ ruff check .
185 $ autopep8 --diff .
188 If you want to create a build of yt-dlp yourself, you can follow the instructions [here](README.md#compile).
191 ## Adding new feature or making overarching changes
193 Before you start writing code for implementing a new feature, open an issue explaining your feature request and at least one use case. This allows the maintainers to decide whether such a feature is desired for the project in the first place, and will provide an avenue to discuss some implementation details. If you open a pull request for a new feature without discussing with us first, do not be surprised when we ask for large changes to the code, or even reject it outright.
195 The same applies for changes to the documentation, code style, or overarching changes to the architecture
198 ## Adding support for a new site
200 If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](#is-the-website-primarily-used-for-piracy)**. yt-dlp does **not support** such sites thus pull requests adding support for them **will be rejected**.
202 After you have ensured this site is distributing its content legally, you can follow this quick list (assuming your service is called `yourextractor`):
204 1. [Fork this repository](https://github.com/yt-dlp/yt-dlp/fork)
205 1. Check out the source code with:
207     ```shell
208     $ git clone git@github.com:YOUR_GITHUB_USERNAME/yt-dlp.git
209     ```
211 1. Start a new git branch with
213     ```shell
214     $ cd yt-dlp
215     $ git checkout -b yourextractor
216     ```
218 1. Start with this simple template and save it to `yt_dlp/extractor/yourextractor.py`:
220     ```python
221     from .common import InfoExtractor
224     class YourExtractorIE(InfoExtractor):
225         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
226         _TESTS = [{
227             'url': 'https://yourextractor.com/watch/42',
228             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
229             'info_dict': {
230                 # For videos, only the 'id' and 'ext' fields are required to RUN the test:
231                 'id': '42',
232                 'ext': 'mp4',
233                 # Then if the test run fails, it will output the missing/incorrect fields.
234                 # Properties can be added as:
235                 # * A value, e.g.
236                 #     'title': 'Video title goes here',
237                 # * MD5 checksum; start the string with 'md5:', e.g.
238                 #     'description': 'md5:098f6bcd4621d373cade4e832627b4f6',
239                 # * A regular expression; start the string with 're:', e.g.
240                 #     'thumbnail': r're:https?://.*\.jpg$',
241                 # * A count of elements in a list; start the string with 'count:', e.g.
242                 #     'tags': 'count:10',
243                 # * Any Python type, e.g.
244                 #     'view_count': int,
245             }
246         }]
248         def _real_extract(self, url):
249             video_id = self._match_id(url)
250             webpage = self._download_webpage(url, video_id)
252             # TODO more code goes here, for example ...
253             title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
255             return {
256                 'id': video_id,
257                 'title': title,
258                 'description': self._og_search_description(webpage),
259                 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
260                 # TODO more properties (see yt_dlp/extractor/common.py)
261             }
262     ```
263 1. Add an import in [`yt_dlp/extractor/_extractors.py`](yt_dlp/extractor/_extractors.py). Note that the class name must end with `IE`. Also note that when adding a parenthesized import group, the last import in the group must have a trailing comma in order for this formatting to be respected by our code formatter.
264 1. Run `hatch test YourExtractor`. This *may fail* at first, but you can continually re-run it until you're done. Upon failure, it will output the missing fields and/or correct values which you can copy. If you decide to add more than one test, the tests will then be named `YourExtractor`, `YourExtractor_1`, `YourExtractor_2`, etc. Note that tests with an `only_matching` key in the test's dict are not included in the count. You can also run all the tests in one go with `YourExtractor_all`
265 1. Make sure you have at least one test for your extractor. Even if all videos covered by the extractor are expected to be inaccessible for automated testing, tests should still be added with a `skip` parameter indicating why the particular test is disabled from running.
266 1. Have a look at [`yt_dlp/extractor/common.py`](yt_dlp/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should and may return](yt_dlp/extractor/common.py#L119-L440). Add tests and code for as many as you want.
267 1. Make sure your code follows [yt-dlp coding conventions](#yt-dlp-coding-conventions), passes [ruff](https://docs.astral.sh/ruff/tutorial/#getting-started) code checks and is properly formatted:
269     ```shell
270     $ hatch fmt --check
271     ```
273     You can use `hatch fmt` to automatically fix problems. Rules that the linter/formatter enforces should not be disabled with `# noqa` unless a maintainer requests it. The only exception allowed is for old/printf-style string formatting in GraphQL query templates (use `# noqa: UP031`).
275 1. Make sure your code works under all [Python](https://www.python.org/) versions supported by yt-dlp, namely CPython >=3.9 and PyPy >=3.10. Backward compatibility is not required for even older versions of Python.
276 1. When the tests pass, [add](https://git-scm.com/docs/git-add) the new files, [commit](https://git-scm.com/docs/git-commit) them and [push](https://git-scm.com/docs/git-push) the result, like this:
278     ```shell
279     $ git add yt_dlp/extractor/_extractors.py
280     $ git add yt_dlp/extractor/yourextractor.py
281     $ git commit -m '[yourextractor] Add extractor'
282     $ git push origin yourextractor
283     ```
285 1. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
287 In any case, thank you very much for your contributions!
289 **Tip:** To test extractors that require login information, create a file `test/local_parameters.json` and add `"usenetrc": true` or your `username`&`password` or `cookiefile`/`cookiesfrombrowser` in it:
290 ```json
292     "username": "your user name",
293     "password": "your password"
297 ## yt-dlp coding conventions
299 This section introduces a guide lines for writing idiomatic, robust and future-proof extractor code.
301 Extractors are very fragile by nature since they depend on the layout of the source data provided by 3rd party media hosters out of your control and this layout tends to change. As an extractor implementer your task is not only to write code that will extract media links and metadata correctly but also to minimize dependency on the source's layout and even to make the code foresee potential future changes and be ready for that. This is important because it will allow the extractor not to break on minor layout changes thus keeping old yt-dlp versions working. Even though this breakage issue may be easily fixed by a new version of yt-dlp, this could take some time, during which the extractor will remain broken.
304 ### Mandatory and optional metafields
306 For extraction to work yt-dlp relies on metadata your extractor extracts and provides to yt-dlp expressed by an [information dictionary](yt_dlp/extractor/common.py#L119-L440) or simply *info dict*. Only the following meta fields in the *info dict* are considered mandatory for a successful extraction process by yt-dlp:
308  - `id` (media identifier)
309  - `url` (media download URL) or `formats`
311 The aforementioned metadata fields are the critical data without which extraction does not make any sense. If any of them fail to be extracted, then the extractor is considered broken. All other metadata extraction should be completely non-fatal.
313 For pornographic sites, appropriate `age_limit` must also be returned.
315 The extractor is allowed to return the info dict without url or formats in some special cases if it allows the user to extract useful information with `--ignore-no-formats-error` - e.g. when the video is a live stream that has not started yet.
317 [Any field](yt_dlp/extractor/common.py#219-L426) apart from the aforementioned ones are considered **optional**. That means that extraction should be **tolerant** to situations when sources for these fields can potentially be unavailable (even if they are always available at the moment) and **future-proof** in order not to break the extraction of general purpose mandatory fields.
319 #### Example
321 Say you have some source dictionary `meta` that you've fetched as JSON with HTTP request and it has a key `summary`:
323 ```python
324 meta = self._download_json(url, video_id)
327 Assume at this point `meta`'s layout is:
329 ```python
331     "summary": "some fancy summary text",
332     "user": {
333         "name": "uploader name"
334     },
335     ...
339 Assume you want to extract `summary` and put it into the resulting info dict as `description`. Since `description` is an optional meta field you should be ready that this key may be missing from the `meta` dict, so that you should extract it like:
341 ```python
342 description = meta.get('summary')  # correct
345 and not like:
347 ```python
348 description = meta['summary']  # incorrect
351 The latter will break extraction process with `KeyError` if `summary` disappears from `meta` at some later time but with the former approach extraction will just go ahead with `description` set to `None` which is perfectly fine (remember `None` is equivalent to the absence of data).
354 If the data is nested, do not use `.get` chains, but instead make use of `traverse_obj`.
356 Considering the above `meta` again, assume you want to extract `["user"]["name"]` and put it in the resulting info dict as `uploader`
358 ```python
359 uploader = traverse_obj(meta, ('user', 'name'))  # correct
362 and not like:
364 ```python
365 uploader = meta['user']['name']  # incorrect
368 ```python
369 uploader = meta.get('user', {}).get('name')  # incorrect
372 ```python
373 uploader = try_get(meta, lambda x: x['user']['name'])  # old utility
377 Similarly, you should pass `fatal=False` when extracting optional data from a webpage with `_search_regex`, `_html_search_regex` or similar methods, for instance:
379 ```python
380 description = self._search_regex(
381     r'<span[^>]+id="title"[^>]*>([^<]+)<',
382     webpage, 'description', fatal=False)
385 With `fatal` set to `False` if `_search_regex` fails to extract `description` it will emit a warning and continue extraction.
387 You can also pass `default=<some fallback value>`, for example:
389 ```python
390 description = self._search_regex(
391     r'<span[^>]+id="title"[^>]*>([^<]+)<',
392     webpage, 'description', default=None)
395 On failure this code will silently continue the extraction with `description` set to `None`. That is useful for metafields that may or may not be present.
398 Another thing to remember is not to try to iterate over `None`
400 Say you extracted a list of thumbnails into `thumbnail_data` and want to iterate over them
402 ```python
403 thumbnail_data = data.get('thumbnails') or []
404 thumbnails = [{
405     'url': item['url'],
406     'height': item.get('h'),
407 } for item in thumbnail_data if item.get('url')]  # correct
410 and not like:
412 ```python
413 thumbnail_data = data.get('thumbnails')
414 thumbnails = [{
415     'url': item['url'],
416     'height': item.get('h'),
417 } for item in thumbnail_data]  # incorrect
420 In this case, `thumbnail_data` will be `None` if the field was not found and this will cause the loop `for item in thumbnail_data` to raise a fatal error. Using `or []` avoids this error and results in setting an empty list in `thumbnails` instead.
422 Alternately, this can be further simplified by using `traverse_obj`
424 ```python
425 thumbnails = [{
426     'url': item['url'],
427     'height': item.get('h'),
428 } for item in traverse_obj(data, ('thumbnails', lambda _, v: v['url']))]
431 or, even better,
433 ```python
434 thumbnails = traverse_obj(data, ('thumbnails', ..., {'url': 'url', 'height': 'h'}))
437 ### Provide fallbacks
439 When extracting metadata try to do so from multiple sources. For example if `title` is present in several places, try extracting from at least some of them. This makes it more future-proof in case some of the sources become unavailable.
442 #### Example
444 Say `meta` from the previous example has a `title` and you are about to extract it like:
446 ```python
447 title = meta.get('title')
450 If `title` disappears from `meta` in future due to some changes on the hoster's side the title extraction would fail.
452 Assume that you have some another source you can extract `title` from, for example `og:title` HTML meta of a `webpage`. In this case you can provide a fallback like:
454 ```python
455 title = meta.get('title') or self._og_search_title(webpage)
458 This code will try to extract from `meta` first and if it fails it will try extracting `og:title` from a `webpage`, making the extractor more robust.
461 ### Regular expressions
463 #### Don't capture groups you don't use
465 Capturing group must be an indication that it's used somewhere in the code. Any group that is not used must be non capturing.
467 ##### Example
469 Don't capture id attribute name here since you can't use it for anything anyway.
471 Correct:
473 ```python
474 r'(?:id|ID)=(?P<id>\d+)'
477 Incorrect:
478 ```python
479 r'(id|ID)=(?P<id>\d+)'
482 #### Make regular expressions relaxed and flexible
484 When using regular expressions try to write them fuzzy, relaxed and flexible, skipping insignificant parts that are more likely to change, allowing both single and double quotes for quoted values and so on.
486 ##### Example
488 Say you need to extract `title` from the following HTML code:
490 ```html
491 <span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
494 The code for that task should look similar to:
496 ```python
497 title = self._search_regex(  # correct
498     r'<span[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
501 which tolerates potential changes in the `style` attribute's value. Or even better:
503 ```python
504 title = self._search_regex(  # correct
505     r'<span[^>]+class=(["\'])title\1[^>]*>(?P<title>[^<]+)',
506     webpage, 'title', group='title')
509 which also handles both single quotes in addition to double quotes.
511 The code definitely should not look like:
513 ```python
514 title = self._search_regex(  # incorrect
515     r'<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">(.*?)</span>',
516     webpage, 'title', group='title')
519 or even
521 ```python
522 title = self._search_regex(  # incorrect
523     r'<span style=".*?" class="title">(.*?)</span>',
524     webpage, 'title', group='title')
527 Here the presence or absence of other attributes including `style` is irrelevant for the data we need, and so the regex must not depend on it
530 #### Keep the regular expressions as simple as possible, but no simpler
532 Since many extractors deal with unstructured data provided by websites, we will often need to use very complex regular expressions. You should try to use the *simplest* regex that can accomplish what you want. In other words, each part of the regex must have a reason for existing. If you can take out a symbol and the functionality does not change, the symbol should not be there.
534 ##### Example
536 Correct:
538 ```python
539 _VALID_URL = r'https?://(?:www\.)?website\.com/(?:[^/]+/){3,4}(?P<display_id>[^/]+)_(?P<id>\d+)'
542 Incorrect:
544 ```python
545 _VALID_URL = r'https?:\/\/(?:www\.)?website\.com\/[^\/]+/[^\/]+/[^\/]+(?:\/[^\/]+)?\/(?P<display_id>[^\/]+)_(?P<id>\d+)'
548 #### Do not misuse `.` and use the correct quantifiers (`+*?`)
550 Avoid creating regexes that over-match because of wrong use of quantifiers. Also try to avoid non-greedy matching (`?`) where possible since they could easily result in [catastrophic backtracking](https://www.regular-expressions.info/catastrophic.html)
552 Correct:
554 ```python
555 title = self._search_regex(r'<span\b[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
558 Incorrect:
560 ```python
561 title = self._search_regex(r'<span\b.*class="title".*>(.+?)<', webpage, 'title')
565 ### Long lines policy
567 There is a soft limit to keep lines of code under 100 characters long. This means it should be respected if possible and if it does not make readability and code maintenance worse. Sometimes, it may be reasonable to go upto 120 characters and sometimes even 80 can be unreadable. Keep in mind that this is not a hard limit and is just one of many tools to make the code more readable.
569 For example, you should **never** split long string literals like URLs or some other often copied entities over multiple lines to fit this limit:
571 Conversely, don't unnecessarily split small lines further. As a rule of thumb, if removing the line split keeps the code under 80 characters, it should be a single line.
573 ##### Examples
575 Correct:
577 ```python
578 'https://www.youtube.com/watch?v=FqZTN594JQw&list=PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
581 Incorrect:
583 ```python
584 'https://www.youtube.com/watch?v=FqZTN594JQw&list='
585 'PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
588 Correct:
590 ```python
591 uploader = traverse_obj(info, ('uploader', 'name'), ('author', 'fullname'))
594 Incorrect:
596 ```python
597 uploader = traverse_obj(
598     info,
599     ('uploader', 'name'),
600     ('author', 'fullname'))
603 Correct:
605 ```python
606 formats = self._extract_m3u8_formats(
607     m3u8_url, video_id, 'mp4', 'm3u8_native', m3u8_id='hls',
608     note='Downloading HD m3u8 information', errnote='Unable to download HD m3u8 information')
611 Incorrect:
613 ```python
614 formats = self._extract_m3u8_formats(m3u8_url,
615                                      video_id,
616                                      'mp4',
617                                      'm3u8_native',
618                                      m3u8_id='hls',
619                                      note='Downloading HD m3u8 information',
620                                      errnote='Unable to download HD m3u8 information')
624 ### Quotes
626 Always use single quotes for strings (even if the string has `'`) and double quotes for docstrings. Use `'''` only for multi-line strings. An exception can be made if a string has multiple single quotes in it and escaping makes it *significantly* harder to read. For f-strings, use you can use double quotes on the inside. But avoid f-strings that have too many quotes inside.
629 ### Inline values
631 Extracting variables is acceptable for reducing code duplication and improving readability of complex expressions. However, you should avoid extracting variables used only once and moving them to opposite parts of the extractor file, which makes reading the linear flow difficult.
633 #### Examples
635 Correct:
637 ```python
638 return {
639     'title': self._html_search_regex(r'<h1>([^<]+)</h1>', webpage, 'title'),
640     # ...some lines of code...
644 Incorrect:
646 ```python
647 TITLE_RE = r'<h1>([^<]+)</h1>'
648 # ...some lines of code...
649 title = self._html_search_regex(TITLE_RE, webpage, 'title')
650 # ...some lines of code...
651 return {
652     'title': title,
653     # ...some lines of code...
658 ### Collapse fallbacks
660 Multiple fallback values can quickly become unwieldy. Collapse multiple fallback values into a single expression via a list of patterns.
662 #### Example
664 Good:
666 ```python
667 description = self._html_search_meta(
668     ['og:description', 'description', 'twitter:description'],
669     webpage, 'description', default=None)
672 Unwieldy:
674 ```python
675 description = (
676     self._og_search_description(webpage, default=None)
677     or self._html_search_meta('description', webpage, default=None)
678     or self._html_search_meta('twitter:description', webpage, default=None))
681 Methods supporting list of patterns are: `_search_regex`, `_html_search_regex`, `_og_search_property`, `_html_search_meta`.
684 ### Trailing parentheses
686 Always move trailing parentheses used for grouping/functions after the last argument. On the other hand, multi-line literal list/tuple/dict/set should closed be in a new line. Generators and list/dict comprehensions may use either style
688 #### Examples
690 Correct:
692 ```python
693 url = traverse_obj(info, (
694     'context', 'dispatcher', 'stores', 'VideoTitlePageStore', 'data', 'video', 0, 'VideoUrlSet', 'VideoUrl'), list)
696 Correct:
698 ```python
699 url = traverse_obj(
700     info,
701     ('context', 'dispatcher', 'stores', 'VideoTitlePageStore', 'data', 'video', 0, 'VideoUrlSet', 'VideoUrl'),
702     list)
705 Incorrect:
707 ```python
708 url = traverse_obj(
709     info,
710     ('context', 'dispatcher', 'stores', 'VideoTitlePageStore', 'data', 'video', 0, 'VideoUrlSet', 'VideoUrl'),
711     list
715 Correct:
717 ```python
718 f = {
719     'url': url,
720     'format_id': format_id,
724 Incorrect:
726 ```python
727 f = {'url': url,
728      'format_id': format_id}
731 Correct:
733 ```python
734 formats = [process_formats(f) for f in format_data
735            if f.get('type') in ('hls', 'dash', 'direct') and f.get('downloadable')]
738 Correct:
740 ```python
741 formats = [
742     process_formats(f) for f in format_data
743     if f.get('type') in ('hls', 'dash', 'direct') and f.get('downloadable')
748 ### Use convenience conversion and parsing functions
750 Wrap all extracted numeric data into safe functions from [`yt_dlp/utils/`](yt_dlp/utils/): `int_or_none`, `float_or_none`. Use them for string to number conversions as well.
752 Use `url_or_none` for safe URL processing.
754 Use `traverse_obj` and `try_call` (superseeds `dict_get` and `try_get`) for safe metadata extraction from parsed JSON.
756 Use `unified_strdate` for uniform `upload_date` or any `YYYYMMDD` meta field extraction, `unified_timestamp` for uniform `timestamp` extraction, `parse_filesize` for `filesize` extraction, `parse_count` for count meta fields extraction, `parse_resolution`, `parse_duration` for `duration` extraction, `parse_age_limit` for `age_limit` extraction.
758 Explore [`yt_dlp/utils/`](yt_dlp/utils/) for more useful convenience functions.
760 #### Examples
762 ```python
763 description = traverse_obj(response, ('result', 'video', 'summary'), expected_type=str)
764 thumbnails = traverse_obj(response, ('result', 'thumbnails', ..., 'url'), expected_type=url_or_none)
765 video = traverse_obj(response, ('result', 'video', 0), default={}, expected_type=dict)
766 duration = float_or_none(video.get('durationMs'), scale=1000)
767 view_count = int_or_none(video.get('views'))
771 # My pull request is labeled pending-fixes
773 The `pending-fixes` label is added when there are changes requested to a PR. When the necessary changes are made, the label should be removed. However, despite our best efforts, it may sometimes happen that the maintainer did not see the changes or forgot to remove the label. If your PR is still marked as `pending-fixes` a few days after all requested changes have been made, feel free to ping the maintainer who labeled your issue and ask them to re-review and remove the label.
778 # EMBEDDING YT-DLP
779 See [README.md#embedding-yt-dlp](README.md#embedding-yt-dlp) for instructions on how to embed yt-dlp in another Python program