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