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