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