7 from .compat
import compat_expanduser
, compat_get_terminal_size
, compat_getenv
8 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
9 from .downloader
.external
import list_external_downloaders
10 from .postprocessor
import (
12 FFmpegSubtitlesConvertorPP
,
13 FFmpegThumbnailsConvertorPP
,
17 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
28 from .version
import __version__
31 def parseOpts(overrideArguments
=None, ignore_config_files
='if_override'):
32 parser
= create_parser()
35 if ignore_config_files
== 'if_override':
36 ignore_config_files
= overrideArguments
is not None
38 root
.append_config(overrideArguments
, label
='Override')
40 root
.append_config(sys
.argv
[1:], label
='Command-line')
42 def _readUserConf(package_name
, default
=[]):
44 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
45 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
46 if not os
.path
.isfile(userConfFile
):
47 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
48 userConf
= Config
.read_file(userConfFile
, default
=None)
49 if userConf
is not None:
50 return userConf
, userConfFile
53 appdata_dir
= compat_getenv('appdata')
55 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
56 userConf
= Config
.read_file(userConfFile
, default
=None)
58 userConfFile
+= '.txt'
59 userConf
= Config
.read_file(userConfFile
, default
=None)
60 if userConf
is not None:
61 return userConf
, userConfFile
64 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
65 userConf
= Config
.read_file(userConfFile
, default
=None)
67 userConfFile
+= '.txt'
68 userConf
= Config
.read_file(userConfFile
, default
=None)
69 if userConf
is not None:
70 return userConf
, userConfFile
74 def add_config(label
, path
, user
=False):
75 """ Adds config and returns whether to continue """
76 if root
.parse_args()[0].ignoreconfig
:
78 # Multiple package names can be given here
79 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
80 # the configuration file of any of these three packages
81 for package
in ('yt-dlp',):
83 args
, current_path
= _readUserConf(package
, default
=None)
85 current_path
= os
.path
.join(path
, '%s.conf' % package
)
86 args
= Config
.read_file(current_path
, default
=None)
88 root
.append_config(args
, current_path
, label
=label
)
93 yield not ignore_config_files
94 yield add_config('Portable', get_executable_path())
95 yield add_config('Home', expand_path(root
.parse_args()[0].paths
.get('home', '')).strip())
96 yield add_config('User', None, user
=True)
97 yield add_config('System', '/etc')
99 if all(load_configs()):
100 # If ignoreconfig is found inside the system configuration file,
101 # the user configuration is removed
102 if root
.parse_args()[0].ignoreconfig
:
103 user_conf
= next((i
for i
, conf
in enumerate(root
.configs
) if conf
.label
== 'User'), None)
104 if user_conf
is not None:
105 root
.configs
.pop(user_conf
)
107 opts
, args
= root
.parse_args()
109 write_string(f
'\n{root}'.replace('\n| ', '\n[debug] ')[1:] + '\n')
110 return parser
, opts
, args
113 class _YoutubeDLHelpFormatter(optparse
.IndentedHelpFormatter
):
115 # No need to wrap help messages if we're on a wide console
116 max_width
= compat_get_terminal_size().columns
or 80
117 # 47% is chosen because that is how README.md is currently formatted
118 # and moving help text even further to the right is undesirable.
119 # This can be reduced in the future to get a prettier output
120 super().__init
__(width
=max_width
, max_help_position
=int(0.47 * max_width
))
123 def format_option_strings(option
):
124 """ ('-o', '--option') -> -o, --format METAVAR """
125 opts
= join_nonempty(
126 option
._short
_opts
and option
._short
_opts
[0],
127 option
._long
_opts
and option
._long
_opts
[0],
129 if option
.takes_value():
130 opts
+= f
' {option.metavar}'
134 class _YoutubeDLOptionParser(optparse
.OptionParser
):
135 # optparse is deprecated since python 3.2. So assume a stable interface even for private methods
141 usage
='%prog [OPTIONS] URL [URL...]',
142 epilog
='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
143 formatter
=_YoutubeDLHelpFormatter(),
144 conflict_handler
='resolve',
147 def _get_args(self
, args
):
148 return sys
.argv
[1:] if args
is None else list(args
)
150 def _match_long_opt(self
, opt
):
151 """Improve ambigious argument resolution by comparing option objects instead of argument strings"""
153 return super()._match
_long
_opt
(opt
)
154 except optparse
.AmbiguousOptionError
as e
:
155 if len({self._long_opt[p] for p in e.possibilities}
) == 1:
156 return e
.possibilities
[0]
161 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
162 # append can be True, False or -1 (prepend)
163 current
= list(getattr(parser
.values
, option
.dest
)) if append
else []
164 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
166 parser
.values
, option
.dest
,
167 current
+ value
if append
is True else value
+ current
)
169 def _set_from_options_callback(
170 option
, opt_str
, value
, parser
, delim
=',', allowed_values
=None, aliases
={},
171 process
=lambda x
: x
.lower().strip()):
172 current
= set(getattr(parser
.values
, option
.dest
))
173 values
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)[::-1]))
175 actual_val
= val
= values
.pop()
177 raise optparse
.OptionValueError(f
'Invalid {option.metavar} for {opt_str}: {value}')
179 current
.update(allowed_values
)
183 values
.extend(aliases
[val
])
189 current
.update([val
])
190 if allowed_values
is not None and val
not in allowed_values
:
191 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
193 setattr(parser
.values
, option
.dest
, current
)
195 def _dict_from_options_callback(
196 option
, opt_str
, value
, parser
,
197 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
198 process_key
=str.lower
, append
=False):
200 out_dict
= dict(getattr(parser
.values
, option
.dest
))
201 multiple_args
= not isinstance(value
, str)
203 allowed_keys
= fr
'({allowed_keys})(,({allowed_keys}))*'
205 fr
'(?i)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
206 value
[0] if multiple_args
else value
)
208 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
210 val
= [val
, *value
[1:]]
211 elif default_key
is not None:
212 keys
, val
= [default_key
], value
214 raise optparse
.OptionValueError(
215 f
'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
217 keys
= map(process_key
, keys
) if process_key
else keys
218 val
= process(val
) if process
else val
219 except Exception as err
:
220 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
222 out_dict
[key
] = out_dict
.get(key
, []) + [val
] if append
else val
223 setattr(parser
.values
, option
.dest
, out_dict
)
225 parser
= _YoutubeDLOptionParser()
227 general
= optparse
.OptionGroup(parser
, 'General Options')
231 help='Print this help text and exit')
235 help='Print program version and exit')
238 action
='store_true', dest
='update_self',
239 help='Update this program to latest version')
241 '-i', '--ignore-errors',
242 action
='store_true', dest
='ignoreerrors',
243 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
245 '--no-abort-on-error',
246 action
='store_const', dest
='ignoreerrors', const
='only_download',
247 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
249 '--abort-on-error', '--no-ignore-errors',
250 action
='store_false', dest
='ignoreerrors',
251 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
254 action
='store_true', dest
='dump_user_agent', default
=False,
255 help='Display the current user-agent and exit')
258 action
='store_true', dest
='list_extractors', default
=False,
259 help='List all supported extractors and exit')
261 '--extractor-descriptions',
262 action
='store_true', dest
='list_extractor_descriptions', default
=False,
263 help='Output descriptions of all supported extractors and exit')
265 '--force-generic-extractor',
266 action
='store_true', dest
='force_generic_extractor', default
=False,
267 help='Force extraction to use the generic extractor')
270 dest
='default_search', metavar
='PREFIX',
271 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for the search term "large apple". Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching')
273 '--ignore-config', '--no-config',
274 action
='store_true', dest
='ignoreconfig',
276 'Don\'t load any more configuration files except those given by --config-locations. '
277 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
278 '(Alias: --no-config)'))
280 '--no-config-locations',
281 action
='store_const', dest
='config_locations', const
=[],
283 'Do not load any custom configuration files (default). When given inside a '
284 'configuration file, ignore all previous --config-locations defined in the current file'))
286 '--config-locations',
287 dest
='config_locations', metavar
='PATH', action
='append',
289 'Location of the main configuration file; either the path to the config or its containing directory. '
290 'Can be used multiple times and inside other configuration files'))
293 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
294 help='Do not extract the videos of a playlist, only list them')
296 '--no-flat-playlist',
297 action
='store_false', dest
='extract_flat',
298 help='Extract the videos of a playlist')
301 action
='store_true', dest
='live_from_start',
302 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
304 '--no-live-from-start',
305 action
='store_false', dest
='live_from_start',
306 help='Download livestreams from the current time (default)')
309 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
311 'Wait for scheduled streams to become available. '
312 'Pass the minimum number of seconds (or range) to wait between retries'))
314 '--no-wait-for-video',
315 dest
='wait_for_video', action
='store_const', const
=None,
316 help='Do not wait for scheduled streams (default)')
319 action
='store_true', dest
='mark_watched', default
=False,
320 help='Mark videos watched (even with --simulate)')
323 action
='store_false', dest
='mark_watched',
324 help='Do not mark videos watched (default)')
327 action
='store_true', dest
='no_color', default
=False,
328 help='Do not emit color codes in output')
331 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
332 action
='callback', callback
=_set_from_options_callback
,
335 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
336 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
337 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', 'embed-metadata',
338 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
340 'youtube-dl': ['-multistreams', 'all'],
341 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
344 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
345 'configurations by reverting some of the changes made in yt-dlp. '
346 'See "Differences in default behavior" for details'))
348 network
= optparse
.OptionGroup(parser
, 'Network Options')
350 '--proxy', dest
='proxy',
351 default
=None, metavar
='URL',
353 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
354 'SOCKS proxy, specify a proper scheme. For example '
355 'socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") '
356 'for direct connection'))
359 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
360 help='Time to wait before giving up, in seconds')
363 metavar
='IP', dest
='source_address', default
=None,
364 help='Client-side IP address to bind to',
367 '-4', '--force-ipv4',
368 action
='store_const', const
='0.0.0.0', dest
='source_address',
369 help='Make all connections via IPv4',
372 '-6', '--force-ipv6',
373 action
='store_const', const
='::', dest
='source_address',
374 help='Make all connections via IPv6',
377 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
379 '--geo-verification-proxy',
380 dest
='geo_verification_proxy', default
=None, metavar
='URL',
382 'Use this proxy to verify the IP address for some geo-restricted sites. '
383 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
385 '--cn-verification-proxy',
386 dest
='cn_verification_proxy', default
=None, metavar
='URL',
387 help=optparse
.SUPPRESS_HELP
)
390 action
='store_true', dest
='geo_bypass', default
=True,
391 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header (default)')
394 action
='store_false', dest
='geo_bypass',
395 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
397 '--geo-bypass-country', metavar
='CODE',
398 dest
='geo_bypass_country', default
=None,
399 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
401 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
402 dest
='geo_bypass_ip_block', default
=None,
403 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
405 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
406 selection
.add_option(
408 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
409 help='Playlist video to start at (default is %default)')
410 selection
.add_option(
412 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
413 help='Playlist video to end at (default is last)')
414 selection
.add_option(
416 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
417 help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13')
418 selection
.add_option(
420 dest
='matchtitle', metavar
='REGEX',
421 help=optparse
.SUPPRESS_HELP
)
422 selection
.add_option(
424 dest
='rejecttitle', metavar
='REGEX',
425 help=optparse
.SUPPRESS_HELP
)
426 selection
.add_option(
428 metavar
='SIZE', dest
='min_filesize', default
=None,
429 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
430 selection
.add_option(
432 metavar
='SIZE', dest
='max_filesize', default
=None,
433 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
434 selection
.add_option(
436 metavar
='DATE', dest
='date', default
=None,
438 'Download only videos uploaded on this date. '
439 'The date can be "YYYYMMDD" or in the format '
440 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
441 selection
.add_option(
443 metavar
='DATE', dest
='datebefore', default
=None,
445 'Download only videos uploaded on or before this date. '
446 'The date formats accepted is the same as --date'))
447 selection
.add_option(
449 metavar
='DATE', dest
='dateafter', default
=None,
451 'Download only videos uploaded on or after this date. '
452 'The date formats accepted is the same as --date'))
453 selection
.add_option(
455 metavar
='COUNT', dest
='min_views', default
=None, type=int,
456 help=optparse
.SUPPRESS_HELP
)
457 selection
.add_option(
459 metavar
='COUNT', dest
='max_views', default
=None, type=int,
460 help=optparse
.SUPPRESS_HELP
)
461 selection
.add_option(
463 metavar
='FILTER', dest
='match_filter', action
='append',
465 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
466 'number or a string using the operators defined in "Filtering formats". '
467 'You can also simply specify a field to match if the field is present, '
468 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
469 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
470 'the filter matches if atleast one of the conditions are met. Eg: --match-filter '
471 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
472 'matches only videos that are not live OR those that have a like count more than 100 '
473 '(or the like field is not available) and also has a description '
474 'that contains the phrase "cats & dogs" (ignoring case). '
475 'Use "--match-filter -" to interactively ask whether to download each video'))
476 selection
.add_option(
478 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
479 help='Do not use generic video filter (default)')
480 selection
.add_option(
482 action
='store_true', dest
='noplaylist', default
=False,
483 help='Download only the video, if the URL refers to a video and a playlist')
484 selection
.add_option(
486 action
='store_false', dest
='noplaylist',
487 help='Download the playlist, if the URL refers to a video and a playlist')
488 selection
.add_option(
490 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
491 help='Download only videos suitable for the given age')
492 selection
.add_option(
493 '--download-archive', metavar
='FILE',
494 dest
='download_archive',
495 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
496 selection
.add_option(
497 '--no-download-archive',
498 dest
='download_archive', action
="store_const", const
=None,
499 help='Do not use archive file (default)')
500 selection
.add_option(
502 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
503 help='Abort after downloading NUMBER files')
504 selection
.add_option(
505 '--break-on-existing',
506 action
='store_true', dest
='break_on_existing', default
=False,
507 help='Stop the download process when encountering a file that is in the archive')
508 selection
.add_option(
510 action
='store_true', dest
='break_on_reject', default
=False,
511 help='Stop the download process when encountering a file that has been filtered out')
512 selection
.add_option(
514 action
='store_true', dest
='break_per_url', default
=False,
515 help='Make --break-on-existing and --break-on-reject act only on the current input URL')
516 selection
.add_option(
517 '--no-break-per-input',
518 action
='store_false', dest
='break_per_url',
519 help='--break-on-existing and --break-on-reject terminates the entire download queue')
520 selection
.add_option(
521 '--skip-playlist-after-errors', metavar
='N',
522 dest
='skip_playlist_after_errors', default
=None, type=int,
523 help='Number of allowed failures until the rest of the playlist is skipped')
524 selection
.add_option(
526 dest
='include_ads', action
='store_true',
527 help=optparse
.SUPPRESS_HELP
)
528 selection
.add_option(
530 dest
='include_ads', action
='store_false',
531 help=optparse
.SUPPRESS_HELP
)
533 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
534 authentication
.add_option(
536 dest
='username', metavar
='USERNAME',
537 help='Login with this account ID')
538 authentication
.add_option(
540 dest
='password', metavar
='PASSWORD',
541 help='Account password. If this option is left out, yt-dlp will ask interactively')
542 authentication
.add_option(
544 dest
='twofactor', metavar
='TWOFACTOR',
545 help='Two-factor authentication code')
546 authentication
.add_option(
548 action
='store_true', dest
='usenetrc', default
=False,
549 help='Use .netrc authentication data')
550 authentication
.add_option(
552 dest
='netrc_location', metavar
='PATH',
553 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
554 authentication
.add_option(
556 dest
='videopassword', metavar
='PASSWORD',
557 help='Video password (vimeo, youku)')
558 authentication
.add_option(
560 dest
='ap_mso', metavar
='MSO',
561 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
562 authentication
.add_option(
564 dest
='ap_username', metavar
='USERNAME',
565 help='Multiple-system operator account login')
566 authentication
.add_option(
568 dest
='ap_password', metavar
='PASSWORD',
569 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
570 authentication
.add_option(
572 action
='store_true', dest
='ap_list_mso', default
=False,
573 help='List all supported multiple-system operators')
574 authentication
.add_option(
575 '--client-certificate',
576 dest
='client_certificate', metavar
='CERTFILE',
577 help='Path to client certificate file in PEM format. May include the private key')
578 authentication
.add_option(
579 '--client-certificate-key',
580 dest
='client_certificate_key', metavar
='KEYFILE',
581 help='Path to private key file for client certificate')
582 authentication
.add_option(
583 '--client-certificate-password',
584 dest
='client_certificate_password', metavar
='PASSWORD',
585 help='Password for client certificate private key, if encrypted. '
586 'If not provided and the key is encrypted, yt-dlp will ask interactively')
588 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
589 video_format
.add_option(
591 action
='store', dest
='format', metavar
='FORMAT', default
=None,
592 help='Video format code, see "FORMAT SELECTION" for more details')
593 video_format
.add_option(
594 '-S', '--format-sort', metavar
='SORTORDER',
595 dest
='format_sort', default
=[], type='str', action
='callback',
596 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
597 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
598 video_format
.add_option(
599 '--format-sort-force', '--S-force',
600 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
602 'Force user specified sort order to have precedence over all fields, '
603 'see "Sorting Formats" for more details'))
604 video_format
.add_option(
605 '--no-format-sort-force',
606 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
608 'Some fields have precedence over the user specified sort order (default), '
609 'see "Sorting Formats" for more details'))
610 video_format
.add_option(
611 '--video-multistreams',
612 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
613 help='Allow multiple video streams to be merged into a single file')
614 video_format
.add_option(
615 '--no-video-multistreams',
616 action
='store_false', dest
='allow_multiple_video_streams',
617 help='Only one video stream is downloaded for each output file (default)')
618 video_format
.add_option(
619 '--audio-multistreams',
620 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
621 help='Allow multiple audio streams to be merged into a single file')
622 video_format
.add_option(
623 '--no-audio-multistreams',
624 action
='store_false', dest
='allow_multiple_audio_streams',
625 help='Only one audio stream is downloaded for each output file (default)')
626 video_format
.add_option(
628 action
='store_const', dest
='format', const
='all',
629 help=optparse
.SUPPRESS_HELP
)
630 video_format
.add_option(
631 '--prefer-free-formats',
632 action
='store_true', dest
='prefer_free_formats', default
=False,
634 'Prefer video formats with free containers over non-free ones of same quality. '
635 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
636 video_format
.add_option(
637 '--no-prefer-free-formats',
638 action
='store_false', dest
='prefer_free_formats', default
=False,
639 help="Don't give any special preference to free containers (default)")
640 video_format
.add_option(
642 action
='store_const', const
='selected', dest
='check_formats', default
=None,
643 help='Make sure formats are selected only from those that are actually downloadable')
644 video_format
.add_option(
645 '--check-all-formats',
646 action
='store_true', dest
='check_formats',
647 help='Check all formats for whether they are actually downloadable')
648 video_format
.add_option(
649 '--no-check-formats',
650 action
='store_false', dest
='check_formats',
651 help='Do not check that the formats are actually downloadable')
652 video_format
.add_option(
653 '-F', '--list-formats',
654 action
='store_true', dest
='listformats',
655 help='List available formats of each video. Simulate unless --no-simulate is used')
656 video_format
.add_option(
657 '--list-formats-as-table',
658 action
='store_true', dest
='listformats_table', default
=True,
659 help=optparse
.SUPPRESS_HELP
)
660 video_format
.add_option(
661 '--list-formats-old', '--no-list-formats-as-table',
662 action
='store_false', dest
='listformats_table',
663 help=optparse
.SUPPRESS_HELP
)
664 video_format
.add_option(
665 '--merge-output-format',
666 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
668 'If a merge is required (e.g. bestvideo+bestaudio), '
669 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
670 'Ignored if no merge is required'))
671 video_format
.add_option(
672 '--allow-unplayable-formats',
673 action
='store_true', dest
='allow_unplayable_formats', default
=False,
674 help=optparse
.SUPPRESS_HELP
)
675 video_format
.add_option(
676 '--no-allow-unplayable-formats',
677 action
='store_false', dest
='allow_unplayable_formats',
678 help=optparse
.SUPPRESS_HELP
)
680 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
681 subtitles
.add_option(
682 '--write-subs', '--write-srt',
683 action
='store_true', dest
='writesubtitles', default
=False,
684 help='Write subtitle file')
685 subtitles
.add_option(
686 '--no-write-subs', '--no-write-srt',
687 action
='store_false', dest
='writesubtitles',
688 help='Do not write subtitle file (default)')
689 subtitles
.add_option(
690 '--write-auto-subs', '--write-automatic-subs',
691 action
='store_true', dest
='writeautomaticsub', default
=False,
692 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
693 subtitles
.add_option(
694 '--no-write-auto-subs', '--no-write-automatic-subs',
695 action
='store_false', dest
='writeautomaticsub', default
=False,
696 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
697 subtitles
.add_option(
699 action
='store_true', dest
='allsubtitles', default
=False,
700 help=optparse
.SUPPRESS_HELP
)
701 subtitles
.add_option(
703 action
='store_true', dest
='listsubtitles', default
=False,
704 help='List available subtitles of each video. Simulate unless --no-simulate is used')
705 subtitles
.add_option(
707 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
708 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
709 subtitles
.add_option(
710 '--sub-langs', '--srt-langs',
711 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
712 default
=[], callback
=_list_from_options_callback
,
714 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
715 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
716 'Use --list-subs for a list of available language tags'))
718 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
719 downloader
.add_option(
720 '-N', '--concurrent-fragments',
721 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
722 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
723 downloader
.add_option(
724 '-r', '--limit-rate', '--rate-limit',
725 dest
='ratelimit', metavar
='RATE',
726 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
727 downloader
.add_option(
729 dest
='throttledratelimit', metavar
='RATE',
730 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
731 downloader
.add_option(
733 dest
='retries', metavar
='RETRIES', default
=10,
734 help='Number of retries (default is %default), or "infinite"')
735 downloader
.add_option(
736 '--file-access-retries',
737 dest
='file_access_retries', metavar
='RETRIES', default
=3,
738 help='Number of times to retry on file access error (default is %default), or "infinite"')
739 downloader
.add_option(
740 '--fragment-retries',
741 dest
='fragment_retries', metavar
='RETRIES', default
=10,
742 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
743 downloader
.add_option(
744 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
745 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
746 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
747 downloader
.add_option(
748 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
749 action
='store_false', dest
='skip_unavailable_fragments',
750 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
751 downloader
.add_option(
753 action
='store_true', dest
='keep_fragments', default
=False,
754 help='Keep downloaded fragments on disk after downloading is finished')
755 downloader
.add_option(
756 '--no-keep-fragments',
757 action
='store_false', dest
='keep_fragments',
758 help='Delete downloaded fragments after downloading is finished (default)')
759 downloader
.add_option(
761 dest
='buffersize', metavar
='SIZE', default
='1024',
762 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
763 downloader
.add_option(
765 action
='store_false', dest
='noresizebuffer',
766 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
767 downloader
.add_option(
768 '--no-resize-buffer',
769 action
='store_true', dest
='noresizebuffer', default
=False,
770 help='Do not automatically adjust the buffer size')
771 downloader
.add_option(
773 dest
='http_chunk_size', metavar
='SIZE', default
=None,
775 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
776 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
777 downloader
.add_option(
779 action
='store_true', dest
='test', default
=False,
780 help=optparse
.SUPPRESS_HELP
)
781 downloader
.add_option(
782 '--playlist-reverse',
784 help='Download playlist videos in reverse order')
785 downloader
.add_option(
786 '--no-playlist-reverse',
787 action
='store_false', dest
='playlist_reverse',
788 help='Download playlist videos in default order (default)')
789 downloader
.add_option(
792 help='Download playlist videos in random order')
793 downloader
.add_option(
794 '--xattr-set-filesize',
795 dest
='xattr_set_filesize', action
='store_true',
796 help='Set file xattribute ytdl.filesize with expected file size')
797 downloader
.add_option(
798 '--hls-prefer-native',
799 dest
='hls_prefer_native', action
='store_true', default
=None,
800 help=optparse
.SUPPRESS_HELP
)
801 downloader
.add_option(
802 '--hls-prefer-ffmpeg',
803 dest
='hls_prefer_native', action
='store_false', default
=None,
804 help=optparse
.SUPPRESS_HELP
)
805 downloader
.add_option(
807 dest
='hls_use_mpegts', action
='store_true', default
=None,
809 'Use the mpegts container for HLS videos; '
810 'allowing some players to play the video while downloading, '
811 'and reducing the chance of file corruption if download is interrupted. '
812 'This is enabled by default for live streams'))
813 downloader
.add_option(
814 '--no-hls-use-mpegts',
815 dest
='hls_use_mpegts', action
='store_false',
817 'Do not use the mpegts container for HLS videos. '
818 'This is default when not downloading live streams'))
819 downloader
.add_option(
820 '--downloader', '--external-downloader',
821 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
822 action
='callback', callback
=_dict_from_options_callback
,
824 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
825 'default_key': 'default',
828 'Name or path of the external downloader to use (optionally) prefixed by '
829 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
830 f
'Currently supports native, {", ".join(list_external_downloaders())}. '
831 'You can use this option multiple times to set different downloaders for different protocols. '
832 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
833 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
834 '(Alias: --external-downloader)'))
835 downloader
.add_option(
836 '--downloader-args', '--external-downloader-args',
837 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
838 action
='callback', callback
=_dict_from_options_callback
,
840 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(map(re
.escape
, list_external_downloaders())),
841 'default_key': 'default',
842 'process': shlex
.split
844 'Give these arguments to the external downloader. '
845 'Specify the downloader name and the arguments separated by a colon ":". '
846 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
847 'You can use this option multiple times to give different arguments to different downloaders '
848 '(Alias: --external-downloader-args)'))
850 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
851 workarounds
.add_option(
853 dest
='encoding', metavar
='ENCODING',
854 help='Force the specified encoding (experimental)')
855 workarounds
.add_option(
856 '--legacy-server-connect',
857 action
='store_true', dest
='legacy_server_connect', default
=False,
858 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
859 workarounds
.add_option(
860 '--no-check-certificates',
861 action
='store_true', dest
='no_check_certificate', default
=False,
862 help='Suppress HTTPS certificate validation')
863 workarounds
.add_option(
864 '--prefer-insecure', '--prefer-unsecure',
865 action
='store_true', dest
='prefer_insecure',
866 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
867 workarounds
.add_option(
869 metavar
='UA', dest
='user_agent',
870 help=optparse
.SUPPRESS_HELP
)
871 workarounds
.add_option(
873 metavar
='URL', dest
='referer', default
=None,
874 help=optparse
.SUPPRESS_HELP
)
875 workarounds
.add_option(
877 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
878 action
='callback', callback
=_dict_from_options_callback
,
879 callback_kwargs
={'multiple_keys': False}
,
880 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
882 workarounds
.add_option(
884 dest
='bidi_workaround', action
='store_true',
885 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
886 workarounds
.add_option(
887 '--sleep-requests', metavar
='SECONDS',
888 dest
='sleep_interval_requests', type=float,
889 help='Number of seconds to sleep between requests during data extraction')
890 workarounds
.add_option(
891 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
892 dest
='sleep_interval', type=float,
894 'Number of seconds to sleep before each download. '
895 'This is the minimum time to sleep when used along with --max-sleep-interval '
896 '(Alias: --min-sleep-interval)'))
897 workarounds
.add_option(
898 '--max-sleep-interval', metavar
='SECONDS',
899 dest
='max_sleep_interval', type=float,
900 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
901 workarounds
.add_option(
902 '--sleep-subtitles', metavar
='SECONDS',
903 dest
='sleep_interval_subtitles', default
=0, type=int,
904 help='Number of seconds to sleep before each subtitle download')
906 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
907 verbosity
.add_option(
909 action
='store_true', dest
='quiet', default
=False,
910 help='Activate quiet mode. If used with --verbose, print the log to stderr')
911 verbosity
.add_option(
913 dest
='no_warnings', action
='store_true', default
=False,
914 help='Ignore warnings')
915 verbosity
.add_option(
917 action
='store_true', dest
='simulate', default
=None,
918 help='Do not download the video and do not write anything to disk')
919 verbosity
.add_option(
921 action
='store_false', dest
='simulate',
922 help='Download the video even if printing/listing options are used')
923 verbosity
.add_option(
924 '--ignore-no-formats-error',
925 action
='store_true', dest
='ignore_no_formats_error', default
=False,
927 'Ignore "No video formats" error. Useful for extracting metadata '
928 'even if the videos are not actually available for download (experimental)'))
929 verbosity
.add_option(
930 '--no-ignore-no-formats-error',
931 action
='store_false', dest
='ignore_no_formats_error',
932 help='Throw error when no downloadable video formats are found (default)')
933 verbosity
.add_option(
934 '--skip-download', '--no-download',
935 action
='store_true', dest
='skip_download', default
=False,
936 help='Do not download the video but write all related files (Alias: --no-download)')
937 verbosity
.add_option(
939 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', default
={}, type='str',
940 action
='callback', callback
=_dict_from_options_callback
,
942 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
943 'default_key': 'video',
944 'multiple_keys': False,
947 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
948 'Supported values of "WHEN" are the same as that of --use-postprocessor, and "video" (default). '
949 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
950 'This option can be used multiple times'))
951 verbosity
.add_option(
953 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', default
={}, type='str', nargs
=2,
954 action
='callback', callback
=_dict_from_options_callback
,
956 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
957 'default_key': 'video',
958 'multiple_keys': False,
961 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
962 'FILE uses the same syntax as the output template. This option can be used multiple times'))
963 verbosity
.add_option(
965 action
='store_true', dest
='geturl', default
=False,
966 help=optparse
.SUPPRESS_HELP
)
967 verbosity
.add_option(
969 action
='store_true', dest
='gettitle', default
=False,
970 help=optparse
.SUPPRESS_HELP
)
971 verbosity
.add_option(
973 action
='store_true', dest
='getid', default
=False,
974 help=optparse
.SUPPRESS_HELP
)
975 verbosity
.add_option(
977 action
='store_true', dest
='getthumbnail', default
=False,
978 help=optparse
.SUPPRESS_HELP
)
979 verbosity
.add_option(
981 action
='store_true', dest
='getdescription', default
=False,
982 help=optparse
.SUPPRESS_HELP
)
983 verbosity
.add_option(
985 action
='store_true', dest
='getduration', default
=False,
986 help=optparse
.SUPPRESS_HELP
)
987 verbosity
.add_option(
989 action
='store_true', dest
='getfilename', default
=False,
990 help=optparse
.SUPPRESS_HELP
)
991 verbosity
.add_option(
993 action
='store_true', dest
='getformat', default
=False,
994 help=optparse
.SUPPRESS_HELP
)
995 verbosity
.add_option(
997 action
='store_true', dest
='dumpjson', default
=False,
998 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
999 verbosity
.add_option(
1000 '-J', '--dump-single-json',
1001 action
='store_true', dest
='dump_single_json', default
=False,
1003 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1004 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1005 verbosity
.add_option(
1007 action
='store_true', dest
='print_json', default
=False,
1008 help=optparse
.SUPPRESS_HELP
)
1009 verbosity
.add_option(
1010 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1011 action
='store_true', dest
='force_write_download_archive', default
=False,
1013 'Force download archive entries to be written as far as no errors occur, '
1014 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1015 verbosity
.add_option(
1017 action
='store_true', dest
='progress_with_newline', default
=False,
1018 help='Output progress bar as new lines')
1019 verbosity
.add_option(
1021 action
='store_true', dest
='noprogress', default
=None,
1022 help='Do not print progress bar')
1023 verbosity
.add_option(
1025 action
='store_false', dest
='noprogress',
1026 help='Show progress bar, even if in quiet mode')
1027 verbosity
.add_option(
1029 action
='store_true', dest
='consoletitle', default
=False,
1030 help='Display progress in console titlebar')
1031 verbosity
.add_option(
1032 '--progress-template',
1033 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1034 action
='callback', callback
=_dict_from_options_callback
,
1036 'allowed_keys': '(download|postprocess)(-title)?',
1037 'default_key': 'download'
1039 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1040 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1041 'The video\'s fields are accessible under the "info" key and '
1042 'the progress attributes are accessible under "progress" key. E.g.: '
1043 # TODO: Document the fields inside "progress"
1044 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1045 verbosity
.add_option(
1047 action
='store_true', dest
='verbose', default
=False,
1048 help='Print various debugging information')
1049 verbosity
.add_option(
1050 '--dump-pages', '--dump-intermediate-pages',
1051 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1052 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1053 verbosity
.add_option(
1055 action
='store_true', dest
='write_pages', default
=False,
1056 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1057 verbosity
.add_option(
1058 '--youtube-print-sig-code',
1059 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1060 help=optparse
.SUPPRESS_HELP
)
1061 verbosity
.add_option(
1062 '--print-traffic', '--dump-headers',
1063 dest
='debug_printtraffic', action
='store_true', default
=False,
1064 help='Display sent and read HTTP traffic')
1065 verbosity
.add_option(
1066 '-C', '--call-home',
1067 dest
='call_home', action
='store_true', default
=False,
1068 # help='Contact the yt-dlp server for debugging')
1069 help=optparse
.SUPPRESS_HELP
)
1070 verbosity
.add_option(
1072 dest
='call_home', action
='store_false',
1073 # help='Do not contact the yt-dlp server for debugging (default)')
1074 help=optparse
.SUPPRESS_HELP
)
1076 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1077 filesystem
.add_option(
1078 '-a', '--batch-file',
1079 dest
='batchfile', metavar
='FILE',
1081 'File containing URLs to download ("-" for stdin), one URL per line. '
1082 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1083 filesystem
.add_option(
1085 dest
='batchfile', action
='store_const', const
=None,
1086 help='Do not read URLs from batch file (default)')
1087 filesystem
.add_option(
1088 '--id', default
=False,
1089 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1090 filesystem
.add_option(
1092 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1093 action
='callback', callback
=_dict_from_options_callback
,
1095 'allowed_keys': 'home|temp|%s' % '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1096 'default_key': 'home'
1098 'The paths where the files should be downloaded. '
1099 'Specify the type of file and the path separated by a colon ":". '
1100 'All the same TYPES as --output are supported. '
1101 'Additionally, you can also provide "home" (default) and "temp" paths. '
1102 'All intermediary files are first downloaded to the temp path and '
1103 'then the final files are moved over to the home path after download is finished. '
1104 'This option is ignored if --output is an absolute path'))
1105 filesystem
.add_option(
1107 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1108 action
='callback', callback
=_dict_from_options_callback
,
1110 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1111 'default_key': 'default'
1112 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1113 filesystem
.add_option(
1114 '--output-na-placeholder',
1115 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1116 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
1117 filesystem
.add_option(
1118 '--autonumber-size',
1119 dest
='autonumber_size', metavar
='NUMBER', type=int,
1120 help=optparse
.SUPPRESS_HELP
)
1121 filesystem
.add_option(
1122 '--autonumber-start',
1123 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1124 help=optparse
.SUPPRESS_HELP
)
1125 filesystem
.add_option(
1126 '--restrict-filenames',
1127 action
='store_true', dest
='restrictfilenames', default
=False,
1128 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1129 filesystem
.add_option(
1130 '--no-restrict-filenames',
1131 action
='store_false', dest
='restrictfilenames',
1132 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1133 filesystem
.add_option(
1134 '--windows-filenames',
1135 action
='store_true', dest
='windowsfilenames', default
=False,
1136 help='Force filenames to be Windows-compatible')
1137 filesystem
.add_option(
1138 '--no-windows-filenames',
1139 action
='store_false', dest
='windowsfilenames',
1140 help='Make filenames Windows-compatible only if using Windows (default)')
1141 filesystem
.add_option(
1142 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1143 dest
='trim_file_name', default
=0, type=int,
1144 help='Limit the filename length (excluding extension) to the specified number of characters')
1145 filesystem
.add_option(
1146 '-w', '--no-overwrites',
1147 action
='store_false', dest
='overwrites', default
=None,
1148 help='Do not overwrite any files')
1149 filesystem
.add_option(
1150 '--force-overwrites', '--yes-overwrites',
1151 action
='store_true', dest
='overwrites',
1152 help='Overwrite all video and metadata files. This option includes --no-continue')
1153 filesystem
.add_option(
1154 '--no-force-overwrites',
1155 action
='store_const', dest
='overwrites', const
=None,
1156 help='Do not overwrite the video, but overwrite related files (default)')
1157 filesystem
.add_option(
1159 action
='store_true', dest
='continue_dl', default
=True,
1160 help='Resume partially downloaded files/fragments (default)')
1161 filesystem
.add_option(
1163 action
='store_false', dest
='continue_dl',
1165 'Do not resume partially downloaded fragments. '
1166 'If the file is not fragmented, restart download of the entire file'))
1167 filesystem
.add_option(
1169 action
='store_false', dest
='nopart', default
=False,
1170 help='Use .part files instead of writing directly into output file (default)')
1171 filesystem
.add_option(
1173 action
='store_true', dest
='nopart',
1174 help='Do not use .part files - write directly into output file')
1175 filesystem
.add_option(
1177 action
='store_true', dest
='updatetime', default
=True,
1178 help='Use the Last-modified header to set the file modification time (default)')
1179 filesystem
.add_option(
1181 action
='store_false', dest
='updatetime',
1182 help='Do not use the Last-modified header to set the file modification time')
1183 filesystem
.add_option(
1184 '--write-description',
1185 action
='store_true', dest
='writedescription', default
=False,
1186 help='Write video description to a .description file')
1187 filesystem
.add_option(
1188 '--no-write-description',
1189 action
='store_false', dest
='writedescription',
1190 help='Do not write video description (default)')
1191 filesystem
.add_option(
1192 '--write-info-json',
1193 action
='store_true', dest
='writeinfojson', default
=None,
1194 help='Write video metadata to a .info.json file (this may contain personal information)')
1195 filesystem
.add_option(
1196 '--no-write-info-json',
1197 action
='store_false', dest
='writeinfojson',
1198 help='Do not write video metadata (default)')
1199 filesystem
.add_option(
1200 '--write-annotations',
1201 action
='store_true', dest
='writeannotations', default
=False,
1202 help=optparse
.SUPPRESS_HELP
)
1203 filesystem
.add_option(
1204 '--no-write-annotations',
1205 action
='store_false', dest
='writeannotations',
1206 help=optparse
.SUPPRESS_HELP
)
1207 filesystem
.add_option(
1208 '--write-playlist-metafiles',
1209 action
='store_true', dest
='allow_playlist_files', default
=None,
1211 'Write playlist metadata in addition to the video metadata '
1212 'when using --write-info-json, --write-description etc. (default)'))
1213 filesystem
.add_option(
1214 '--no-write-playlist-metafiles',
1215 action
='store_false', dest
='allow_playlist_files',
1216 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1217 filesystem
.add_option(
1218 '--clean-info-json', '--clean-infojson',
1219 action
='store_true', dest
='clean_infojson', default
=None,
1221 'Remove some private fields such as filenames from the infojson. '
1222 'Note that it could still contain some personal information (default)'))
1223 filesystem
.add_option(
1224 '--no-clean-info-json', '--no-clean-infojson',
1225 action
='store_false', dest
='clean_infojson',
1226 help='Write all fields to the infojson')
1227 filesystem
.add_option(
1228 '--write-comments', '--get-comments',
1229 action
='store_true', dest
='getcomments', default
=False,
1231 'Retrieve video comments to be placed in the infojson. '
1232 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1233 filesystem
.add_option(
1234 '--no-write-comments', '--no-get-comments',
1235 action
='store_false', dest
='getcomments',
1236 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1237 filesystem
.add_option(
1238 '--load-info-json', '--load-info',
1239 dest
='load_info_filename', metavar
='FILE',
1240 help='JSON file containing the video information (created with the "--write-info-json" option)')
1241 filesystem
.add_option(
1243 dest
='cookiefile', metavar
='FILE',
1244 help='Netscape formatted file to read cookies from and dump cookie jar in')
1245 filesystem
.add_option(
1247 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1248 help='Do not read/dump cookies from/to file (default)')
1249 filesystem
.add_option(
1250 '--cookies-from-browser',
1251 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE]',
1253 'The name of the browser and (optionally) the name/path of '
1254 'the profile to load cookies from, separated by a ":". '
1255 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1256 'By default, the most recently accessed profile is used. '
1257 'The keyring used for decrypting Chromium cookies on Linux can be '
1258 '(optionally) specified after the browser name separated by a "+". '
1259 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1260 filesystem
.add_option(
1261 '--no-cookies-from-browser',
1262 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1263 help='Do not load cookies from browser (default)')
1264 filesystem
.add_option(
1265 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1266 help='Location in the filesystem where youtube-dl can store some downloaded information (such as client ids and signatures) permanently. By default $XDG_CACHE_HOME/yt-dlp or ~/.cache/yt-dlp')
1267 filesystem
.add_option(
1268 '--no-cache-dir', action
='store_false', dest
='cachedir',
1269 help='Disable filesystem caching')
1270 filesystem
.add_option(
1272 action
='store_true', dest
='rm_cachedir',
1273 help='Delete all filesystem cache files')
1275 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1276 thumbnail
.add_option(
1277 '--write-thumbnail',
1278 action
='callback', dest
='writethumbnail', default
=False,
1279 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1280 callback
=lambda option
, _
, __
, parser
: setattr(
1281 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1282 help='Write thumbnail image to disk')
1283 thumbnail
.add_option(
1284 '--no-write-thumbnail',
1285 action
='store_false', dest
='writethumbnail',
1286 help='Do not write thumbnail image to disk (default)')
1287 thumbnail
.add_option(
1288 '--write-all-thumbnails',
1289 action
='store_const', dest
='writethumbnail', const
='all',
1290 help='Write all thumbnail image formats to disk')
1291 thumbnail
.add_option(
1292 '--list-thumbnails',
1293 action
='store_true', dest
='list_thumbnails', default
=False,
1294 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1296 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1299 action
='store_true', dest
='writelink', default
=False,
1300 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1303 action
='store_true', dest
='writeurllink', default
=False,
1304 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1306 '--write-webloc-link',
1307 action
='store_true', dest
='writewebloclink', default
=False,
1308 help='Write a .webloc macOS internet shortcut')
1310 '--write-desktop-link',
1311 action
='store_true', dest
='writedesktoplink', default
=False,
1312 help='Write a .desktop Linux internet shortcut')
1314 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1315 postproc
.add_option(
1316 '-x', '--extract-audio',
1317 action
='store_true', dest
='extractaudio', default
=False,
1318 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1319 postproc
.add_option(
1320 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1322 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1323 'best (default) or one of %s' % ', '.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1324 postproc
.add_option(
1325 '--audio-quality', metavar
='QUALITY',
1326 dest
='audioquality', default
='5',
1327 help='Specify ffmpeg audio quality to use when converting the audio with -x. Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')
1328 postproc
.add_option(
1330 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1332 'Remux the video into another container if necessary (currently supported: %s). '
1333 'If target container does not support the video/audio codec, remuxing will fail. '
1334 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1335 'and anything else to mkv.' % ', '.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1336 postproc
.add_option(
1338 metavar
='FORMAT', dest
='recodevideo', default
=None,
1340 'Re-encode the video into another format if re-encoding is necessary. '
1341 'The syntax and supported formats are the same as --remux-video'))
1342 postproc
.add_option(
1343 '--postprocessor-args', '--ppa',
1344 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1345 action
='callback', callback
=_dict_from_options_callback
,
1347 'allowed_keys': r
'\w+(?:\+\w+)?',
1348 'default_key': 'default-compat',
1349 'process': shlex
.split
,
1350 'multiple_keys': False
1352 'Give these arguments to the postprocessors. '
1353 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1354 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1355 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1356 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1357 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1358 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1359 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1360 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1361 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1362 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1363 'You can use this option multiple times to give different arguments to different '
1364 'postprocessors. (Alias: --ppa)'))
1365 postproc
.add_option(
1366 '-k', '--keep-video',
1367 action
='store_true', dest
='keepvideo', default
=False,
1368 help='Keep the intermediate video file on disk after post-processing')
1369 postproc
.add_option(
1371 action
='store_false', dest
='keepvideo',
1372 help='Delete the intermediate video file after post-processing (default)')
1373 postproc
.add_option(
1374 '--post-overwrites',
1375 action
='store_false', dest
='nopostoverwrites',
1376 help='Overwrite post-processed files (default)')
1377 postproc
.add_option(
1378 '--no-post-overwrites',
1379 action
='store_true', dest
='nopostoverwrites', default
=False,
1380 help='Do not overwrite post-processed files')
1381 postproc
.add_option(
1383 action
='store_true', dest
='embedsubtitles', default
=False,
1384 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1385 postproc
.add_option(
1387 action
='store_false', dest
='embedsubtitles',
1388 help='Do not embed subtitles (default)')
1389 postproc
.add_option(
1390 '--embed-thumbnail',
1391 action
='store_true', dest
='embedthumbnail', default
=False,
1392 help='Embed thumbnail in the video as cover art')
1393 postproc
.add_option(
1394 '--no-embed-thumbnail',
1395 action
='store_false', dest
='embedthumbnail',
1396 help='Do not embed thumbnail (default)')
1397 postproc
.add_option(
1398 '--embed-metadata', '--add-metadata',
1399 action
='store_true', dest
='addmetadata', default
=False,
1401 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1402 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1403 postproc
.add_option(
1404 '--no-embed-metadata', '--no-add-metadata',
1405 action
='store_false', dest
='addmetadata',
1406 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1407 postproc
.add_option(
1408 '--embed-chapters', '--add-chapters',
1409 action
='store_true', dest
='addchapters', default
=None,
1410 help='Add chapter markers to the video file (Alias: --add-chapters)')
1411 postproc
.add_option(
1412 '--no-embed-chapters', '--no-add-chapters',
1413 action
='store_false', dest
='addchapters',
1414 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1415 postproc
.add_option(
1416 '--embed-info-json',
1417 action
='store_true', dest
='embed_infojson', default
=None,
1418 help='Embed the infojson as an attachment to mkv/mka video files')
1419 postproc
.add_option(
1420 '--no-embed-info-json',
1421 action
='store_false', dest
='embed_infojson',
1422 help='Do not embed the infojson as an attachment to the video file')
1423 postproc
.add_option(
1424 '--metadata-from-title',
1425 metavar
='FORMAT', dest
='metafromtitle',
1426 help=optparse
.SUPPRESS_HELP
)
1427 postproc
.add_option(
1429 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1431 'Parse additional metadata like title/artist from other fields; '
1432 'see "MODIFYING METADATA" for details'))
1433 postproc
.add_option(
1434 '--replace-in-metadata',
1435 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1436 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1437 postproc
.add_option(
1438 '--xattrs', '--xattr',
1439 action
='store_true', dest
='xattrs', default
=False,
1440 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1441 postproc
.add_option(
1442 '--concat-playlist',
1443 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1444 choices
=('never', 'always', 'multi_video'),
1446 'Concatenate videos in a playlist. One of "never", "always", or '
1447 '"multi_video" (default; only when the videos form a single show). '
1448 'All the video files must have same codecs and number of streams to be concatable. '
1449 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1450 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1451 postproc
.add_option(
1453 metavar
='POLICY', dest
='fixup', default
=None,
1454 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1456 'Automatically correct known faults of the file. '
1457 'One of never (do nothing), warn (only emit a warning), '
1458 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1459 'force (try fixing even if file already exists)'))
1460 postproc
.add_option(
1461 '--prefer-avconv', '--no-prefer-ffmpeg',
1462 action
='store_false', dest
='prefer_ffmpeg',
1463 help=optparse
.SUPPRESS_HELP
)
1464 postproc
.add_option(
1465 '--prefer-ffmpeg', '--no-prefer-avconv',
1466 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1467 help=optparse
.SUPPRESS_HELP
)
1468 postproc
.add_option(
1469 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1470 dest
='ffmpeg_location',
1471 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1472 postproc
.add_option(
1474 metavar
='[WHEN:]CMD', dest
='exec_cmd', default
={}, type='str',
1475 action
='callback', callback
=_dict_from_options_callback
,
1477 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
1478 'default_key': 'after_move',
1479 'multiple_keys': False,
1482 'Execute a command, optionally prefixed with when to execute it (after_move if unspecified), separated by a ":". '
1483 'Supported values of "WHEN" are the same as that of --use-postprocessor. '
1484 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1485 'After download, an additional field "filepath" that contains the final path of the downloaded file '
1486 'is also available, and if no fields are passed, %(filepath)q is appended to the end of the command. '
1487 'This option can be used multiple times'))
1488 postproc
.add_option(
1490 action
='store_const', dest
='exec_cmd', const
={},
1491 help='Remove any previously defined --exec')
1492 postproc
.add_option(
1493 '--exec-before-download', metavar
='CMD',
1494 action
='append', dest
='exec_before_dl_cmd',
1495 help=optparse
.SUPPRESS_HELP
)
1496 postproc
.add_option(
1497 '--no-exec-before-download',
1498 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1499 help=optparse
.SUPPRESS_HELP
)
1500 postproc
.add_option(
1501 '--convert-subs', '--convert-sub', '--convert-subtitles',
1502 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1504 'Convert the subtitles to another format (currently supported: %s) '
1505 '(Alias: --convert-subtitles)' % ', '.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1506 postproc
.add_option(
1507 '--convert-thumbnails',
1508 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1510 'Convert the thumbnails to another format '
1511 '(currently supported: %s) ' % ', '.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1512 postproc
.add_option(
1513 '--split-chapters', '--split-tracks',
1514 dest
='split_chapters', action
='store_true', default
=False,
1516 'Split video into multiple files based on internal chapters. '
1517 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1518 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1519 postproc
.add_option(
1520 '--no-split-chapters', '--no-split-tracks',
1521 dest
='split_chapters', action
='store_false',
1522 help='Do not split video based on chapters (default)')
1523 postproc
.add_option(
1524 '--remove-chapters',
1525 metavar
='REGEX', dest
='remove_chapters', action
='append',
1527 'Remove chapters whose title matches the given regular expression. '
1528 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1529 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1530 'This option can be used multiple times'))
1531 postproc
.add_option(
1532 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1533 help='Do not remove any chapters from the file (default)')
1534 postproc
.add_option(
1535 '--force-keyframes-at-cuts',
1536 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1538 'Force keyframes around the chapters before removing/splitting them. '
1539 'Requires a re-encode and thus is very slow, but the resulting video '
1540 'may have fewer artifacts around the cuts'))
1541 postproc
.add_option(
1542 '--no-force-keyframes-at-cuts',
1543 action
='store_false', dest
='force_keyframes_at_cuts',
1544 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1545 _postprocessor_opts_parser
= lambda key
, val
='': (
1546 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1547 ('key', remove_end(key
, 'PP')))
1548 postproc
.add_option(
1549 '--use-postprocessor',
1550 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1551 action
='callback', callback
=_list_from_options_callback
,
1554 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1556 'The (case sensitive) name of plugin postprocessors to be enabled, '
1557 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1558 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1559 'The "when" argument determines when the postprocessor is invoked. '
1560 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1561 '"before_dl" (before each video download), "post_process" (after each video download; default), '
1562 '"after_move" (after moving video file to it\'s final locations), '
1563 '"after_video" (after downloading and processing all formats of a video), '
1564 'or "playlist" (at end of playlist). '
1565 'This option can be used multiple times to add different postprocessors'))
1567 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1568 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1569 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1570 sponsorblock
.add_option(
1571 '--sponsorblock-mark', metavar
='CATS',
1572 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1573 callback
=_set_from_options_callback
, callback_kwargs
={
1574 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1575 'aliases': {'default': ['all']}
1577 'SponsorBlock categories to create chapters for, separated by commas. '
1578 f
'Available categories are all, default(=all), {", ".join(SponsorBlockPP.CATEGORIES.keys())}. '
1579 'You can prefix the category with a "-" to exempt it. See [1] for description of the categories. '
1580 'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1581 sponsorblock
.add_option(
1582 '--sponsorblock-remove', metavar
='CATS',
1583 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1584 callback
=_set_from_options_callback
, callback_kwargs
={
1585 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.POI_CATEGORIES
.keys()),
1586 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1587 # The filler category is very aggressive.
1588 # It is strongly recommended to not use this in a client by default.
1589 'aliases': {'default': ['all', '-filler']}
1591 'SponsorBlock categories to be removed from the video file, separated by commas. '
1592 'If a category is present in both mark and remove, remove takes precedence. '
1593 'The syntax and available categories are the same as for --sponsorblock-mark '
1594 'except that "default" refers to "all,-filler" '
1595 f
'and {", ".join(SponsorBlockPP.POI_CATEGORIES.keys())} is not available'))
1596 sponsorblock
.add_option(
1597 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1598 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1600 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1601 'The same syntax as the output template is used, but the only available fields are '
1602 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1603 sponsorblock
.add_option(
1604 '--no-sponsorblock', default
=False,
1605 action
='store_true', dest
='no_sponsorblock',
1606 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1607 sponsorblock
.add_option(
1608 '--sponsorblock-api', metavar
='URL',
1609 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1610 help='SponsorBlock API location, defaults to %default')
1612 sponsorblock
.add_option(
1614 action
='store_true', dest
='sponskrub', default
=False,
1615 help=optparse
.SUPPRESS_HELP
)
1616 sponsorblock
.add_option(
1618 action
='store_false', dest
='sponskrub',
1619 help=optparse
.SUPPRESS_HELP
)
1620 sponsorblock
.add_option(
1621 '--sponskrub-cut', default
=False,
1622 action
='store_true', dest
='sponskrub_cut',
1623 help=optparse
.SUPPRESS_HELP
)
1624 sponsorblock
.add_option(
1625 '--no-sponskrub-cut',
1626 action
='store_false', dest
='sponskrub_cut',
1627 help=optparse
.SUPPRESS_HELP
)
1628 sponsorblock
.add_option(
1629 '--sponskrub-force', default
=False,
1630 action
='store_true', dest
='sponskrub_force',
1631 help=optparse
.SUPPRESS_HELP
)
1632 sponsorblock
.add_option(
1633 '--no-sponskrub-force',
1634 action
='store_true', dest
='sponskrub_force',
1635 help=optparse
.SUPPRESS_HELP
)
1636 sponsorblock
.add_option(
1637 '--sponskrub-location', metavar
='PATH',
1638 dest
='sponskrub_path', default
='',
1639 help=optparse
.SUPPRESS_HELP
)
1640 sponsorblock
.add_option(
1641 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1642 help=optparse
.SUPPRESS_HELP
)
1644 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1645 extractor
.add_option(
1646 '--extractor-retries',
1647 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1648 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1649 extractor
.add_option(
1650 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1651 action
='store_true', dest
='dynamic_mpd', default
=True,
1652 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1653 extractor
.add_option(
1654 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1655 action
='store_false', dest
='dynamic_mpd',
1656 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1657 extractor
.add_option(
1658 '--hls-split-discontinuity',
1659 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1660 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1662 extractor
.add_option(
1663 '--no-hls-split-discontinuity',
1664 dest
='hls_split_discontinuity', action
='store_false',
1665 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1666 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1667 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1668 extractor
.add_option(
1670 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1671 action
='callback', callback
=_dict_from_options_callback
,
1673 'multiple_keys': False,
1674 'process': lambda val
: dict(
1675 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1677 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1678 'You can use this option multiple times to give arguments for different extractors'))
1679 extractor
.add_option(
1680 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1681 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1682 help=optparse
.SUPPRESS_HELP
)
1683 extractor
.add_option(
1684 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1685 action
='store_false', dest
='youtube_include_dash_manifest',
1686 help=optparse
.SUPPRESS_HELP
)
1687 extractor
.add_option(
1688 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1689 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1690 help=optparse
.SUPPRESS_HELP
)
1691 extractor
.add_option(
1692 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1693 action
='store_false', dest
='youtube_include_hls_manifest',
1694 help=optparse
.SUPPRESS_HELP
)
1696 parser
.add_option_group(general
)
1697 parser
.add_option_group(network
)
1698 parser
.add_option_group(geo
)
1699 parser
.add_option_group(selection
)
1700 parser
.add_option_group(downloader
)
1701 parser
.add_option_group(filesystem
)
1702 parser
.add_option_group(thumbnail
)
1703 parser
.add_option_group(link
)
1704 parser
.add_option_group(verbosity
)
1705 parser
.add_option_group(workarounds
)
1706 parser
.add_option_group(video_format
)
1707 parser
.add_option_group(subtitles
)
1708 parser
.add_option_group(authentication
)
1709 parser
.add_option_group(postproc
)
1710 parser
.add_option_group(sponsorblock
)
1711 parser
.add_option_group(extractor
)
1716 def _hide_login_info(opts
):
1718 'DeprecationWarning: "yt_dlp.options._hide_login_info" is deprecated and may be removed in a future version. '
1719 'Use "yt_dlp.utils.Config.hide_login_info" instead\n')
1720 return Config
.hide_login_info(opts
)