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