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 'Use "--match-filter -" to interactively ask whether to download each video'))
476 selection
.add_option(
478 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
479 help='Do not use generic video filter (default)')
480 selection
.add_option(
482 action
='store_true', dest
='noplaylist', default
=False,
483 help='Download only the video, if the URL refers to a video and a playlist')
484 selection
.add_option(
486 action
='store_false', dest
='noplaylist',
487 help='Download the playlist, if the URL refers to a video and a playlist')
488 selection
.add_option(
490 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
491 help='Download only videos suitable for the given age')
492 selection
.add_option(
493 '--download-archive', metavar
='FILE',
494 dest
='download_archive',
495 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
496 selection
.add_option(
497 '--no-download-archive',
498 dest
='download_archive', action
="store_const", const
=None,
499 help='Do not use archive file (default)')
500 selection
.add_option(
502 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
503 help='Abort after downloading NUMBER files')
504 selection
.add_option(
505 '--break-on-existing',
506 action
='store_true', dest
='break_on_existing', default
=False,
507 help='Stop the download process when encountering a file that is in the archive')
508 selection
.add_option(
510 action
='store_true', dest
='break_on_reject', default
=False,
511 help='Stop the download process when encountering a file that has been filtered out')
512 selection
.add_option(
514 action
='store_true', dest
='break_per_url', default
=False,
515 help='Make --break-on-existing and --break-on-reject act only on the current input URL')
516 selection
.add_option(
517 '--no-break-per-input',
518 action
='store_false', dest
='break_per_url',
519 help='--break-on-existing and --break-on-reject terminates the entire download queue')
520 selection
.add_option(
521 '--skip-playlist-after-errors', metavar
='N',
522 dest
='skip_playlist_after_errors', default
=None, type=int,
523 help='Number of allowed failures until the rest of the playlist is skipped')
524 selection
.add_option(
526 dest
='include_ads', action
='store_true',
527 help=optparse
.SUPPRESS_HELP
)
528 selection
.add_option(
530 dest
='include_ads', action
='store_false',
531 help=optparse
.SUPPRESS_HELP
)
533 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
534 authentication
.add_option(
536 dest
='username', metavar
='USERNAME',
537 help='Login with this account ID')
538 authentication
.add_option(
540 dest
='password', metavar
='PASSWORD',
541 help='Account password. If this option is left out, yt-dlp will ask interactively')
542 authentication
.add_option(
544 dest
='twofactor', metavar
='TWOFACTOR',
545 help='Two-factor authentication code')
546 authentication
.add_option(
548 action
='store_true', dest
='usenetrc', default
=False,
549 help='Use .netrc authentication data')
550 authentication
.add_option(
552 dest
='netrc_location', metavar
='PATH',
553 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
554 authentication
.add_option(
556 dest
='videopassword', metavar
='PASSWORD',
557 help='Video password (vimeo, youku)')
558 authentication
.add_option(
560 dest
='ap_mso', metavar
='MSO',
561 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
562 authentication
.add_option(
564 dest
='ap_username', metavar
='USERNAME',
565 help='Multiple-system operator account login')
566 authentication
.add_option(
568 dest
='ap_password', metavar
='PASSWORD',
569 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
570 authentication
.add_option(
572 action
='store_true', dest
='ap_list_mso', default
=False,
573 help='List all supported multiple-system operators')
575 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
576 video_format
.add_option(
578 action
='store', dest
='format', metavar
='FORMAT', default
=None,
579 help='Video format code, see "FORMAT SELECTION" for more details')
580 video_format
.add_option(
581 '-S', '--format-sort', metavar
='SORTORDER',
582 dest
='format_sort', default
=[], type='str', action
='callback',
583 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
584 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
585 video_format
.add_option(
586 '--format-sort-force', '--S-force',
587 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
589 'Force user specified sort order to have precedence over all fields, '
590 'see "Sorting Formats" for more details'))
591 video_format
.add_option(
592 '--no-format-sort-force',
593 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
595 'Some fields have precedence over the user specified sort order (default), '
596 'see "Sorting Formats" for more details'))
597 video_format
.add_option(
598 '--video-multistreams',
599 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
600 help='Allow multiple video streams to be merged into a single file')
601 video_format
.add_option(
602 '--no-video-multistreams',
603 action
='store_false', dest
='allow_multiple_video_streams',
604 help='Only one video stream is downloaded for each output file (default)')
605 video_format
.add_option(
606 '--audio-multistreams',
607 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
608 help='Allow multiple audio streams to be merged into a single file')
609 video_format
.add_option(
610 '--no-audio-multistreams',
611 action
='store_false', dest
='allow_multiple_audio_streams',
612 help='Only one audio stream is downloaded for each output file (default)')
613 video_format
.add_option(
615 action
='store_const', dest
='format', const
='all',
616 help=optparse
.SUPPRESS_HELP
)
617 video_format
.add_option(
618 '--prefer-free-formats',
619 action
='store_true', dest
='prefer_free_formats', default
=False,
621 'Prefer video formats with free containers over non-free ones of same quality. '
622 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
623 video_format
.add_option(
624 '--no-prefer-free-formats',
625 action
='store_false', dest
='prefer_free_formats', default
=False,
626 help="Don't give any special preference to free containers (default)")
627 video_format
.add_option(
629 action
='store_const', const
='selected', dest
='check_formats', default
=None,
630 help='Make sure formats are selected only from those that are actually downloadable')
631 video_format
.add_option(
632 '--check-all-formats',
633 action
='store_true', dest
='check_formats',
634 help='Check all formats for whether they are actually downloadable')
635 video_format
.add_option(
636 '--no-check-formats',
637 action
='store_false', dest
='check_formats',
638 help='Do not check that the formats are actually downloadable')
639 video_format
.add_option(
640 '-F', '--list-formats',
641 action
='store_true', dest
='listformats',
642 help='List available formats of each video. Simulate unless --no-simulate is used')
643 video_format
.add_option(
644 '--list-formats-as-table',
645 action
='store_true', dest
='listformats_table', default
=True,
646 help=optparse
.SUPPRESS_HELP
)
647 video_format
.add_option(
648 '--list-formats-old', '--no-list-formats-as-table',
649 action
='store_false', dest
='listformats_table',
650 help=optparse
.SUPPRESS_HELP
)
651 video_format
.add_option(
652 '--merge-output-format',
653 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
655 'If a merge is required (e.g. bestvideo+bestaudio), '
656 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
657 'Ignored if no merge is required'))
658 video_format
.add_option(
659 '--allow-unplayable-formats',
660 action
='store_true', dest
='allow_unplayable_formats', default
=False,
661 help=optparse
.SUPPRESS_HELP
)
662 video_format
.add_option(
663 '--no-allow-unplayable-formats',
664 action
='store_false', dest
='allow_unplayable_formats',
665 help=optparse
.SUPPRESS_HELP
)
667 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
668 subtitles
.add_option(
669 '--write-subs', '--write-srt',
670 action
='store_true', dest
='writesubtitles', default
=False,
671 help='Write subtitle file')
672 subtitles
.add_option(
673 '--no-write-subs', '--no-write-srt',
674 action
='store_false', dest
='writesubtitles',
675 help='Do not write subtitle file (default)')
676 subtitles
.add_option(
677 '--write-auto-subs', '--write-automatic-subs',
678 action
='store_true', dest
='writeautomaticsub', default
=False,
679 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
680 subtitles
.add_option(
681 '--no-write-auto-subs', '--no-write-automatic-subs',
682 action
='store_false', dest
='writeautomaticsub', default
=False,
683 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
684 subtitles
.add_option(
686 action
='store_true', dest
='allsubtitles', default
=False,
687 help=optparse
.SUPPRESS_HELP
)
688 subtitles
.add_option(
690 action
='store_true', dest
='listsubtitles', default
=False,
691 help='List available subtitles of each video. Simulate unless --no-simulate is used')
692 subtitles
.add_option(
694 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
695 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
696 subtitles
.add_option(
697 '--sub-langs', '--srt-langs',
698 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
699 default
=[], callback
=_list_from_options_callback
,
701 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
702 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
703 'Use --list-subs for a list of available language tags'))
705 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
706 downloader
.add_option(
707 '-N', '--concurrent-fragments',
708 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
709 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
710 downloader
.add_option(
711 '-r', '--limit-rate', '--rate-limit',
712 dest
='ratelimit', metavar
='RATE',
713 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
714 downloader
.add_option(
716 dest
='throttledratelimit', metavar
='RATE',
717 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
718 downloader
.add_option(
720 dest
='retries', metavar
='RETRIES', default
=10,
721 help='Number of retries (default is %default), or "infinite"')
722 downloader
.add_option(
723 '--file-access-retries',
724 dest
='file_access_retries', metavar
='RETRIES', default
=3,
725 help='Number of times to retry on file access error (default is %default), or "infinite"')
726 downloader
.add_option(
727 '--fragment-retries',
728 dest
='fragment_retries', metavar
='RETRIES', default
=10,
729 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
730 downloader
.add_option(
731 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
732 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
733 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
734 downloader
.add_option(
735 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
736 action
='store_false', dest
='skip_unavailable_fragments',
737 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
738 downloader
.add_option(
740 action
='store_true', dest
='keep_fragments', default
=False,
741 help='Keep downloaded fragments on disk after downloading is finished')
742 downloader
.add_option(
743 '--no-keep-fragments',
744 action
='store_false', dest
='keep_fragments',
745 help='Delete downloaded fragments after downloading is finished (default)')
746 downloader
.add_option(
748 dest
='buffersize', metavar
='SIZE', default
='1024',
749 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
750 downloader
.add_option(
752 action
='store_false', dest
='noresizebuffer',
753 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
754 downloader
.add_option(
755 '--no-resize-buffer',
756 action
='store_true', dest
='noresizebuffer', default
=False,
757 help='Do not automatically adjust the buffer size')
758 downloader
.add_option(
760 dest
='http_chunk_size', metavar
='SIZE', default
=None,
762 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
763 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
764 downloader
.add_option(
766 action
='store_true', dest
='test', default
=False,
767 help=optparse
.SUPPRESS_HELP
)
768 downloader
.add_option(
769 '--playlist-reverse',
771 help='Download playlist videos in reverse order')
772 downloader
.add_option(
773 '--no-playlist-reverse',
774 action
='store_false', dest
='playlist_reverse',
775 help='Download playlist videos in default order (default)')
776 downloader
.add_option(
779 help='Download playlist videos in random order')
780 downloader
.add_option(
781 '--xattr-set-filesize',
782 dest
='xattr_set_filesize', action
='store_true',
783 help='Set file xattribute ytdl.filesize with expected file size')
784 downloader
.add_option(
785 '--hls-prefer-native',
786 dest
='hls_prefer_native', action
='store_true', default
=None,
787 help=optparse
.SUPPRESS_HELP
)
788 downloader
.add_option(
789 '--hls-prefer-ffmpeg',
790 dest
='hls_prefer_native', action
='store_false', default
=None,
791 help=optparse
.SUPPRESS_HELP
)
792 downloader
.add_option(
794 dest
='hls_use_mpegts', action
='store_true', default
=None,
796 'Use the mpegts container for HLS videos; '
797 'allowing some players to play the video while downloading, '
798 'and reducing the chance of file corruption if download is interrupted. '
799 'This is enabled by default for live streams'))
800 downloader
.add_option(
801 '--no-hls-use-mpegts',
802 dest
='hls_use_mpegts', action
='store_false',
804 'Do not use the mpegts container for HLS videos. '
805 'This is default when not downloading live streams'))
806 downloader
.add_option(
807 '--downloader', '--external-downloader',
808 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
809 action
='callback', callback
=_dict_from_options_callback
,
811 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
812 'default_key': 'default',
815 'Name or path of the external downloader to use (optionally) prefixed by '
816 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
817 f
'Currently supports native, {", ".join(list_external_downloaders())}. '
818 'You can use this option multiple times to set different downloaders for different protocols. '
819 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
820 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
821 '(Alias: --external-downloader)'))
822 downloader
.add_option(
823 '--downloader-args', '--external-downloader-args',
824 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
825 action
='callback', callback
=_dict_from_options_callback
,
827 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(map(re
.escape
, list_external_downloaders())),
828 'default_key': 'default',
829 'process': shlex
.split
831 'Give these arguments to the external downloader. '
832 'Specify the downloader name and the arguments separated by a colon ":". '
833 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
834 'You can use this option multiple times to give different arguments to different downloaders '
835 '(Alias: --external-downloader-args)'))
837 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
838 workarounds
.add_option(
840 dest
='encoding', metavar
='ENCODING',
841 help='Force the specified encoding (experimental)')
842 workarounds
.add_option(
843 '--legacy-server-connect',
844 action
='store_true', dest
='legacy_server_connect', default
=False,
845 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
846 workarounds
.add_option(
847 '--no-check-certificates',
848 action
='store_true', dest
='no_check_certificate', default
=False,
849 help='Suppress HTTPS certificate validation')
850 workarounds
.add_option(
851 '--prefer-insecure', '--prefer-unsecure',
852 action
='store_true', dest
='prefer_insecure',
853 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
854 workarounds
.add_option(
856 metavar
='UA', dest
='user_agent',
857 help=optparse
.SUPPRESS_HELP
)
858 workarounds
.add_option(
860 metavar
='URL', dest
='referer', default
=None,
861 help=optparse
.SUPPRESS_HELP
)
862 workarounds
.add_option(
864 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
865 action
='callback', callback
=_dict_from_options_callback
,
866 callback_kwargs
={'multiple_keys': False}
,
867 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
869 workarounds
.add_option(
871 dest
='bidi_workaround', action
='store_true',
872 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
873 workarounds
.add_option(
874 '--sleep-requests', metavar
='SECONDS',
875 dest
='sleep_interval_requests', type=float,
876 help='Number of seconds to sleep between requests during data extraction')
877 workarounds
.add_option(
878 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
879 dest
='sleep_interval', type=float,
881 'Number of seconds to sleep before each download. '
882 'This is the minimum time to sleep when used along with --max-sleep-interval '
883 '(Alias: --min-sleep-interval)'))
884 workarounds
.add_option(
885 '--max-sleep-interval', metavar
='SECONDS',
886 dest
='max_sleep_interval', type=float,
887 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
888 workarounds
.add_option(
889 '--sleep-subtitles', metavar
='SECONDS',
890 dest
='sleep_interval_subtitles', default
=0, type=int,
891 help='Number of seconds to sleep before each subtitle download')
893 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
894 verbosity
.add_option(
896 action
='store_true', dest
='quiet', default
=False,
897 help='Activate quiet mode. If used with --verbose, print the log to stderr')
898 verbosity
.add_option(
900 dest
='no_warnings', action
='store_true', default
=False,
901 help='Ignore warnings')
902 verbosity
.add_option(
904 action
='store_true', dest
='simulate', default
=None,
905 help='Do not download the video and do not write anything to disk')
906 verbosity
.add_option(
908 action
='store_false', dest
='simulate',
909 help='Download the video even if printing/listing options are used')
910 verbosity
.add_option(
911 '--ignore-no-formats-error',
912 action
='store_true', dest
='ignore_no_formats_error', default
=False,
914 'Ignore "No video formats" error. Useful for extracting metadata '
915 'even if the videos are not actually available for download (experimental)'))
916 verbosity
.add_option(
917 '--no-ignore-no-formats-error',
918 action
='store_false', dest
='ignore_no_formats_error',
919 help='Throw error when no downloadable video formats are found (default)')
920 verbosity
.add_option(
921 '--skip-download', '--no-download',
922 action
='store_true', dest
='skip_download', default
=False,
923 help='Do not download the video but write all related files (Alias: --no-download)')
924 verbosity
.add_option(
926 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', default
={}, type='str',
927 action
='callback', callback
=_dict_from_options_callback
,
929 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
930 'default_key': 'video',
931 'multiple_keys': False,
934 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
935 'Supported values of "WHEN" are the same as that of --use-postprocessor, and "video" (default). '
936 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
937 'This option can be used multiple times'))
938 verbosity
.add_option(
940 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', default
={}, type='str', nargs
=2,
941 action
='callback', callback
=_dict_from_options_callback
,
943 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
944 'default_key': 'video',
945 'multiple_keys': False,
948 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
949 'FILE uses the same syntax as the output template. This option can be used multiple times'))
950 verbosity
.add_option(
952 action
='store_true', dest
='geturl', default
=False,
953 help=optparse
.SUPPRESS_HELP
)
954 verbosity
.add_option(
956 action
='store_true', dest
='gettitle', default
=False,
957 help=optparse
.SUPPRESS_HELP
)
958 verbosity
.add_option(
960 action
='store_true', dest
='getid', default
=False,
961 help=optparse
.SUPPRESS_HELP
)
962 verbosity
.add_option(
964 action
='store_true', dest
='getthumbnail', default
=False,
965 help=optparse
.SUPPRESS_HELP
)
966 verbosity
.add_option(
968 action
='store_true', dest
='getdescription', default
=False,
969 help=optparse
.SUPPRESS_HELP
)
970 verbosity
.add_option(
972 action
='store_true', dest
='getduration', default
=False,
973 help=optparse
.SUPPRESS_HELP
)
974 verbosity
.add_option(
976 action
='store_true', dest
='getfilename', default
=False,
977 help=optparse
.SUPPRESS_HELP
)
978 verbosity
.add_option(
980 action
='store_true', dest
='getformat', default
=False,
981 help=optparse
.SUPPRESS_HELP
)
982 verbosity
.add_option(
984 action
='store_true', dest
='dumpjson', default
=False,
985 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
986 verbosity
.add_option(
987 '-J', '--dump-single-json',
988 action
='store_true', dest
='dump_single_json', default
=False,
990 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
991 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
992 verbosity
.add_option(
994 action
='store_true', dest
='print_json', default
=False,
995 help=optparse
.SUPPRESS_HELP
)
996 verbosity
.add_option(
997 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
998 action
='store_true', dest
='force_write_download_archive', default
=False,
1000 'Force download archive entries to be written as far as no errors occur, '
1001 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1002 verbosity
.add_option(
1004 action
='store_true', dest
='progress_with_newline', default
=False,
1005 help='Output progress bar as new lines')
1006 verbosity
.add_option(
1008 action
='store_true', dest
='noprogress', default
=None,
1009 help='Do not print progress bar')
1010 verbosity
.add_option(
1012 action
='store_false', dest
='noprogress',
1013 help='Show progress bar, even if in quiet mode')
1014 verbosity
.add_option(
1016 action
='store_true', dest
='consoletitle', default
=False,
1017 help='Display progress in console titlebar')
1018 verbosity
.add_option(
1019 '--progress-template',
1020 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1021 action
='callback', callback
=_dict_from_options_callback
,
1023 'allowed_keys': '(download|postprocess)(-title)?',
1024 'default_key': 'download'
1026 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1027 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1028 'The video\'s fields are accessible under the "info" key and '
1029 'the progress attributes are accessible under "progress" key. E.g.: '
1030 # TODO: Document the fields inside "progress"
1031 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1032 verbosity
.add_option(
1034 action
='store_true', dest
='verbose', default
=False,
1035 help='Print various debugging information')
1036 verbosity
.add_option(
1037 '--dump-pages', '--dump-intermediate-pages',
1038 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1039 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1040 verbosity
.add_option(
1042 action
='store_true', dest
='write_pages', default
=False,
1043 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1044 verbosity
.add_option(
1045 '--youtube-print-sig-code',
1046 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1047 help=optparse
.SUPPRESS_HELP
)
1048 verbosity
.add_option(
1049 '--print-traffic', '--dump-headers',
1050 dest
='debug_printtraffic', action
='store_true', default
=False,
1051 help='Display sent and read HTTP traffic')
1052 verbosity
.add_option(
1053 '-C', '--call-home',
1054 dest
='call_home', action
='store_true', default
=False,
1055 # help='Contact the yt-dlp server for debugging')
1056 help=optparse
.SUPPRESS_HELP
)
1057 verbosity
.add_option(
1059 dest
='call_home', action
='store_false',
1060 # help='Do not contact the yt-dlp server for debugging (default)')
1061 help=optparse
.SUPPRESS_HELP
)
1063 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1064 filesystem
.add_option(
1065 '-a', '--batch-file',
1066 dest
='batchfile', metavar
='FILE',
1068 'File containing URLs to download ("-" for stdin), one URL per line. '
1069 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1070 filesystem
.add_option(
1072 dest
='batchfile', action
='store_const', const
=None,
1073 help='Do not read URLs from batch file (default)')
1074 filesystem
.add_option(
1075 '--id', default
=False,
1076 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1077 filesystem
.add_option(
1079 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1080 action
='callback', callback
=_dict_from_options_callback
,
1082 'allowed_keys': 'home|temp|%s' % '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1083 'default_key': 'home'
1085 'The paths where the files should be downloaded. '
1086 'Specify the type of file and the path separated by a colon ":". '
1087 'All the same TYPES as --output are supported. '
1088 'Additionally, you can also provide "home" (default) and "temp" paths. '
1089 'All intermediary files are first downloaded to the temp path and '
1090 'then the final files are moved over to the home path after download is finished. '
1091 'This option is ignored if --output is an absolute path'))
1092 filesystem
.add_option(
1094 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1095 action
='callback', callback
=_dict_from_options_callback
,
1097 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1098 'default_key': 'default'
1099 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1100 filesystem
.add_option(
1101 '--output-na-placeholder',
1102 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1103 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
1104 filesystem
.add_option(
1105 '--autonumber-size',
1106 dest
='autonumber_size', metavar
='NUMBER', type=int,
1107 help=optparse
.SUPPRESS_HELP
)
1108 filesystem
.add_option(
1109 '--autonumber-start',
1110 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1111 help=optparse
.SUPPRESS_HELP
)
1112 filesystem
.add_option(
1113 '--restrict-filenames',
1114 action
='store_true', dest
='restrictfilenames', default
=False,
1115 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1116 filesystem
.add_option(
1117 '--no-restrict-filenames',
1118 action
='store_false', dest
='restrictfilenames',
1119 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1120 filesystem
.add_option(
1121 '--windows-filenames',
1122 action
='store_true', dest
='windowsfilenames', default
=False,
1123 help='Force filenames to be Windows-compatible')
1124 filesystem
.add_option(
1125 '--no-windows-filenames',
1126 action
='store_false', dest
='windowsfilenames',
1127 help='Make filenames Windows-compatible only if using Windows (default)')
1128 filesystem
.add_option(
1129 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1130 dest
='trim_file_name', default
=0, type=int,
1131 help='Limit the filename length (excluding extension) to the specified number of characters')
1132 filesystem
.add_option(
1133 '-w', '--no-overwrites',
1134 action
='store_false', dest
='overwrites', default
=None,
1135 help='Do not overwrite any files')
1136 filesystem
.add_option(
1137 '--force-overwrites', '--yes-overwrites',
1138 action
='store_true', dest
='overwrites',
1139 help='Overwrite all video and metadata files. This option includes --no-continue')
1140 filesystem
.add_option(
1141 '--no-force-overwrites',
1142 action
='store_const', dest
='overwrites', const
=None,
1143 help='Do not overwrite the video, but overwrite related files (default)')
1144 filesystem
.add_option(
1146 action
='store_true', dest
='continue_dl', default
=True,
1147 help='Resume partially downloaded files/fragments (default)')
1148 filesystem
.add_option(
1150 action
='store_false', dest
='continue_dl',
1152 'Do not resume partially downloaded fragments. '
1153 'If the file is not fragmented, restart download of the entire file'))
1154 filesystem
.add_option(
1156 action
='store_false', dest
='nopart', default
=False,
1157 help='Use .part files instead of writing directly into output file (default)')
1158 filesystem
.add_option(
1160 action
='store_true', dest
='nopart',
1161 help='Do not use .part files - write directly into output file')
1162 filesystem
.add_option(
1164 action
='store_true', dest
='updatetime', default
=True,
1165 help='Use the Last-modified header to set the file modification time (default)')
1166 filesystem
.add_option(
1168 action
='store_false', dest
='updatetime',
1169 help='Do not use the Last-modified header to set the file modification time')
1170 filesystem
.add_option(
1171 '--write-description',
1172 action
='store_true', dest
='writedescription', default
=False,
1173 help='Write video description to a .description file')
1174 filesystem
.add_option(
1175 '--no-write-description',
1176 action
='store_false', dest
='writedescription',
1177 help='Do not write video description (default)')
1178 filesystem
.add_option(
1179 '--write-info-json',
1180 action
='store_true', dest
='writeinfojson', default
=None,
1181 help='Write video metadata to a .info.json file (this may contain personal information)')
1182 filesystem
.add_option(
1183 '--no-write-info-json',
1184 action
='store_false', dest
='writeinfojson',
1185 help='Do not write video metadata (default)')
1186 filesystem
.add_option(
1187 '--write-annotations',
1188 action
='store_true', dest
='writeannotations', default
=False,
1189 help=optparse
.SUPPRESS_HELP
)
1190 filesystem
.add_option(
1191 '--no-write-annotations',
1192 action
='store_false', dest
='writeannotations',
1193 help=optparse
.SUPPRESS_HELP
)
1194 filesystem
.add_option(
1195 '--write-playlist-metafiles',
1196 action
='store_true', dest
='allow_playlist_files', default
=None,
1198 'Write playlist metadata in addition to the video metadata '
1199 'when using --write-info-json, --write-description etc. (default)'))
1200 filesystem
.add_option(
1201 '--no-write-playlist-metafiles',
1202 action
='store_false', dest
='allow_playlist_files',
1203 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1204 filesystem
.add_option(
1205 '--clean-info-json', '--clean-infojson',
1206 action
='store_true', dest
='clean_infojson', default
=None,
1208 'Remove some private fields such as filenames from the infojson. '
1209 'Note that it could still contain some personal information (default)'))
1210 filesystem
.add_option(
1211 '--no-clean-info-json', '--no-clean-infojson',
1212 action
='store_false', dest
='clean_infojson',
1213 help='Write all fields to the infojson')
1214 filesystem
.add_option(
1215 '--write-comments', '--get-comments',
1216 action
='store_true', dest
='getcomments', default
=False,
1218 'Retrieve video comments to be placed in the infojson. '
1219 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1220 filesystem
.add_option(
1221 '--no-write-comments', '--no-get-comments',
1222 action
='store_false', dest
='getcomments',
1223 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1224 filesystem
.add_option(
1225 '--load-info-json', '--load-info',
1226 dest
='load_info_filename', metavar
='FILE',
1227 help='JSON file containing the video information (created with the "--write-info-json" option)')
1228 filesystem
.add_option(
1230 dest
='cookiefile', metavar
='FILE',
1231 help='Netscape formatted file to read cookies from and dump cookie jar in')
1232 filesystem
.add_option(
1234 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1235 help='Do not read/dump cookies from/to file (default)')
1236 filesystem
.add_option(
1237 '--cookies-from-browser',
1238 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE]',
1240 'The name of the browser and (optionally) the name/path of '
1241 'the profile to load cookies from, separated by a ":". '
1242 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1243 'By default, the most recently accessed profile is used. '
1244 'The keyring used for decrypting Chromium cookies on Linux can be '
1245 '(optionally) specified after the browser name separated by a "+". '
1246 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1247 filesystem
.add_option(
1248 '--no-cookies-from-browser',
1249 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1250 help='Do not load cookies from browser (default)')
1251 filesystem
.add_option(
1252 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1253 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')
1254 filesystem
.add_option(
1255 '--no-cache-dir', action
='store_false', dest
='cachedir',
1256 help='Disable filesystem caching')
1257 filesystem
.add_option(
1259 action
='store_true', dest
='rm_cachedir',
1260 help='Delete all filesystem cache files')
1262 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1263 thumbnail
.add_option(
1264 '--write-thumbnail',
1265 action
='callback', dest
='writethumbnail', default
=False,
1266 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1267 callback
=lambda option
, _
, __
, parser
: setattr(
1268 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1269 help='Write thumbnail image to disk')
1270 thumbnail
.add_option(
1271 '--no-write-thumbnail',
1272 action
='store_false', dest
='writethumbnail',
1273 help='Do not write thumbnail image to disk (default)')
1274 thumbnail
.add_option(
1275 '--write-all-thumbnails',
1276 action
='store_const', dest
='writethumbnail', const
='all',
1277 help='Write all thumbnail image formats to disk')
1278 thumbnail
.add_option(
1279 '--list-thumbnails',
1280 action
='store_true', dest
='list_thumbnails', default
=False,
1281 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1283 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1286 action
='store_true', dest
='writelink', default
=False,
1287 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1290 action
='store_true', dest
='writeurllink', default
=False,
1291 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1293 '--write-webloc-link',
1294 action
='store_true', dest
='writewebloclink', default
=False,
1295 help='Write a .webloc macOS internet shortcut')
1297 '--write-desktop-link',
1298 action
='store_true', dest
='writedesktoplink', default
=False,
1299 help='Write a .desktop Linux internet shortcut')
1301 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1302 postproc
.add_option(
1303 '-x', '--extract-audio',
1304 action
='store_true', dest
='extractaudio', default
=False,
1305 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1306 postproc
.add_option(
1307 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1309 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1310 'best (default) or one of %s' % ', '.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1311 postproc
.add_option(
1312 '--audio-quality', metavar
='QUALITY',
1313 dest
='audioquality', default
='5',
1314 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)')
1315 postproc
.add_option(
1317 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1319 'Remux the video into another container if necessary (currently supported: %s). '
1320 'If target container does not support the video/audio codec, remuxing will fail. '
1321 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1322 'and anything else to mkv.' % ', '.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1323 postproc
.add_option(
1325 metavar
='FORMAT', dest
='recodevideo', default
=None,
1327 'Re-encode the video into another format if re-encoding is necessary. '
1328 'The syntax and supported formats are the same as --remux-video'))
1329 postproc
.add_option(
1330 '--postprocessor-args', '--ppa',
1331 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1332 action
='callback', callback
=_dict_from_options_callback
,
1334 'allowed_keys': r
'\w+(?:\+\w+)?',
1335 'default_key': 'default-compat',
1336 'process': shlex
.split
,
1337 'multiple_keys': False
1339 'Give these arguments to the postprocessors. '
1340 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1341 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1342 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1343 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1344 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1345 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1346 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1347 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1348 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1349 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1350 'You can use this option multiple times to give different arguments to different '
1351 'postprocessors. (Alias: --ppa)'))
1352 postproc
.add_option(
1353 '-k', '--keep-video',
1354 action
='store_true', dest
='keepvideo', default
=False,
1355 help='Keep the intermediate video file on disk after post-processing')
1356 postproc
.add_option(
1358 action
='store_false', dest
='keepvideo',
1359 help='Delete the intermediate video file after post-processing (default)')
1360 postproc
.add_option(
1361 '--post-overwrites',
1362 action
='store_false', dest
='nopostoverwrites',
1363 help='Overwrite post-processed files (default)')
1364 postproc
.add_option(
1365 '--no-post-overwrites',
1366 action
='store_true', dest
='nopostoverwrites', default
=False,
1367 help='Do not overwrite post-processed files')
1368 postproc
.add_option(
1370 action
='store_true', dest
='embedsubtitles', default
=False,
1371 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1372 postproc
.add_option(
1374 action
='store_false', dest
='embedsubtitles',
1375 help='Do not embed subtitles (default)')
1376 postproc
.add_option(
1377 '--embed-thumbnail',
1378 action
='store_true', dest
='embedthumbnail', default
=False,
1379 help='Embed thumbnail in the video as cover art')
1380 postproc
.add_option(
1381 '--no-embed-thumbnail',
1382 action
='store_false', dest
='embedthumbnail',
1383 help='Do not embed thumbnail (default)')
1384 postproc
.add_option(
1385 '--embed-metadata', '--add-metadata',
1386 action
='store_true', dest
='addmetadata', default
=False,
1388 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1389 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1390 postproc
.add_option(
1391 '--no-embed-metadata', '--no-add-metadata',
1392 action
='store_false', dest
='addmetadata',
1393 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1394 postproc
.add_option(
1395 '--embed-chapters', '--add-chapters',
1396 action
='store_true', dest
='addchapters', default
=None,
1397 help='Add chapter markers to the video file (Alias: --add-chapters)')
1398 postproc
.add_option(
1399 '--no-embed-chapters', '--no-add-chapters',
1400 action
='store_false', dest
='addchapters',
1401 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1402 postproc
.add_option(
1403 '--embed-info-json',
1404 action
='store_true', dest
='embed_infojson', default
=None,
1405 help='Embed the infojson as an attachment to mkv/mka video files')
1406 postproc
.add_option(
1407 '--no-embed-info-json',
1408 action
='store_false', dest
='embed_infojson',
1409 help='Do not embed the infojson as an attachment to the video file')
1410 postproc
.add_option(
1411 '--metadata-from-title',
1412 metavar
='FORMAT', dest
='metafromtitle',
1413 help=optparse
.SUPPRESS_HELP
)
1414 postproc
.add_option(
1416 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1418 'Parse additional metadata like title/artist from other fields; '
1419 'see "MODIFYING METADATA" for details'))
1420 postproc
.add_option(
1421 '--replace-in-metadata',
1422 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1423 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1424 postproc
.add_option(
1425 '--xattrs', '--xattr',
1426 action
='store_true', dest
='xattrs', default
=False,
1427 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1428 postproc
.add_option(
1429 '--concat-playlist',
1430 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1431 choices
=('never', 'always', 'multi_video'),
1433 'Concatenate videos in a playlist. One of "never", "always", or '
1434 '"multi_video" (default; only when the videos form a single show). '
1435 'All the video files must have same codecs and number of streams to be concatable. '
1436 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1437 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1438 postproc
.add_option(
1440 metavar
='POLICY', dest
='fixup', default
=None,
1441 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1443 'Automatically correct known faults of the file. '
1444 'One of never (do nothing), warn (only emit a warning), '
1445 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1446 'force (try fixing even if file already exists)'))
1447 postproc
.add_option(
1448 '--prefer-avconv', '--no-prefer-ffmpeg',
1449 action
='store_false', dest
='prefer_ffmpeg',
1450 help=optparse
.SUPPRESS_HELP
)
1451 postproc
.add_option(
1452 '--prefer-ffmpeg', '--no-prefer-avconv',
1453 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1454 help=optparse
.SUPPRESS_HELP
)
1455 postproc
.add_option(
1456 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1457 dest
='ffmpeg_location',
1458 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1459 postproc
.add_option(
1461 metavar
='[WHEN:]CMD', dest
='exec_cmd', default
={}, type='str',
1462 action
='callback', callback
=_dict_from_options_callback
,
1464 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
1465 'default_key': 'after_move',
1466 'multiple_keys': False,
1469 'Execute a command, optionally prefixed with when to execute it (after_move if unspecified), separated by a ":". '
1470 'Supported values of "WHEN" are the same as that of --use-postprocessor. '
1471 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1472 'After download, an additional field "filepath" that contains the final path of the downloaded file '
1473 'is also available, and if no fields are passed, %(filepath)q is appended to the end of the command. '
1474 'This option can be used multiple times'))
1475 postproc
.add_option(
1477 action
='store_const', dest
='exec_cmd', const
={},
1478 help='Remove any previously defined --exec')
1479 postproc
.add_option(
1480 '--exec-before-download', metavar
='CMD',
1481 action
='append', dest
='exec_before_dl_cmd',
1482 help=optparse
.SUPPRESS_HELP
)
1483 postproc
.add_option(
1484 '--no-exec-before-download',
1485 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1486 help=optparse
.SUPPRESS_HELP
)
1487 postproc
.add_option(
1488 '--convert-subs', '--convert-sub', '--convert-subtitles',
1489 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1491 'Convert the subtitles to another format (currently supported: %s) '
1492 '(Alias: --convert-subtitles)' % ', '.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1493 postproc
.add_option(
1494 '--convert-thumbnails',
1495 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1497 'Convert the thumbnails to another format '
1498 '(currently supported: %s) ' % ', '.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1499 postproc
.add_option(
1500 '--split-chapters', '--split-tracks',
1501 dest
='split_chapters', action
='store_true', default
=False,
1503 'Split video into multiple files based on internal chapters. '
1504 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1505 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1506 postproc
.add_option(
1507 '--no-split-chapters', '--no-split-tracks',
1508 dest
='split_chapters', action
='store_false',
1509 help='Do not split video based on chapters (default)')
1510 postproc
.add_option(
1511 '--remove-chapters',
1512 metavar
='REGEX', dest
='remove_chapters', action
='append',
1514 'Remove chapters whose title matches the given regular expression. '
1515 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1516 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1517 'This option can be used multiple times'))
1518 postproc
.add_option(
1519 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1520 help='Do not remove any chapters from the file (default)')
1521 postproc
.add_option(
1522 '--force-keyframes-at-cuts',
1523 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1525 'Force keyframes around the chapters before removing/splitting them. '
1526 'Requires a re-encode and thus is very slow, but the resulting video '
1527 'may have fewer artifacts around the cuts'))
1528 postproc
.add_option(
1529 '--no-force-keyframes-at-cuts',
1530 action
='store_false', dest
='force_keyframes_at_cuts',
1531 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1532 _postprocessor_opts_parser
= lambda key
, val
='': (
1533 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1534 ('key', remove_end(key
, 'PP')))
1535 postproc
.add_option(
1536 '--use-postprocessor',
1537 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1538 action
='callback', callback
=_list_from_options_callback
,
1541 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1543 'The (case sensitive) name of plugin postprocessors to be enabled, '
1544 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1545 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1546 'The "when" argument determines when the postprocessor is invoked. '
1547 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1548 '"before_dl" (before each video download), "post_process" (after each video download; default), '
1549 '"after_move" (after moving video file to it\'s final locations), '
1550 '"after_video" (after downloading and processing all formats of a video), '
1551 'or "playlist" (at end of playlist). '
1552 'This option can be used multiple times to add different postprocessors'))
1554 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1555 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1556 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1557 sponsorblock
.add_option(
1558 '--sponsorblock-mark', metavar
='CATS',
1559 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1560 callback
=_set_from_options_callback
, callback_kwargs
={
1561 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1562 'aliases': {'default': ['all']}
1564 'SponsorBlock categories to create chapters for, separated by commas. '
1565 f
'Available categories are all, default(=all), {", ".join(SponsorBlockPP.CATEGORIES.keys())}. '
1566 'You can prefix the category with a "-" to exempt it. See [1] for description of the categories. '
1567 'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1568 sponsorblock
.add_option(
1569 '--sponsorblock-remove', metavar
='CATS',
1570 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1571 callback
=_set_from_options_callback
, callback_kwargs
={
1572 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.POI_CATEGORIES
.keys()),
1573 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1574 # The filler category is very aggressive.
1575 # It is strongly recommended to not use this in a client by default.
1576 'aliases': {'default': ['all', '-filler']}
1578 'SponsorBlock categories to be removed from the video file, separated by commas. '
1579 'If a category is present in both mark and remove, remove takes precedence. '
1580 'The syntax and available categories are the same as for --sponsorblock-mark '
1581 'except that "default" refers to "all,-filler" '
1582 f
'and {", ".join(SponsorBlockPP.POI_CATEGORIES.keys())} is not available'))
1583 sponsorblock
.add_option(
1584 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1585 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1587 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1588 'The same syntax as the output template is used, but the only available fields are '
1589 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1590 sponsorblock
.add_option(
1591 '--no-sponsorblock', default
=False,
1592 action
='store_true', dest
='no_sponsorblock',
1593 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1594 sponsorblock
.add_option(
1595 '--sponsorblock-api', metavar
='URL',
1596 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1597 help='SponsorBlock API location, defaults to %default')
1599 sponsorblock
.add_option(
1601 action
='store_true', dest
='sponskrub', default
=False,
1602 help=optparse
.SUPPRESS_HELP
)
1603 sponsorblock
.add_option(
1605 action
='store_false', dest
='sponskrub',
1606 help=optparse
.SUPPRESS_HELP
)
1607 sponsorblock
.add_option(
1608 '--sponskrub-cut', default
=False,
1609 action
='store_true', dest
='sponskrub_cut',
1610 help=optparse
.SUPPRESS_HELP
)
1611 sponsorblock
.add_option(
1612 '--no-sponskrub-cut',
1613 action
='store_false', dest
='sponskrub_cut',
1614 help=optparse
.SUPPRESS_HELP
)
1615 sponsorblock
.add_option(
1616 '--sponskrub-force', default
=False,
1617 action
='store_true', dest
='sponskrub_force',
1618 help=optparse
.SUPPRESS_HELP
)
1619 sponsorblock
.add_option(
1620 '--no-sponskrub-force',
1621 action
='store_true', dest
='sponskrub_force',
1622 help=optparse
.SUPPRESS_HELP
)
1623 sponsorblock
.add_option(
1624 '--sponskrub-location', metavar
='PATH',
1625 dest
='sponskrub_path', default
='',
1626 help=optparse
.SUPPRESS_HELP
)
1627 sponsorblock
.add_option(
1628 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1629 help=optparse
.SUPPRESS_HELP
)
1631 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1632 extractor
.add_option(
1633 '--extractor-retries',
1634 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1635 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1636 extractor
.add_option(
1637 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1638 action
='store_true', dest
='dynamic_mpd', default
=True,
1639 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1640 extractor
.add_option(
1641 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1642 action
='store_false', dest
='dynamic_mpd',
1643 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1644 extractor
.add_option(
1645 '--hls-split-discontinuity',
1646 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1647 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1649 extractor
.add_option(
1650 '--no-hls-split-discontinuity',
1651 dest
='hls_split_discontinuity', action
='store_false',
1652 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1653 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1654 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1655 extractor
.add_option(
1657 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1658 action
='callback', callback
=_dict_from_options_callback
,
1660 'multiple_keys': False,
1661 'process': lambda val
: dict(
1662 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1664 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1665 'You can use this option multiple times to give arguments for different extractors'))
1666 extractor
.add_option(
1667 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1668 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1669 help=optparse
.SUPPRESS_HELP
)
1670 extractor
.add_option(
1671 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1672 action
='store_false', dest
='youtube_include_dash_manifest',
1673 help=optparse
.SUPPRESS_HELP
)
1674 extractor
.add_option(
1675 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1676 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1677 help=optparse
.SUPPRESS_HELP
)
1678 extractor
.add_option(
1679 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1680 action
='store_false', dest
='youtube_include_hls_manifest',
1681 help=optparse
.SUPPRESS_HELP
)
1683 parser
.add_option_group(general
)
1684 parser
.add_option_group(network
)
1685 parser
.add_option_group(geo
)
1686 parser
.add_option_group(selection
)
1687 parser
.add_option_group(downloader
)
1688 parser
.add_option_group(filesystem
)
1689 parser
.add_option_group(thumbnail
)
1690 parser
.add_option_group(link
)
1691 parser
.add_option_group(verbosity
)
1692 parser
.add_option_group(workarounds
)
1693 parser
.add_option_group(video_format
)
1694 parser
.add_option_group(subtitles
)
1695 parser
.add_option_group(authentication
)
1696 parser
.add_option_group(postproc
)
1697 parser
.add_option_group(sponsorblock
)
1698 parser
.add_option_group(extractor
)
1703 def _hide_login_info(opts
):
1705 'DeprecationWarning: "yt_dlp.options._hide_login_info" is deprecated and may be removed in a future version. '
1706 'Use "yt_dlp.utils.Config.hide_login_info" instead\n')
1707 return Config
.hide_login_info(opts
)