Add option `--plugin-dirs` (#11277)
[yt-dlp3.git] / yt_dlp / options.py
blobc3a647da773b2e9a47dfcc155084d75ef174a448
1 import collections
2 import contextlib
3 import optparse
4 import os.path
5 import re
6 import shlex
7 import shutil
8 import string
9 import sys
11 from .compat import compat_expanduser
12 from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS
13 from .downloader.external import list_external_downloaders
14 from .postprocessor import (
15 FFmpegExtractAudioPP,
16 FFmpegMergerPP,
17 FFmpegSubtitlesConvertorPP,
18 FFmpegThumbnailsConvertorPP,
19 FFmpegVideoRemuxerPP,
20 SponsorBlockPP,
22 from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
23 from .update import UPDATE_SOURCES, detect_variant, is_non_updateable
24 from .utils import (
25 OUTTMPL_TYPES,
26 POSTPROCESS_WHEN,
27 Config,
28 deprecation_warning,
29 expand_path,
30 format_field,
31 get_executable_path,
32 get_system_config_dirs,
33 get_user_config_dirs,
34 join_nonempty,
35 orderedSet_from_options,
36 remove_end,
37 variadic,
38 write_string,
40 from .version import CHANNEL, __version__
43 def parseOpts(overrideArguments=None, ignore_config_files='if_override'): # noqa: N803
44 PACKAGE_NAME = 'yt-dlp'
46 root = Config(create_parser())
47 if ignore_config_files == 'if_override':
48 ignore_config_files = overrideArguments is not None
50 def read_config(*paths):
51 path = os.path.join(*paths)
52 conf = Config.read_file(path, default=None)
53 if conf is not None:
54 return conf, path
56 def _load_from_config_dirs(config_dirs):
57 for config_dir in config_dirs:
58 head, tail = os.path.split(config_dir)
59 assert tail == PACKAGE_NAME or config_dir == os.path.join(compat_expanduser('~'), f'.{PACKAGE_NAME}')
61 yield read_config(head, f'{PACKAGE_NAME}.conf')
62 if tail.startswith('.'): # ~/.PACKAGE_NAME
63 yield read_config(head, f'{PACKAGE_NAME}.conf.txt')
64 yield read_config(config_dir, 'config')
65 yield read_config(config_dir, 'config.txt')
67 def add_config(label, path=None, func=None):
68 """ Adds config and returns whether to continue """
69 if root.parse_known_args()[0].ignoreconfig:
70 return False
71 elif func:
72 assert path is None
73 args, current_path = next(
74 filter(None, _load_from_config_dirs(func(PACKAGE_NAME))), (None, None))
75 else:
76 current_path = os.path.join(path, 'yt-dlp.conf')
77 args = Config.read_file(current_path, default=None)
78 if args is not None:
79 root.append_config(args, current_path, label=label)
80 return True
82 def load_configs():
83 yield not ignore_config_files
84 yield add_config('Portable', get_executable_path())
85 yield add_config('Home', expand_path(root.parse_known_args()[0].paths.get('home', '')).strip())
86 yield add_config('User', func=get_user_config_dirs)
87 yield add_config('System', func=get_system_config_dirs)
89 opts = optparse.Values({'verbose': True, 'print_help': False})
90 try:
91 try:
92 if overrideArguments is not None:
93 root.append_config(overrideArguments, label='Override')
94 else:
95 root.append_config(sys.argv[1:], label='Command-line')
96 loaded_all_configs = all(load_configs())
97 except ValueError as err:
98 raise root.parser.error(err)
100 if loaded_all_configs:
101 # If ignoreconfig is found inside the system configuration file,
102 # the user configuration is removed
103 if root.parse_known_args()[0].ignoreconfig:
104 user_conf = next((i for i, conf in enumerate(root.configs) if conf.label == 'User'), None)
105 if user_conf is not None:
106 root.configs.pop(user_conf)
108 try:
109 root.configs[0].load_configs() # Resolve any aliases using --config-location
110 except ValueError as err:
111 raise root.parser.error(err)
113 opts, args = root.parse_args()
114 except optparse.OptParseError:
115 with contextlib.suppress(optparse.OptParseError):
116 opts, _ = root.parse_known_args(strict=False)
117 raise
118 except (SystemExit, KeyboardInterrupt):
119 opts.verbose = False
120 raise
121 finally:
122 verbose = opts.verbose and f'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
123 if verbose:
124 write_string(f'{verbose}\n')
125 if opts.print_help:
126 if verbose:
127 write_string('\n')
128 root.parser.print_help()
129 if opts.print_help:
130 sys.exit()
131 return root.parser, opts, args
134 class _YoutubeDLHelpFormatter(optparse.IndentedHelpFormatter):
135 def __init__(self):
136 # No need to wrap help messages if we're on a wide console
137 max_width = shutil.get_terminal_size().columns or 80
138 # The % is chosen to get a pretty output in README.md
139 super().__init__(width=max_width, max_help_position=int(0.45 * max_width))
141 @staticmethod
142 def format_option_strings(option):
143 """ ('-o', '--option') -> -o, --format METAVAR """
144 opts = join_nonempty(
145 option._short_opts and option._short_opts[0],
146 option._long_opts and option._long_opts[0],
147 delim=', ')
148 if option.takes_value():
149 opts += f' {option.metavar}'
150 return opts
153 class _YoutubeDLOptionParser(optparse.OptionParser):
154 # optparse is deprecated since Python 3.2. So assume a stable interface even for private methods
155 ALIAS_DEST = '_triggered_aliases'
156 ALIAS_TRIGGER_LIMIT = 100
158 def __init__(self):
159 super().__init__(
160 prog='yt-dlp' if detect_variant() == 'source' else None,
161 version=__version__,
162 usage='%prog [OPTIONS] URL [URL...]',
163 epilog='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
164 formatter=_YoutubeDLHelpFormatter(),
165 conflict_handler='resolve',
167 self.set_default(self.ALIAS_DEST, collections.defaultdict(int))
169 _UNKNOWN_OPTION = (optparse.BadOptionError, optparse.AmbiguousOptionError)
170 _BAD_OPTION = optparse.OptionValueError
172 def parse_known_args(self, args=None, values=None, strict=True):
173 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
174 self.rargs, self.largs = self._get_args(args), []
175 self.values = values or self.get_default_values()
176 while self.rargs:
177 arg = self.rargs[0]
178 try:
179 if arg == '--':
180 del self.rargs[0]
181 break
182 elif arg.startswith('--'):
183 self._process_long_opt(self.rargs, self.values)
184 elif arg.startswith('-') and arg != '-':
185 self._process_short_opts(self.rargs, self.values)
186 elif self.allow_interspersed_args:
187 self.largs.append(self.rargs.pop(0))
188 else:
189 break
190 except optparse.OptParseError as err:
191 if isinstance(err, self._UNKNOWN_OPTION):
192 self.largs.append(err.opt_str)
193 elif strict:
194 if isinstance(err, self._BAD_OPTION):
195 self.error(str(err))
196 raise
197 return self.check_values(self.values, self.largs)
199 def _generate_error_message(self, msg):
200 msg = f'{self.get_prog_name()}: error: {str(msg).strip()}\n'
201 return f'{self.get_usage()}\n{msg}' if self.usage else msg
203 def error(self, msg):
204 raise optparse.OptParseError(self._generate_error_message(msg))
206 def _get_args(self, args):
207 return sys.argv[1:] if args is None else list(args)
209 def _match_long_opt(self, opt):
210 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
211 try:
212 return super()._match_long_opt(opt)
213 except optparse.AmbiguousOptionError as e:
214 if len({self._long_opt[p] for p in e.possibilities}) == 1:
215 return e.possibilities[0]
216 raise
219 def create_parser():
220 def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip):
221 # append can be True, False or -1 (prepend)
222 current = list(getattr(parser.values, option.dest)) if append else []
223 value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim))))
224 setattr(
225 parser.values, option.dest,
226 current + value if append is True else value + current)
228 def _set_from_options_callback(
229 option, opt_str, value, parser, allowed_values, delim=',', aliases={},
230 process=lambda x: x.lower().strip()):
231 values = [process(value)] if delim is None else map(process, value.split(delim))
232 try:
233 requested = orderedSet_from_options(values, collections.ChainMap(aliases, {'all': allowed_values}),
234 start=getattr(parser.values, option.dest))
235 except ValueError as e:
236 raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {e.args[0]}')
238 setattr(parser.values, option.dest, set(requested))
240 def _dict_from_options_callback(
241 option, opt_str, value, parser,
242 allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True,
243 process_key=str.lower, append=False):
245 out_dict = dict(getattr(parser.values, option.dest))
246 multiple_args = not isinstance(value, str)
247 if multiple_keys:
248 allowed_keys = fr'({allowed_keys})(,({allowed_keys}))*'
249 mobj = re.match(
250 fr'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
251 value[0] if multiple_args else value)
252 if mobj is not None:
253 keys, val = mobj.group('keys').split(','), mobj.group('val')
254 if multiple_args:
255 val = [val, *value[1:]]
256 elif default_key is not None:
257 keys, val = variadic(default_key), value
258 else:
259 raise optparse.OptionValueError(
260 f'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
261 try:
262 keys = map(process_key, keys) if process_key else keys
263 val = process(val) if process else val
264 except Exception as err:
265 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
266 for key in keys:
267 out_dict[key] = [*out_dict.get(key, []), val] if append else val
268 setattr(parser.values, option.dest, out_dict)
270 def when_prefix(default):
271 return {
272 'default': {},
273 'type': 'str',
274 'action': 'callback',
275 'callback': _dict_from_options_callback,
276 'callback_kwargs': {
277 'allowed_keys': '|'.join(map(re.escape, POSTPROCESS_WHEN)),
278 'default_key': default,
279 'multiple_keys': False,
280 'append': True,
284 parser = _YoutubeDLOptionParser()
285 alias_group = optparse.OptionGroup(parser, 'Aliases')
286 Formatter = string.Formatter()
288 def _create_alias(option, opt_str, value, parser):
289 aliases, opts = value
290 try:
291 nargs = len({i if f == '' else f
292 for i, (_, f, _, _) in enumerate(Formatter.parse(opts)) if f is not None})
293 opts.format(*map(str, range(nargs))) # validate
294 except Exception as err:
295 raise optparse.OptionValueError(f'wrong {opt_str} OPTIONS formatting; {err}')
296 if alias_group not in parser.option_groups:
297 parser.add_option_group(alias_group)
299 aliases = (x if x.startswith('-') else f'--{x}' for x in map(str.strip, aliases.split(',')))
300 try:
301 args = [f'ARG{i}' for i in range(nargs)]
302 alias_group.add_option(
303 *aliases, nargs=nargs, dest=parser.ALIAS_DEST, type='str' if nargs else None,
304 metavar=' '.join(args), help=opts.format(*args), action='callback',
305 callback=_alias_callback, callback_kwargs={'opts': opts, 'nargs': nargs})
306 except Exception as err:
307 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
309 def _alias_callback(option, opt_str, value, parser, opts, nargs):
310 counter = getattr(parser.values, option.dest)
311 counter[opt_str] += 1
312 if counter[opt_str] > parser.ALIAS_TRIGGER_LIMIT:
313 raise optparse.OptionValueError(f'Alias {opt_str} exceeded invocation limit')
314 if nargs == 1:
315 value = [value]
316 assert (nargs == 0 and value is None) or len(value) == nargs
317 parser.rargs[:0] = shlex.split(
318 opts if value is None else opts.format(*map(shlex.quote, value)))
320 general = optparse.OptionGroup(parser, 'General Options')
321 general.add_option(
322 '-h', '--help', dest='print_help', action='store_true',
323 help='Print this help text and exit')
324 general.add_option(
325 '--version',
326 action='version',
327 help='Print program version and exit')
328 general.add_option(
329 '-U', '--update',
330 action='store_const', dest='update_self', const=CHANNEL,
331 help=format_field(
332 is_non_updateable(), None, 'Check if updates are available. %s',
333 default=f'Update this program to the latest {CHANNEL} version'))
334 general.add_option(
335 '--no-update',
336 action='store_false', dest='update_self',
337 help='Do not check for updates (default)')
338 general.add_option(
339 '--update-to',
340 action='store', dest='update_self', metavar='[CHANNEL]@[TAG]',
341 help=(
342 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
343 f'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
344 f'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
345 general.add_option(
346 '-i', '--ignore-errors',
347 action='store_true', dest='ignoreerrors',
348 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
349 general.add_option(
350 '--no-abort-on-error',
351 action='store_const', dest='ignoreerrors', const='only_download',
352 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
353 general.add_option(
354 '--abort-on-error', '--no-ignore-errors',
355 action='store_false', dest='ignoreerrors',
356 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
357 general.add_option(
358 '--dump-user-agent',
359 action='store_true', dest='dump_user_agent', default=False,
360 help='Display the current user-agent and exit')
361 general.add_option(
362 '--list-extractors',
363 action='store_true', dest='list_extractors', default=False,
364 help='List all supported extractors and exit')
365 general.add_option(
366 '--extractor-descriptions',
367 action='store_true', dest='list_extractor_descriptions', default=False,
368 help='Output descriptions of all supported extractors and exit')
369 general.add_option(
370 '--use-extractors', '--ies',
371 action='callback', dest='allowed_extractors', metavar='NAMES', type='str',
372 default=[], callback=_list_from_options_callback,
373 help=(
374 'Extractor names to use separated by commas. '
375 'You can also use regexes, "all", "default" and "end" (end URL matching); '
376 'e.g. --ies "holodex.*,end,youtube". '
377 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
378 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
379 general.add_option(
380 '--force-generic-extractor',
381 action='store_true', dest='force_generic_extractor', default=False,
382 help=optparse.SUPPRESS_HELP)
383 general.add_option(
384 '--default-search',
385 dest='default_search', metavar='PREFIX',
386 help=(
387 'Use this prefix for unqualified URLs. '
388 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
389 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
390 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
391 'but emits an error if this is not possible instead of searching'))
392 general.add_option(
393 '--ignore-config', '--no-config',
394 action='store_true', dest='ignoreconfig',
395 help=(
396 'Don\'t load any more configuration files except those given to --config-locations. '
397 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
398 '(Alias: --no-config)'))
399 general.add_option(
400 '--no-config-locations',
401 action='store_const', dest='config_locations', const=[],
402 help=(
403 'Do not load any custom configuration files (default). When given inside a '
404 'configuration file, ignore all previous --config-locations defined in the current file'))
405 general.add_option(
406 '--config-locations',
407 dest='config_locations', metavar='PATH', action='append',
408 help=(
409 'Location of the main configuration file; either the path to the config or its containing directory '
410 '("-" for stdin). Can be used multiple times and inside other configuration files'))
411 general.add_option(
412 '--plugin-dirs',
413 dest='plugin_dirs', metavar='PATH', action='append',
414 help=(
415 'Path to an additional directory to search for plugins. '
416 'This option can be used multiple times to add multiple directories. '
417 'Note that this currently only works for extractor plugins; '
418 'postprocessor plugins can only be loaded from the default plugin directories'))
419 general.add_option(
420 '--flat-playlist',
421 action='store_const', dest='extract_flat', const='in_playlist', default=False,
422 help='Do not extract the videos of a playlist, only list them')
423 general.add_option(
424 '--no-flat-playlist',
425 action='store_false', dest='extract_flat',
426 help='Fully extract the videos of a playlist (default)')
427 general.add_option(
428 '--live-from-start',
429 action='store_true', dest='live_from_start',
430 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
431 general.add_option(
432 '--no-live-from-start',
433 action='store_false', dest='live_from_start',
434 help='Download livestreams from the current time (default)')
435 general.add_option(
436 '--wait-for-video',
437 dest='wait_for_video', metavar='MIN[-MAX]', default=None,
438 help=(
439 'Wait for scheduled streams to become available. '
440 'Pass the minimum number of seconds (or range) to wait between retries'))
441 general.add_option(
442 '--no-wait-for-video',
443 dest='wait_for_video', action='store_const', const=None,
444 help='Do not wait for scheduled streams (default)')
445 general.add_option(
446 '--mark-watched',
447 action='store_true', dest='mark_watched', default=False,
448 help='Mark videos watched (even with --simulate)')
449 general.add_option(
450 '--no-mark-watched',
451 action='store_false', dest='mark_watched',
452 help='Do not mark videos watched (default)')
453 general.add_option(
454 '--no-colors', '--no-colours',
455 action='store_const', dest='color', const={
456 'stdout': 'no_color',
457 'stderr': 'no_color',
459 help=optparse.SUPPRESS_HELP)
460 general.add_option(
461 '--color',
462 dest='color', metavar='[STREAM:]POLICY', default={}, type='str',
463 action='callback', callback=_dict_from_options_callback,
464 callback_kwargs={
465 'allowed_keys': 'stdout|stderr',
466 'default_key': ['stdout', 'stderr'],
467 'process': str.strip,
468 }, help=(
469 'Whether to emit color codes in output, optionally prefixed by '
470 'the STREAM (stdout or stderr) to apply the setting to. '
471 'Can be one of "always", "auto" (default), "never", or '
472 '"no_color" (use non color terminal sequences). '
473 'Use "auto-tty" or "no_color-tty" to decide based on terminal support only. '
474 'Can be used multiple times'))
475 general.add_option(
476 '--compat-options',
477 metavar='OPTS', dest='compat_opts', default=set(), type='str',
478 action='callback', callback=_set_from_options_callback,
479 callback_kwargs={
480 'allowed_values': {
481 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
482 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter',
483 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
484 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
485 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
486 'prefer-legacy-http-handler', 'manifest-filesize-approx', 'allow-unsafe-ext',
487 }, 'aliases': {
488 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext'],
489 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext'],
490 '2021': ['2022', 'no-certifi', 'filename-sanitization'],
491 '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler', 'manifest-filesize-approx'],
492 '2023': [],
494 }, help=(
495 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
496 'configurations by reverting some of the changes made in yt-dlp. '
497 'See "Differences in default behavior" for details'))
498 general.add_option(
499 '--alias', metavar='ALIASES OPTIONS', dest='_', type='str', nargs=2,
500 action='callback', callback=_create_alias,
501 help=(
502 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
503 'Arguments are parsed according to the Python string formatting mini-language. '
504 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
505 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
506 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
507 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
508 f'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
509 'This option can be used multiple times'))
511 network = optparse.OptionGroup(parser, 'Network Options')
512 network.add_option(
513 '--proxy', dest='proxy',
514 default=None, metavar='URL',
515 help=(
516 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
517 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
518 network.add_option(
519 '--socket-timeout',
520 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
521 help='Time to wait before giving up, in seconds')
522 network.add_option(
523 '--source-address',
524 metavar='IP', dest='source_address', default=None,
525 help='Client-side IP address to bind to',
527 network.add_option(
528 '--impersonate',
529 metavar='CLIENT[:OS]', dest='impersonate', default=None,
530 help=(
531 'Client to impersonate for requests. E.g. chrome, chrome-110, chrome:windows-10. '
532 'Pass --impersonate="" to impersonate any client. Note that forcing impersonation '
533 'for all requests may have a detrimental impact on download speed and stability'),
535 network.add_option(
536 '--list-impersonate-targets',
537 dest='list_impersonate_targets', default=False, action='store_true',
538 help='List available clients to impersonate.',
540 network.add_option(
541 '-4', '--force-ipv4',
542 action='store_const', const='0.0.0.0', dest='source_address',
543 help='Make all connections via IPv4',
545 network.add_option(
546 '-6', '--force-ipv6',
547 action='store_const', const='::', dest='source_address',
548 help='Make all connections via IPv6',
550 network.add_option(
551 '--enable-file-urls', action='store_true',
552 dest='enable_file_urls', default=False,
553 help='Enable file:// URLs. This is disabled by default for security reasons.',
556 geo = optparse.OptionGroup(parser, 'Geo-restriction')
557 geo.add_option(
558 '--geo-verification-proxy',
559 dest='geo_verification_proxy', default=None, metavar='URL',
560 help=(
561 'Use this proxy to verify the IP address for some geo-restricted sites. '
562 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
563 geo.add_option(
564 '--cn-verification-proxy',
565 dest='cn_verification_proxy', default=None, metavar='URL',
566 help=optparse.SUPPRESS_HELP)
567 geo.add_option(
568 '--xff', metavar='VALUE',
569 dest='geo_bypass', default='default',
570 help=(
571 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
572 'One of "default" (only when known to be useful), "never", '
573 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
574 geo.add_option(
575 '--geo-bypass',
576 action='store_const', dest='geo_bypass', const='default',
577 help=optparse.SUPPRESS_HELP)
578 geo.add_option(
579 '--no-geo-bypass',
580 action='store_const', dest='geo_bypass', const='never',
581 help=optparse.SUPPRESS_HELP)
582 geo.add_option(
583 '--geo-bypass-country', metavar='CODE', dest='geo_bypass',
584 help=optparse.SUPPRESS_HELP)
585 geo.add_option(
586 '--geo-bypass-ip-block', metavar='IP_BLOCK', dest='geo_bypass',
587 help=optparse.SUPPRESS_HELP)
589 selection = optparse.OptionGroup(parser, 'Video Selection')
590 selection.add_option(
591 '--playlist-start',
592 dest='playliststart', metavar='NUMBER', default=1, type=int,
593 help=optparse.SUPPRESS_HELP)
594 selection.add_option(
595 '--playlist-end',
596 dest='playlistend', metavar='NUMBER', default=None, type=int,
597 help=optparse.SUPPRESS_HELP)
598 selection.add_option(
599 '-I', '--playlist-items',
600 dest='playlist_items', metavar='ITEM_SPEC', default=None,
601 help=(
602 'Comma separated playlist_index of the items to download. '
603 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
604 'Use negative indices to count from the right and negative STEP to download in reverse order. '
605 'E.g. "-I 1:3,7,-5::2" used on a playlist of size 15 will download the items at index 1,2,3,7,11,13,15'))
606 selection.add_option(
607 '--match-title',
608 dest='matchtitle', metavar='REGEX',
609 help=optparse.SUPPRESS_HELP)
610 selection.add_option(
611 '--reject-title',
612 dest='rejecttitle', metavar='REGEX',
613 help=optparse.SUPPRESS_HELP)
614 selection.add_option(
615 '--min-filesize',
616 metavar='SIZE', dest='min_filesize', default=None,
617 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
618 selection.add_option(
619 '--max-filesize',
620 metavar='SIZE', dest='max_filesize', default=None,
621 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
622 selection.add_option(
623 '--date',
624 metavar='DATE', dest='date', default=None,
625 help=(
626 'Download only videos uploaded on this date. '
627 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
628 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
629 selection.add_option(
630 '--datebefore',
631 metavar='DATE', dest='datebefore', default=None,
632 help=(
633 'Download only videos uploaded on or before this date. '
634 'The date formats accepted is the same as --date'))
635 selection.add_option(
636 '--dateafter',
637 metavar='DATE', dest='dateafter', default=None,
638 help=(
639 'Download only videos uploaded on or after this date. '
640 'The date formats accepted is the same as --date'))
641 selection.add_option(
642 '--min-views',
643 metavar='COUNT', dest='min_views', default=None, type=int,
644 help=optparse.SUPPRESS_HELP)
645 selection.add_option(
646 '--max-views',
647 metavar='COUNT', dest='max_views', default=None, type=int,
648 help=optparse.SUPPRESS_HELP)
649 selection.add_option(
650 '--match-filters',
651 metavar='FILTER', dest='match_filter', action='append',
652 help=(
653 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
654 'number or a string using the operators defined in "Filtering Formats". '
655 'You can also simply specify a field to match if the field is present, '
656 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
657 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
658 'the filter matches if at least one of the conditions is met. E.g. --match-filters '
659 '!is_live --match-filters "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
660 'matches only videos that are not live OR those that have a like count more than 100 '
661 '(or the like field is not available) and also has a description '
662 'that contains the phrase "cats & dogs" (caseless). '
663 'Use "--match-filters -" to interactively ask whether to download each video'))
664 selection.add_option(
665 '--no-match-filters',
666 dest='match_filter', action='store_const', const=None,
667 help='Do not use any --match-filters (default)')
668 selection.add_option(
669 '--break-match-filters',
670 metavar='FILTER', dest='breaking_match_filter', action='append',
671 help='Same as "--match-filters" but stops the download process when a video is rejected')
672 selection.add_option(
673 '--no-break-match-filters',
674 dest='breaking_match_filter', action='store_const', const=None,
675 help='Do not use any --break-match-filters (default)')
676 selection.add_option(
677 '--no-playlist',
678 action='store_true', dest='noplaylist', default=False,
679 help='Download only the video, if the URL refers to a video and a playlist')
680 selection.add_option(
681 '--yes-playlist',
682 action='store_false', dest='noplaylist',
683 help='Download the playlist, if the URL refers to a video and a playlist')
684 selection.add_option(
685 '--age-limit',
686 metavar='YEARS', dest='age_limit', default=None, type=int,
687 help='Download only videos suitable for the given age')
688 selection.add_option(
689 '--download-archive', metavar='FILE',
690 dest='download_archive',
691 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
692 selection.add_option(
693 '--no-download-archive',
694 dest='download_archive', action='store_const', const=None,
695 help='Do not use archive file (default)')
696 selection.add_option(
697 '--max-downloads',
698 dest='max_downloads', metavar='NUMBER', type=int, default=None,
699 help='Abort after downloading NUMBER files')
700 selection.add_option(
701 '--break-on-existing',
702 action='store_true', dest='break_on_existing', default=False,
703 help='Stop the download process when encountering a file that is in the archive')
704 selection.add_option(
705 '--no-break-on-existing',
706 action='store_false', dest='break_on_existing',
707 help='Do not stop the download process when encountering a file that is in the archive (default)')
708 selection.add_option(
709 '--break-on-reject',
710 action='store_true', dest='break_on_reject', default=False,
711 help=optparse.SUPPRESS_HELP)
712 selection.add_option(
713 '--break-per-input',
714 action='store_true', dest='break_per_url', default=False,
715 help='Alters --max-downloads, --break-on-existing, --break-match-filters, and autonumber to reset per input URL')
716 selection.add_option(
717 '--no-break-per-input',
718 action='store_false', dest='break_per_url',
719 help='--break-on-existing and similar options terminates the entire download queue')
720 selection.add_option(
721 '--skip-playlist-after-errors', metavar='N',
722 dest='skip_playlist_after_errors', default=None, type=int,
723 help='Number of allowed failures until the rest of the playlist is skipped')
724 selection.add_option(
725 '--include-ads',
726 dest='include_ads', action='store_true',
727 help=optparse.SUPPRESS_HELP)
728 selection.add_option(
729 '--no-include-ads',
730 dest='include_ads', action='store_false',
731 help=optparse.SUPPRESS_HELP)
733 authentication = optparse.OptionGroup(parser, 'Authentication Options')
734 authentication.add_option(
735 '-u', '--username',
736 dest='username', metavar='USERNAME',
737 help='Login with this account ID')
738 authentication.add_option(
739 '-p', '--password',
740 dest='password', metavar='PASSWORD',
741 help='Account password. If this option is left out, yt-dlp will ask interactively')
742 authentication.add_option(
743 '-2', '--twofactor',
744 dest='twofactor', metavar='TWOFACTOR',
745 help='Two-factor authentication code')
746 authentication.add_option(
747 '-n', '--netrc',
748 action='store_true', dest='usenetrc', default=False,
749 help='Use .netrc authentication data')
750 authentication.add_option(
751 '--netrc-location',
752 dest='netrc_location', metavar='PATH',
753 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
754 authentication.add_option(
755 '--netrc-cmd',
756 dest='netrc_cmd', metavar='NETRC_CMD',
757 help='Command to execute to get the credentials for an extractor.')
758 authentication.add_option(
759 '--video-password',
760 dest='videopassword', metavar='PASSWORD',
761 help='Video-specific password')
762 authentication.add_option(
763 '--ap-mso',
764 dest='ap_mso', metavar='MSO',
765 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
766 authentication.add_option(
767 '--ap-username',
768 dest='ap_username', metavar='USERNAME',
769 help='Multiple-system operator account login')
770 authentication.add_option(
771 '--ap-password',
772 dest='ap_password', metavar='PASSWORD',
773 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
774 authentication.add_option(
775 '--ap-list-mso',
776 action='store_true', dest='ap_list_mso', default=False,
777 help='List all supported multiple-system operators')
778 authentication.add_option(
779 '--client-certificate',
780 dest='client_certificate', metavar='CERTFILE',
781 help='Path to client certificate file in PEM format. May include the private key')
782 authentication.add_option(
783 '--client-certificate-key',
784 dest='client_certificate_key', metavar='KEYFILE',
785 help='Path to private key file for client certificate')
786 authentication.add_option(
787 '--client-certificate-password',
788 dest='client_certificate_password', metavar='PASSWORD',
789 help='Password for client certificate private key, if encrypted. '
790 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
792 video_format = optparse.OptionGroup(parser, 'Video Format Options')
793 video_format.add_option(
794 '-f', '--format',
795 action='store', dest='format', metavar='FORMAT', default=None,
796 help='Video format code, see "FORMAT SELECTION" for more details')
797 video_format.add_option(
798 '-S', '--format-sort', metavar='SORTORDER',
799 dest='format_sort', default=[], type='str', action='callback',
800 callback=_list_from_options_callback, callback_kwargs={'append': -1},
801 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
802 video_format.add_option(
803 '--format-sort-force', '--S-force',
804 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
805 help=(
806 'Force user specified sort order to have precedence over all fields, '
807 'see "Sorting Formats" for more details (Alias: --S-force)'))
808 video_format.add_option(
809 '--no-format-sort-force',
810 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
811 help='Some fields have precedence over the user specified sort order (default)')
812 video_format.add_option(
813 '--video-multistreams',
814 action='store_true', dest='allow_multiple_video_streams', default=None,
815 help='Allow multiple video streams to be merged into a single file')
816 video_format.add_option(
817 '--no-video-multistreams',
818 action='store_false', dest='allow_multiple_video_streams',
819 help='Only one video stream is downloaded for each output file (default)')
820 video_format.add_option(
821 '--audio-multistreams',
822 action='store_true', dest='allow_multiple_audio_streams', default=None,
823 help='Allow multiple audio streams to be merged into a single file')
824 video_format.add_option(
825 '--no-audio-multistreams',
826 action='store_false', dest='allow_multiple_audio_streams',
827 help='Only one audio stream is downloaded for each output file (default)')
828 video_format.add_option(
829 '--all-formats',
830 action='store_const', dest='format', const='all',
831 help=optparse.SUPPRESS_HELP)
832 video_format.add_option(
833 '--prefer-free-formats',
834 action='store_true', dest='prefer_free_formats', default=False,
835 help=(
836 'Prefer video formats with free containers over non-free ones of same quality. '
837 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
838 video_format.add_option(
839 '--no-prefer-free-formats',
840 action='store_false', dest='prefer_free_formats', default=False,
841 help="Don't give any special preference to free containers (default)")
842 video_format.add_option(
843 '--check-formats',
844 action='store_const', const='selected', dest='check_formats', default=None,
845 help='Make sure formats are selected only from those that are actually downloadable')
846 video_format.add_option(
847 '--check-all-formats',
848 action='store_true', dest='check_formats',
849 help='Check all formats for whether they are actually downloadable')
850 video_format.add_option(
851 '--no-check-formats',
852 action='store_false', dest='check_formats',
853 help='Do not check that the formats are actually downloadable')
854 video_format.add_option(
855 '-F', '--list-formats',
856 action='store_true', dest='listformats',
857 help='List available formats of each video. Simulate unless --no-simulate is used')
858 video_format.add_option(
859 '--list-formats-as-table',
860 action='store_true', dest='listformats_table', default=True,
861 help=optparse.SUPPRESS_HELP)
862 video_format.add_option(
863 '--list-formats-old', '--no-list-formats-as-table',
864 action='store_false', dest='listformats_table',
865 help=optparse.SUPPRESS_HELP)
866 video_format.add_option(
867 '--merge-output-format',
868 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
869 help=(
870 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
871 'Ignored if no merge is required. '
872 f'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
873 video_format.add_option(
874 '--allow-unplayable-formats',
875 action='store_true', dest='allow_unplayable_formats', default=False,
876 help=optparse.SUPPRESS_HELP)
877 video_format.add_option(
878 '--no-allow-unplayable-formats',
879 action='store_false', dest='allow_unplayable_formats',
880 help=optparse.SUPPRESS_HELP)
882 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
883 subtitles.add_option(
884 '--write-subs', '--write-srt',
885 action='store_true', dest='writesubtitles', default=False,
886 help='Write subtitle file')
887 subtitles.add_option(
888 '--no-write-subs', '--no-write-srt',
889 action='store_false', dest='writesubtitles',
890 help='Do not write subtitle file (default)')
891 subtitles.add_option(
892 '--write-auto-subs', '--write-automatic-subs',
893 action='store_true', dest='writeautomaticsub', default=False,
894 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
895 subtitles.add_option(
896 '--no-write-auto-subs', '--no-write-automatic-subs',
897 action='store_false', dest='writeautomaticsub', default=False,
898 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
899 subtitles.add_option(
900 '--all-subs',
901 action='store_true', dest='allsubtitles', default=False,
902 help=optparse.SUPPRESS_HELP)
903 subtitles.add_option(
904 '--list-subs',
905 action='store_true', dest='listsubtitles', default=False,
906 help='List available subtitles of each video. Simulate unless --no-simulate is used')
907 subtitles.add_option(
908 '--sub-format',
909 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
910 help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"')
911 subtitles.add_option(
912 '--sub-langs', '--srt-langs',
913 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
914 default=[], callback=_list_from_options_callback,
915 help=(
916 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". '
917 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
918 'Use --list-subs for a list of available language tags'))
920 downloader = optparse.OptionGroup(parser, 'Download Options')
921 downloader.add_option(
922 '-N', '--concurrent-fragments',
923 dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
924 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
925 downloader.add_option(
926 '-r', '--limit-rate', '--rate-limit',
927 dest='ratelimit', metavar='RATE',
928 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
929 downloader.add_option(
930 '--throttled-rate',
931 dest='throttledratelimit', metavar='RATE',
932 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
933 downloader.add_option(
934 '-R', '--retries',
935 dest='retries', metavar='RETRIES', default=10,
936 help='Number of retries (default is %default), or "infinite"')
937 downloader.add_option(
938 '--file-access-retries',
939 dest='file_access_retries', metavar='RETRIES', default=3,
940 help='Number of times to retry on file access error (default is %default), or "infinite"')
941 downloader.add_option(
942 '--fragment-retries',
943 dest='fragment_retries', metavar='RETRIES', default=10,
944 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
945 downloader.add_option(
946 '--retry-sleep',
947 dest='retry_sleep', metavar='[TYPE:]EXPR', default={}, type='str',
948 action='callback', callback=_dict_from_options_callback,
949 callback_kwargs={
950 'allowed_keys': 'http|fragment|file_access|extractor',
951 'default_key': 'http',
952 }, help=(
953 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
954 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
955 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
956 'This option can be used multiple times to set the sleep for the different retry types, '
957 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
958 downloader.add_option(
959 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
960 action='store_true', dest='skip_unavailable_fragments', default=True,
961 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
962 downloader.add_option(
963 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
964 action='store_false', dest='skip_unavailable_fragments',
965 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
966 downloader.add_option(
967 '--keep-fragments',
968 action='store_true', dest='keep_fragments', default=False,
969 help='Keep downloaded fragments on disk after downloading is finished')
970 downloader.add_option(
971 '--no-keep-fragments',
972 action='store_false', dest='keep_fragments',
973 help='Delete downloaded fragments after downloading is finished (default)')
974 downloader.add_option(
975 '--buffer-size',
976 dest='buffersize', metavar='SIZE', default='1024',
977 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
978 downloader.add_option(
979 '--resize-buffer',
980 action='store_false', dest='noresizebuffer',
981 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
982 downloader.add_option(
983 '--no-resize-buffer',
984 action='store_true', dest='noresizebuffer', default=False,
985 help='Do not automatically adjust the buffer size')
986 downloader.add_option(
987 '--http-chunk-size',
988 dest='http_chunk_size', metavar='SIZE', default=None,
989 help=(
990 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
991 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
992 downloader.add_option(
993 '--test',
994 action='store_true', dest='test', default=False,
995 help=optparse.SUPPRESS_HELP)
996 downloader.add_option(
997 '--playlist-reverse',
998 action='store_true', dest='playlist_reverse',
999 help=optparse.SUPPRESS_HELP)
1000 downloader.add_option(
1001 '--no-playlist-reverse',
1002 action='store_false', dest='playlist_reverse',
1003 help=optparse.SUPPRESS_HELP)
1004 downloader.add_option(
1005 '--playlist-random',
1006 action='store_true', dest='playlist_random',
1007 help='Download playlist videos in random order')
1008 downloader.add_option(
1009 '--lazy-playlist',
1010 action='store_true', dest='lazy_playlist',
1011 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
1012 downloader.add_option(
1013 '--no-lazy-playlist',
1014 action='store_false', dest='lazy_playlist',
1015 help='Process videos in the playlist only after the entire playlist is parsed (default)')
1016 downloader.add_option(
1017 '--xattr-set-filesize',
1018 dest='xattr_set_filesize', action='store_true',
1019 help='Set file xattribute ytdl.filesize with expected file size')
1020 downloader.add_option(
1021 '--hls-prefer-native',
1022 dest='hls_prefer_native', action='store_true', default=None,
1023 help=optparse.SUPPRESS_HELP)
1024 downloader.add_option(
1025 '--hls-prefer-ffmpeg',
1026 dest='hls_prefer_native', action='store_false', default=None,
1027 help=optparse.SUPPRESS_HELP)
1028 downloader.add_option(
1029 '--hls-use-mpegts',
1030 dest='hls_use_mpegts', action='store_true', default=None,
1031 help=(
1032 'Use the mpegts container for HLS videos; '
1033 'allowing some players to play the video while downloading, '
1034 'and reducing the chance of file corruption if download is interrupted. '
1035 'This is enabled by default for live streams'))
1036 downloader.add_option(
1037 '--no-hls-use-mpegts',
1038 dest='hls_use_mpegts', action='store_false',
1039 help=(
1040 'Do not use the mpegts container for HLS videos. '
1041 'This is default when not downloading live streams'))
1042 downloader.add_option(
1043 '--download-sections',
1044 metavar='REGEX', dest='download_ranges', action='append',
1045 help=(
1046 'Download only chapters that match the regular expression. '
1047 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
1048 '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
1049 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1050 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1051 downloader.add_option(
1052 '--downloader', '--external-downloader',
1053 dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
1054 action='callback', callback=_dict_from_options_callback,
1055 callback_kwargs={
1056 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1057 'default_key': 'default',
1058 'process': str.strip,
1059 }, help=(
1060 'Name or path of the external downloader to use (optionally) prefixed by '
1061 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1062 f'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1063 'You can use this option multiple times to set different downloaders for different protocols. '
1064 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1065 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1066 '(Alias: --external-downloader)'))
1067 downloader.add_option(
1068 '--downloader-args', '--external-downloader-args',
1069 metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
1070 action='callback', callback=_dict_from_options_callback,
1071 callback_kwargs={
1072 'allowed_keys': r'ffmpeg_[io]\d*|{}'.format('|'.join(map(re.escape, list_external_downloaders()))),
1073 'default_key': 'default',
1074 'process': shlex.split,
1075 }, help=(
1076 'Give these arguments to the external downloader. '
1077 'Specify the downloader name and the arguments separated by a colon ":". '
1078 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1079 'You can use this option multiple times to give different arguments to different downloaders '
1080 '(Alias: --external-downloader-args)'))
1082 workarounds = optparse.OptionGroup(parser, 'Workarounds')
1083 workarounds.add_option(
1084 '--encoding',
1085 dest='encoding', metavar='ENCODING',
1086 help='Force the specified encoding (experimental)')
1087 workarounds.add_option(
1088 '--legacy-server-connect',
1089 action='store_true', dest='legacy_server_connect', default=False,
1090 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1091 workarounds.add_option(
1092 '--no-check-certificates',
1093 action='store_true', dest='no_check_certificate', default=False,
1094 help='Suppress HTTPS certificate validation')
1095 workarounds.add_option(
1096 '--prefer-insecure', '--prefer-unsecure',
1097 action='store_true', dest='prefer_insecure',
1098 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1099 workarounds.add_option(
1100 '--user-agent',
1101 metavar='UA', dest='user_agent',
1102 help=optparse.SUPPRESS_HELP)
1103 workarounds.add_option(
1104 '--referer',
1105 metavar='URL', dest='referer', default=None,
1106 help=optparse.SUPPRESS_HELP)
1107 workarounds.add_option(
1108 '--add-headers',
1109 metavar='FIELD:VALUE', dest='headers', default={}, type='str',
1110 action='callback', callback=_dict_from_options_callback,
1111 callback_kwargs={'multiple_keys': False},
1112 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1114 workarounds.add_option(
1115 '--bidi-workaround',
1116 dest='bidi_workaround', action='store_true',
1117 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1118 workarounds.add_option(
1119 '--sleep-requests', metavar='SECONDS',
1120 dest='sleep_interval_requests', type=float,
1121 help='Number of seconds to sleep between requests during data extraction')
1122 workarounds.add_option(
1123 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
1124 dest='sleep_interval', type=float,
1125 help=(
1126 'Number of seconds to sleep before each download. '
1127 'This is the minimum time to sleep when used along with --max-sleep-interval '
1128 '(Alias: --min-sleep-interval)'))
1129 workarounds.add_option(
1130 '--max-sleep-interval', metavar='SECONDS',
1131 dest='max_sleep_interval', type=float,
1132 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1133 workarounds.add_option(
1134 '--sleep-subtitles', metavar='SECONDS',
1135 dest='sleep_interval_subtitles', default=0, type=int,
1136 help='Number of seconds to sleep before each subtitle download')
1138 verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
1139 verbosity.add_option(
1140 '-q', '--quiet',
1141 action='store_true', dest='quiet', default=None,
1142 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1143 verbosity.add_option(
1144 '--no-quiet',
1145 action='store_false', dest='quiet',
1146 help='Deactivate quiet mode. (Default)')
1147 verbosity.add_option(
1148 '--no-warnings',
1149 dest='no_warnings', action='store_true', default=False,
1150 help='Ignore warnings')
1151 verbosity.add_option(
1152 '-s', '--simulate',
1153 action='store_true', dest='simulate', default=None,
1154 help='Do not download the video and do not write anything to disk')
1155 verbosity.add_option(
1156 '--no-simulate',
1157 action='store_false', dest='simulate',
1158 help='Download the video even if printing/listing options are used')
1159 verbosity.add_option(
1160 '--ignore-no-formats-error',
1161 action='store_true', dest='ignore_no_formats_error', default=False,
1162 help=(
1163 'Ignore "No video formats" error. Useful for extracting metadata '
1164 'even if the videos are not actually available for download (experimental)'))
1165 verbosity.add_option(
1166 '--no-ignore-no-formats-error',
1167 action='store_false', dest='ignore_no_formats_error',
1168 help='Throw error when no downloadable video formats are found (default)')
1169 verbosity.add_option(
1170 '--skip-download', '--no-download',
1171 action='store_true', dest='skip_download', default=False,
1172 help='Do not download the video but write all related files (Alias: --no-download)')
1173 verbosity.add_option(
1174 '-O', '--print',
1175 metavar='[WHEN:]TEMPLATE', dest='forceprint', **when_prefix('video'),
1176 help=(
1177 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1178 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1179 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1180 'This option can be used multiple times'))
1181 verbosity.add_option(
1182 '--print-to-file',
1183 metavar='[WHEN:]TEMPLATE FILE', dest='print_to_file', nargs=2, **when_prefix('video'),
1184 help=(
1185 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1186 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1187 verbosity.add_option(
1188 '-g', '--get-url',
1189 action='store_true', dest='geturl', default=False,
1190 help=optparse.SUPPRESS_HELP)
1191 verbosity.add_option(
1192 '-e', '--get-title',
1193 action='store_true', dest='gettitle', default=False,
1194 help=optparse.SUPPRESS_HELP)
1195 verbosity.add_option(
1196 '--get-id',
1197 action='store_true', dest='getid', default=False,
1198 help=optparse.SUPPRESS_HELP)
1199 verbosity.add_option(
1200 '--get-thumbnail',
1201 action='store_true', dest='getthumbnail', default=False,
1202 help=optparse.SUPPRESS_HELP)
1203 verbosity.add_option(
1204 '--get-description',
1205 action='store_true', dest='getdescription', default=False,
1206 help=optparse.SUPPRESS_HELP)
1207 verbosity.add_option(
1208 '--get-duration',
1209 action='store_true', dest='getduration', default=False,
1210 help=optparse.SUPPRESS_HELP)
1211 verbosity.add_option(
1212 '--get-filename',
1213 action='store_true', dest='getfilename', default=False,
1214 help=optparse.SUPPRESS_HELP)
1215 verbosity.add_option(
1216 '--get-format',
1217 action='store_true', dest='getformat', default=False,
1218 help=optparse.SUPPRESS_HELP)
1219 verbosity.add_option(
1220 '-j', '--dump-json',
1221 action='store_true', dest='dumpjson', default=False,
1222 help=(
1223 'Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. '
1224 'See "OUTPUT TEMPLATE" for a description of available keys'))
1225 verbosity.add_option(
1226 '-J', '--dump-single-json',
1227 action='store_true', dest='dump_single_json', default=False,
1228 help=(
1229 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1230 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1231 verbosity.add_option(
1232 '--print-json',
1233 action='store_true', dest='print_json', default=False,
1234 help=optparse.SUPPRESS_HELP)
1235 verbosity.add_option(
1236 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1237 action='store_true', dest='force_write_download_archive', default=False,
1238 help=(
1239 'Force download archive entries to be written as far as no errors occur, '
1240 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1241 verbosity.add_option(
1242 '--newline',
1243 action='store_true', dest='progress_with_newline', default=False,
1244 help='Output progress bar as new lines')
1245 verbosity.add_option(
1246 '--no-progress',
1247 action='store_true', dest='noprogress', default=None,
1248 help='Do not print progress bar')
1249 verbosity.add_option(
1250 '--progress',
1251 action='store_false', dest='noprogress',
1252 help='Show progress bar, even if in quiet mode')
1253 verbosity.add_option(
1254 '--console-title',
1255 action='store_true', dest='consoletitle', default=False,
1256 help='Display progress in console titlebar')
1257 verbosity.add_option(
1258 '--progress-template',
1259 metavar='[TYPES:]TEMPLATE', dest='progress_template', default={}, type='str',
1260 action='callback', callback=_dict_from_options_callback,
1261 callback_kwargs={
1262 'allowed_keys': '(download|postprocess)(-title)?',
1263 'default_key': 'download',
1264 }, help=(
1265 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1266 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1267 'The video\'s fields are accessible under the "info" key and '
1268 'the progress attributes are accessible under "progress" key. E.g. '
1269 # TODO: Document the fields inside "progress"
1270 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1271 verbosity.add_option(
1272 '--progress-delta',
1273 metavar='SECONDS', action='store', dest='progress_delta', type=float, default=0,
1274 help='Time between progress output (default: 0)')
1275 verbosity.add_option(
1276 '-v', '--verbose',
1277 action='store_true', dest='verbose', default=False,
1278 help='Print various debugging information')
1279 verbosity.add_option(
1280 '--dump-pages', '--dump-intermediate-pages',
1281 action='store_true', dest='dump_intermediate_pages', default=False,
1282 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1283 verbosity.add_option(
1284 '--write-pages',
1285 action='store_true', dest='write_pages', default=False,
1286 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1287 verbosity.add_option(
1288 '--load-pages',
1289 action='store_true', dest='load_pages', default=False,
1290 help=optparse.SUPPRESS_HELP)
1291 verbosity.add_option(
1292 '--youtube-print-sig-code',
1293 action='store_true', dest='youtube_print_sig_code', default=False,
1294 help=optparse.SUPPRESS_HELP)
1295 verbosity.add_option(
1296 '--print-traffic', '--dump-headers',
1297 dest='debug_printtraffic', action='store_true', default=False,
1298 help='Display sent and read HTTP traffic')
1299 verbosity.add_option(
1300 '-C', '--call-home',
1301 dest='call_home', action='store_true', default=False,
1302 # help='Contact the yt-dlp server for debugging')
1303 help=optparse.SUPPRESS_HELP)
1304 verbosity.add_option(
1305 '--no-call-home',
1306 dest='call_home', action='store_false',
1307 # help='Do not contact the yt-dlp server for debugging (default)')
1308 help=optparse.SUPPRESS_HELP)
1310 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
1311 filesystem.add_option(
1312 '-a', '--batch-file',
1313 dest='batchfile', metavar='FILE',
1314 help=(
1315 'File containing URLs to download ("-" for stdin), one URL per line. '
1316 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1317 filesystem.add_option(
1318 '--no-batch-file',
1319 dest='batchfile', action='store_const', const=None,
1320 help='Do not read URLs from batch file (default)')
1321 filesystem.add_option(
1322 '--id', default=False,
1323 action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
1324 filesystem.add_option(
1325 '-P', '--paths',
1326 metavar='[TYPES:]PATH', dest='paths', default={}, type='str',
1327 action='callback', callback=_dict_from_options_callback,
1328 callback_kwargs={
1329 'allowed_keys': 'home|temp|{}'.format('|'.join(map(re.escape, OUTTMPL_TYPES.keys()))),
1330 'default_key': 'home',
1331 }, help=(
1332 'The paths where the files should be downloaded. '
1333 'Specify the type of file and the path separated by a colon ":". '
1334 'All the same TYPES as --output are supported. '
1335 'Additionally, you can also provide "home" (default) and "temp" paths. '
1336 'All intermediary files are first downloaded to the temp path and '
1337 'then the final files are moved over to the home path after download is finished. '
1338 'This option is ignored if --output is an absolute path'))
1339 filesystem.add_option(
1340 '-o', '--output',
1341 metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
1342 action='callback', callback=_dict_from_options_callback,
1343 callback_kwargs={
1344 'allowed_keys': '|'.join(map(re.escape, OUTTMPL_TYPES.keys())),
1345 'default_key': 'default',
1346 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1347 filesystem.add_option(
1348 '--output-na-placeholder',
1349 dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
1350 help=('Placeholder for unavailable fields in --output (default: "%default")'))
1351 filesystem.add_option(
1352 '--autonumber-size',
1353 dest='autonumber_size', metavar='NUMBER', type=int,
1354 help=optparse.SUPPRESS_HELP)
1355 filesystem.add_option(
1356 '--autonumber-start',
1357 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
1358 help=optparse.SUPPRESS_HELP)
1359 filesystem.add_option(
1360 '--restrict-filenames',
1361 action='store_true', dest='restrictfilenames', default=False,
1362 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1363 filesystem.add_option(
1364 '--no-restrict-filenames',
1365 action='store_false', dest='restrictfilenames',
1366 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1367 filesystem.add_option(
1368 '--windows-filenames',
1369 action='store_true', dest='windowsfilenames', default=False,
1370 help='Force filenames to be Windows-compatible')
1371 filesystem.add_option(
1372 '--no-windows-filenames',
1373 action='store_false', dest='windowsfilenames',
1374 help='Make filenames Windows-compatible only if using Windows (default)')
1375 filesystem.add_option(
1376 '--trim-filenames', '--trim-file-names', metavar='LENGTH',
1377 dest='trim_file_name', default=0, type=int,
1378 help='Limit the filename length (excluding extension) to the specified number of characters')
1379 filesystem.add_option(
1380 '-w', '--no-overwrites',
1381 action='store_false', dest='overwrites', default=None,
1382 help='Do not overwrite any files')
1383 filesystem.add_option(
1384 '--force-overwrites', '--yes-overwrites',
1385 action='store_true', dest='overwrites',
1386 help='Overwrite all video and metadata files. This option includes --no-continue')
1387 filesystem.add_option(
1388 '--no-force-overwrites',
1389 action='store_const', dest='overwrites', const=None,
1390 help='Do not overwrite the video, but overwrite related files (default)')
1391 filesystem.add_option(
1392 '-c', '--continue',
1393 action='store_true', dest='continue_dl', default=True,
1394 help='Resume partially downloaded files/fragments (default)')
1395 filesystem.add_option(
1396 '--no-continue',
1397 action='store_false', dest='continue_dl',
1398 help=(
1399 'Do not resume partially downloaded fragments. '
1400 'If the file is not fragmented, restart download of the entire file'))
1401 filesystem.add_option(
1402 '--part',
1403 action='store_false', dest='nopart', default=False,
1404 help='Use .part files instead of writing directly into output file (default)')
1405 filesystem.add_option(
1406 '--no-part',
1407 action='store_true', dest='nopart',
1408 help='Do not use .part files - write directly into output file')
1409 filesystem.add_option(
1410 '--mtime',
1411 action='store_true', dest='updatetime', default=True,
1412 help='Use the Last-modified header to set the file modification time (default)')
1413 filesystem.add_option(
1414 '--no-mtime',
1415 action='store_false', dest='updatetime',
1416 help='Do not use the Last-modified header to set the file modification time')
1417 filesystem.add_option(
1418 '--write-description',
1419 action='store_true', dest='writedescription', default=False,
1420 help='Write video description to a .description file')
1421 filesystem.add_option(
1422 '--no-write-description',
1423 action='store_false', dest='writedescription',
1424 help='Do not write video description (default)')
1425 filesystem.add_option(
1426 '--write-info-json',
1427 action='store_true', dest='writeinfojson', default=None,
1428 help='Write video metadata to a .info.json file (this may contain personal information)')
1429 filesystem.add_option(
1430 '--no-write-info-json',
1431 action='store_false', dest='writeinfojson',
1432 help='Do not write video metadata (default)')
1433 filesystem.add_option(
1434 '--write-annotations',
1435 action='store_true', dest='writeannotations', default=False,
1436 help=optparse.SUPPRESS_HELP)
1437 filesystem.add_option(
1438 '--no-write-annotations',
1439 action='store_false', dest='writeannotations',
1440 help=optparse.SUPPRESS_HELP)
1441 filesystem.add_option(
1442 '--write-playlist-metafiles',
1443 action='store_true', dest='allow_playlist_files', default=None,
1444 help=(
1445 'Write playlist metadata in addition to the video metadata '
1446 'when using --write-info-json, --write-description etc. (default)'))
1447 filesystem.add_option(
1448 '--no-write-playlist-metafiles',
1449 action='store_false', dest='allow_playlist_files',
1450 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1451 filesystem.add_option(
1452 '--clean-info-json', '--clean-infojson',
1453 action='store_true', dest='clean_infojson', default=None,
1454 help=(
1455 'Remove some internal metadata such as filenames from the infojson (default)'))
1456 filesystem.add_option(
1457 '--no-clean-info-json', '--no-clean-infojson',
1458 action='store_false', dest='clean_infojson',
1459 help='Write all fields to the infojson')
1460 filesystem.add_option(
1461 '--write-comments', '--get-comments',
1462 action='store_true', dest='getcomments', default=False,
1463 help=(
1464 'Retrieve video comments to be placed in the infojson. '
1465 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1466 filesystem.add_option(
1467 '--no-write-comments', '--no-get-comments',
1468 action='store_false', dest='getcomments',
1469 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1470 filesystem.add_option(
1471 '--load-info-json', '--load-info',
1472 dest='load_info_filename', metavar='FILE',
1473 help='JSON file containing the video information (created with the "--write-info-json" option)')
1474 filesystem.add_option(
1475 '--cookies',
1476 dest='cookiefile', metavar='FILE',
1477 help='Netscape formatted file to read cookies from and dump cookie jar in')
1478 filesystem.add_option(
1479 '--no-cookies',
1480 action='store_const', const=None, dest='cookiefile', metavar='FILE',
1481 help='Do not read/dump cookies from/to file (default)')
1482 filesystem.add_option(
1483 '--cookies-from-browser',
1484 dest='cookiesfrombrowser', metavar='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1485 help=(
1486 'The name of the browser to load cookies from. '
1487 f'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1488 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1489 'the name/path of the PROFILE to load cookies from, '
1490 'and the CONTAINER name (if Firefox) ("none" for no container) '
1491 'can be given with their respective separators. '
1492 'By default, all containers of the most recently accessed profile are used. '
1493 f'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1494 filesystem.add_option(
1495 '--no-cookies-from-browser',
1496 action='store_const', const=None, dest='cookiesfrombrowser',
1497 help='Do not load cookies from browser (default)')
1498 filesystem.add_option(
1499 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
1500 help=(
1501 'Location in the filesystem where yt-dlp can store some downloaded information '
1502 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1503 filesystem.add_option(
1504 '--no-cache-dir', action='store_false', dest='cachedir',
1505 help='Disable filesystem caching')
1506 filesystem.add_option(
1507 '--rm-cache-dir',
1508 action='store_true', dest='rm_cachedir',
1509 help='Delete all filesystem cache files')
1511 thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options')
1512 thumbnail.add_option(
1513 '--write-thumbnail',
1514 action='callback', dest='writethumbnail', default=False,
1515 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1516 callback=lambda option, _, __, parser: setattr(
1517 parser.values, option.dest, getattr(parser.values, option.dest) or True),
1518 help='Write thumbnail image to disk')
1519 thumbnail.add_option(
1520 '--no-write-thumbnail',
1521 action='store_false', dest='writethumbnail',
1522 help='Do not write thumbnail image to disk (default)')
1523 thumbnail.add_option(
1524 '--write-all-thumbnails',
1525 action='store_const', dest='writethumbnail', const='all',
1526 help='Write all thumbnail image formats to disk')
1527 thumbnail.add_option(
1528 '--list-thumbnails',
1529 action='store_true', dest='list_thumbnails', default=False,
1530 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1532 link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
1533 link.add_option(
1534 '--write-link',
1535 action='store_true', dest='writelink', default=False,
1536 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1537 link.add_option(
1538 '--write-url-link',
1539 action='store_true', dest='writeurllink', default=False,
1540 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1541 link.add_option(
1542 '--write-webloc-link',
1543 action='store_true', dest='writewebloclink', default=False,
1544 help='Write a .webloc macOS internet shortcut')
1545 link.add_option(
1546 '--write-desktop-link',
1547 action='store_true', dest='writedesktoplink', default=False,
1548 help='Write a .desktop Linux internet shortcut')
1550 postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
1551 postproc.add_option(
1552 '-x', '--extract-audio',
1553 action='store_true', dest='extractaudio', default=False,
1554 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1555 postproc.add_option(
1556 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
1557 help=(
1558 'Format to convert the audio to when -x is used. '
1559 f'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1560 'You can specify multiple rules using similar syntax as --remux-video'))
1561 postproc.add_option(
1562 '--audio-quality', metavar='QUALITY',
1563 dest='audioquality', default='5',
1564 help=(
1565 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1566 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1567 postproc.add_option(
1568 '--remux-video',
1569 metavar='FORMAT', dest='remuxvideo', default=None,
1570 help=(
1571 'Remux the video into another container if necessary '
1572 f'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1573 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1574 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1575 postproc.add_option(
1576 '--recode-video',
1577 metavar='FORMAT', dest='recodevideo', default=None,
1578 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1579 postproc.add_option(
1580 '--postprocessor-args', '--ppa',
1581 metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
1582 action='callback', callback=_dict_from_options_callback,
1583 callback_kwargs={
1584 'allowed_keys': r'\w+(?:\+\w+)?',
1585 'default_key': 'default-compat',
1586 'process': shlex.split,
1587 'multiple_keys': False,
1588 }, help=(
1589 'Give these arguments to the postprocessors. '
1590 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1591 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1592 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1593 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1594 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1595 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1596 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1597 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1598 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1599 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1600 'You can use this option multiple times to give different arguments to different '
1601 'postprocessors. (Alias: --ppa)'))
1602 postproc.add_option(
1603 '-k', '--keep-video',
1604 action='store_true', dest='keepvideo', default=False,
1605 help='Keep the intermediate video file on disk after post-processing')
1606 postproc.add_option(
1607 '--no-keep-video',
1608 action='store_false', dest='keepvideo',
1609 help='Delete the intermediate video file after post-processing (default)')
1610 postproc.add_option(
1611 '--post-overwrites',
1612 action='store_false', dest='nopostoverwrites',
1613 help='Overwrite post-processed files (default)')
1614 postproc.add_option(
1615 '--no-post-overwrites',
1616 action='store_true', dest='nopostoverwrites', default=False,
1617 help='Do not overwrite post-processed files')
1618 postproc.add_option(
1619 '--embed-subs',
1620 action='store_true', dest='embedsubtitles', default=False,
1621 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1622 postproc.add_option(
1623 '--no-embed-subs',
1624 action='store_false', dest='embedsubtitles',
1625 help='Do not embed subtitles (default)')
1626 postproc.add_option(
1627 '--embed-thumbnail',
1628 action='store_true', dest='embedthumbnail', default=False,
1629 help='Embed thumbnail in the video as cover art')
1630 postproc.add_option(
1631 '--no-embed-thumbnail',
1632 action='store_false', dest='embedthumbnail',
1633 help='Do not embed thumbnail (default)')
1634 postproc.add_option(
1635 '--embed-metadata', '--add-metadata',
1636 action='store_true', dest='addmetadata', default=False,
1637 help=(
1638 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1639 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1640 postproc.add_option(
1641 '--no-embed-metadata', '--no-add-metadata',
1642 action='store_false', dest='addmetadata',
1643 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1644 postproc.add_option(
1645 '--embed-chapters', '--add-chapters',
1646 action='store_true', dest='addchapters', default=None,
1647 help='Add chapter markers to the video file (Alias: --add-chapters)')
1648 postproc.add_option(
1649 '--no-embed-chapters', '--no-add-chapters',
1650 action='store_false', dest='addchapters',
1651 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1652 postproc.add_option(
1653 '--embed-info-json',
1654 action='store_true', dest='embed_infojson', default=None,
1655 help='Embed the infojson as an attachment to mkv/mka video files')
1656 postproc.add_option(
1657 '--no-embed-info-json',
1658 action='store_false', dest='embed_infojson',
1659 help='Do not embed the infojson as an attachment to the video file')
1660 postproc.add_option(
1661 '--metadata-from-title',
1662 metavar='FORMAT', dest='metafromtitle',
1663 help=optparse.SUPPRESS_HELP)
1664 postproc.add_option(
1665 '--parse-metadata',
1666 metavar='[WHEN:]FROM:TO', dest='parse_metadata', **when_prefix('pre_process'),
1667 help=(
1668 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1669 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1670 postproc.add_option(
1671 '--replace-in-metadata',
1672 dest='parse_metadata', metavar='[WHEN:]FIELDS REGEX REPLACE', nargs=3, **when_prefix('pre_process'),
1673 help=(
1674 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1675 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1676 postproc.add_option(
1677 '--xattrs', '--xattr',
1678 action='store_true', dest='xattrs', default=False,
1679 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1680 postproc.add_option(
1681 '--concat-playlist',
1682 metavar='POLICY', dest='concat_playlist', default='multi_video',
1683 choices=('never', 'always', 'multi_video'),
1684 help=(
1685 'Concatenate videos in a playlist. One of "never", "always", or '
1686 '"multi_video" (default; only when the videos form a single show). '
1687 'All the video files must have same codecs and number of streams to be concatable. '
1688 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1689 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1690 postproc.add_option(
1691 '--fixup',
1692 metavar='POLICY', dest='fixup', default=None,
1693 choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1694 help=(
1695 'Automatically correct known faults of the file. '
1696 'One of never (do nothing), warn (only emit a warning), '
1697 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1698 'force (try fixing even if file already exists)'))
1699 postproc.add_option(
1700 '--prefer-avconv', '--no-prefer-ffmpeg',
1701 action='store_false', dest='prefer_ffmpeg',
1702 help=optparse.SUPPRESS_HELP)
1703 postproc.add_option(
1704 '--prefer-ffmpeg', '--no-prefer-avconv',
1705 action='store_true', dest='prefer_ffmpeg', default=True,
1706 help=optparse.SUPPRESS_HELP)
1707 postproc.add_option(
1708 '--ffmpeg-location', '--avconv-location', metavar='PATH',
1709 dest='ffmpeg_location',
1710 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1711 postproc.add_option(
1712 '--exec',
1713 metavar='[WHEN:]CMD', dest='exec_cmd', **when_prefix('after_move'),
1714 help=(
1715 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1716 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1717 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1718 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1719 'This option can be used multiple times'))
1720 postproc.add_option(
1721 '--no-exec',
1722 action='store_const', dest='exec_cmd', const={},
1723 help='Remove any previously defined --exec')
1724 postproc.add_option(
1725 '--exec-before-download', metavar='CMD',
1726 action='append', dest='exec_before_dl_cmd',
1727 help=optparse.SUPPRESS_HELP)
1728 postproc.add_option(
1729 '--no-exec-before-download',
1730 action='store_const', dest='exec_before_dl_cmd', const=None,
1731 help=optparse.SUPPRESS_HELP)
1732 postproc.add_option(
1733 '--convert-subs', '--convert-sub', '--convert-subtitles',
1734 metavar='FORMAT', dest='convertsubtitles', default=None,
1735 help=(
1736 'Convert the subtitles to another format '
1737 f'(currently supported: {", ".join(sorted(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS))}). '
1738 'Use "--convert-subs none" to disable conversion (default) (Alias: --convert-subtitles)'))
1739 postproc.add_option(
1740 '--convert-thumbnails',
1741 metavar='FORMAT', dest='convertthumbnails', default=None,
1742 help=(
1743 'Convert the thumbnails to another format '
1744 f'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1745 'You can specify multiple rules using similar syntax as "--remux-video". '
1746 'Use "--convert-thumbnails none" to disable conversion (default)'))
1747 postproc.add_option(
1748 '--split-chapters', '--split-tracks',
1749 dest='split_chapters', action='store_true', default=False,
1750 help=(
1751 'Split video into multiple files based on internal chapters. '
1752 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1753 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1754 postproc.add_option(
1755 '--no-split-chapters', '--no-split-tracks',
1756 dest='split_chapters', action='store_false',
1757 help='Do not split video based on chapters (default)')
1758 postproc.add_option(
1759 '--remove-chapters',
1760 metavar='REGEX', dest='remove_chapters', action='append',
1761 help=(
1762 'Remove chapters whose title matches the given regular expression. '
1763 'The syntax is the same as --download-sections. This option can be used multiple times'))
1764 postproc.add_option(
1765 '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None,
1766 help='Do not remove any chapters from the file (default)')
1767 postproc.add_option(
1768 '--force-keyframes-at-cuts',
1769 action='store_true', dest='force_keyframes_at_cuts', default=False,
1770 help=(
1771 'Force keyframes at cuts when downloading/splitting/removing sections. '
1772 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1773 postproc.add_option(
1774 '--no-force-keyframes-at-cuts',
1775 action='store_false', dest='force_keyframes_at_cuts',
1776 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1777 _postprocessor_opts_parser = lambda key, val='': (
1778 *(item.split('=', 1) for item in (val.split(';') if val else [])),
1779 ('key', remove_end(key, 'PP')))
1780 postproc.add_option(
1781 '--use-postprocessor',
1782 metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str',
1783 action='callback', callback=_list_from_options_callback,
1784 callback_kwargs={
1785 'delim': None,
1786 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1))),
1787 }, help=(
1788 'The (case sensitive) name of plugin postprocessors to be enabled, '
1789 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1790 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1791 'The "when" argument determines when the postprocessor is invoked. '
1792 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1793 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1794 '"post_process" (after each video download; default), '
1795 '"after_move" (after moving video file to its final locations), '
1796 '"after_video" (after downloading and processing all formats of a video), '
1797 'or "playlist" (at end of playlist). '
1798 'This option can be used multiple times to add different postprocessors'))
1800 sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=(
1801 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1802 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1803 sponsorblock.add_option(
1804 '--sponsorblock-mark', metavar='CATS',
1805 dest='sponsorblock_mark', default=set(), action='callback', type='str',
1806 callback=_set_from_options_callback, callback_kwargs={
1807 'allowed_values': SponsorBlockPP.CATEGORIES.keys(),
1808 'aliases': {'default': ['all']},
1809 }, help=(
1810 'SponsorBlock categories to create chapters for, separated by commas. '
1811 f'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1812 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
1813 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1814 sponsorblock.add_option(
1815 '--sponsorblock-remove', metavar='CATS',
1816 dest='sponsorblock_remove', default=set(), action='callback', type='str',
1817 callback=_set_from_options_callback, callback_kwargs={
1818 'allowed_values': set(SponsorBlockPP.CATEGORIES.keys()) - set(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys()),
1819 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1820 # The filler category is very aggressive.
1821 # It is strongly recommended to not use this in a client by default.
1822 'aliases': {'default': ['all', '-filler']},
1823 }, help=(
1824 'SponsorBlock categories to be removed from the video file, separated by commas. '
1825 'If a category is present in both mark and remove, remove takes precedence. '
1826 'The syntax and available categories are the same as for --sponsorblock-mark '
1827 'except that "default" refers to "all,-filler" '
1828 f'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1829 sponsorblock.add_option(
1830 '--sponsorblock-chapter-title', metavar='TEMPLATE',
1831 default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title',
1832 help=(
1833 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1834 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1835 'Defaults to "%default"'))
1836 sponsorblock.add_option(
1837 '--no-sponsorblock', default=False,
1838 action='store_true', dest='no_sponsorblock',
1839 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1840 sponsorblock.add_option(
1841 '--sponsorblock-api', metavar='URL',
1842 default='https://sponsor.ajay.app', dest='sponsorblock_api',
1843 help='SponsorBlock API location, defaults to %default')
1845 sponsorblock.add_option(
1846 '--sponskrub',
1847 action='store_true', dest='sponskrub', default=False,
1848 help=optparse.SUPPRESS_HELP)
1849 sponsorblock.add_option(
1850 '--no-sponskrub',
1851 action='store_false', dest='sponskrub',
1852 help=optparse.SUPPRESS_HELP)
1853 sponsorblock.add_option(
1854 '--sponskrub-cut', default=False,
1855 action='store_true', dest='sponskrub_cut',
1856 help=optparse.SUPPRESS_HELP)
1857 sponsorblock.add_option(
1858 '--no-sponskrub-cut',
1859 action='store_false', dest='sponskrub_cut',
1860 help=optparse.SUPPRESS_HELP)
1861 sponsorblock.add_option(
1862 '--sponskrub-force', default=False,
1863 action='store_true', dest='sponskrub_force',
1864 help=optparse.SUPPRESS_HELP)
1865 sponsorblock.add_option(
1866 '--no-sponskrub-force',
1867 action='store_true', dest='sponskrub_force',
1868 help=optparse.SUPPRESS_HELP)
1869 sponsorblock.add_option(
1870 '--sponskrub-location', metavar='PATH',
1871 dest='sponskrub_path', default='',
1872 help=optparse.SUPPRESS_HELP)
1873 sponsorblock.add_option(
1874 '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1875 help=optparse.SUPPRESS_HELP)
1877 extractor = optparse.OptionGroup(parser, 'Extractor Options')
1878 extractor.add_option(
1879 '--extractor-retries',
1880 dest='extractor_retries', metavar='RETRIES', default=3,
1881 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1882 extractor.add_option(
1883 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1884 action='store_true', dest='dynamic_mpd', default=True,
1885 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1886 extractor.add_option(
1887 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1888 action='store_false', dest='dynamic_mpd',
1889 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1890 extractor.add_option(
1891 '--hls-split-discontinuity',
1892 dest='hls_split_discontinuity', action='store_true', default=False,
1893 help='Split HLS playlists to different formats at discontinuities such as ad breaks',
1895 extractor.add_option(
1896 '--no-hls-split-discontinuity',
1897 dest='hls_split_discontinuity', action='store_false',
1898 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1899 _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [
1900 val.replace(r'\,', ',').strip() for val in re.split(r'(?<!\\),', vals)])
1901 extractor.add_option(
1902 '--extractor-args',
1903 metavar='IE_KEY:ARGS', dest='extractor_args', default={}, type='str',
1904 action='callback', callback=_dict_from_options_callback,
1905 callback_kwargs={
1906 'multiple_keys': False,
1907 'process': lambda val: dict(
1908 _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';')),
1909 }, help=(
1910 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1911 'You can use this option multiple times to give arguments for different extractors'))
1912 extractor.add_option(
1913 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1914 action='store_true', dest='youtube_include_dash_manifest', default=True,
1915 help=optparse.SUPPRESS_HELP)
1916 extractor.add_option(
1917 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1918 action='store_false', dest='youtube_include_dash_manifest',
1919 help=optparse.SUPPRESS_HELP)
1920 extractor.add_option(
1921 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1922 action='store_true', dest='youtube_include_hls_manifest', default=True,
1923 help=optparse.SUPPRESS_HELP)
1924 extractor.add_option(
1925 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1926 action='store_false', dest='youtube_include_hls_manifest',
1927 help=optparse.SUPPRESS_HELP)
1929 parser.add_option_group(general)
1930 parser.add_option_group(network)
1931 parser.add_option_group(geo)
1932 parser.add_option_group(selection)
1933 parser.add_option_group(downloader)
1934 parser.add_option_group(filesystem)
1935 parser.add_option_group(thumbnail)
1936 parser.add_option_group(link)
1937 parser.add_option_group(verbosity)
1938 parser.add_option_group(workarounds)
1939 parser.add_option_group(video_format)
1940 parser.add_option_group(subtitles)
1941 parser.add_option_group(authentication)
1942 parser.add_option_group(postproc)
1943 parser.add_option_group(sponsorblock)
1944 parser.add_option_group(extractor)
1946 return parser
1949 def _hide_login_info(opts):
1950 deprecation_warning(f'"{__name__}._hide_login_info" is deprecated and may be removed '
1951 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1952 return Config.hide_login_info(opts)