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