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