1 from __future__
import unicode_literals
10 compat_get_terminal_size
,
23 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
24 from .version
import __version__
26 from .downloader
.external
import list_external_downloaders
27 from .postprocessor
import (
29 FFmpegSubtitlesConvertorPP
,
30 FFmpegThumbnailsConvertorPP
,
34 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
37 def _hide_login_info(opts
):
38 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
39 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
44 return m
.group('key') + '=PRIVATE'
48 opts
= list(map(_scrub_eq
, opts
))
49 for idx
, opt
in enumerate(opts
):
50 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
51 opts
[idx
+ 1] = 'PRIVATE'
55 def parseOpts(overrideArguments
=None):
56 def _readOptions(filename_bytes
, default
=[]):
58 optionf
= open(filename_bytes
)
60 return default
# silently skip if file is not present
62 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
63 contents
= optionf
.read()
64 if sys
.version_info
< (3,):
65 contents
= contents
.decode(preferredencoding())
66 res
= compat_shlex_split(contents
, comments
=True)
71 def _readUserConf(package_name
, default
=[]):
73 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
74 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
75 if not os
.path
.isfile(userConfFile
):
76 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
77 userConf
= _readOptions(userConfFile
, default
=None)
78 if userConf
is not None:
79 return userConf
, userConfFile
82 appdata_dir
= compat_getenv('appdata')
84 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
85 userConf
= _readOptions(userConfFile
, default
=None)
87 userConfFile
+= '.txt'
88 userConf
= _readOptions(userConfFile
, default
=None)
89 if userConf
is not None:
90 return userConf
, userConfFile
93 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
94 userConf
= _readOptions(userConfFile
, default
=None)
96 userConfFile
+= '.txt'
97 userConf
= _readOptions(userConfFile
, default
=None)
98 if userConf
is not None:
99 return userConf
, userConfFile
103 def _format_option_string(option
):
104 ''' ('-o', '--option') -> -o, --format METAVAR'''
108 if option
._short
_opts
:
109 opts
.append(option
._short
_opts
[0])
110 if option
._long
_opts
:
111 opts
.append(option
._long
_opts
[0])
115 if option
.takes_value():
116 opts
.append(' %s' % option
.metavar
)
120 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
121 # append can be True, False or -1 (prepend)
122 current
= getattr(parser
.values
, option
.dest
) if append
else []
123 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
125 parser
.values
, option
.dest
,
126 current
+ value
if append
is True else value
+ current
)
128 def _set_from_options_callback(
129 option
, opt_str
, value
, parser
, delim
=',', allowed_values
=None, aliases
={},
130 process
=lambda x
: x
.lower().strip()):
131 current
= getattr(parser
.values
, option
.dest
)
132 values
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)[::-1]))
134 actual_val
= val
= values
.pop()
136 current
.update(allowed_values
)
140 values
.extend(aliases
[val
])
146 current
.update([val
])
147 if allowed_values
is not None and val
not in allowed_values
:
148 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
150 setattr(parser
.values
, option
.dest
, current
)
152 def _dict_from_options_callback(
153 option
, opt_str
, value
, parser
,
154 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
155 process_key
=str.lower
):
157 out_dict
= getattr(parser
.values
, option
.dest
)
159 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
160 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
162 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
163 elif default_key
is not None:
164 keys
, val
= [default_key
], value
166 raise optparse
.OptionValueError(
167 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
169 keys
= map(process_key
, keys
) if process_key
else keys
170 val
= process(val
) if process
else val
171 except Exception as err
:
172 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
176 # No need to wrap help messages if we're on a wide console
177 columns
= compat_get_terminal_size().columns
178 max_width
= columns
if columns
else 80
179 # 47% is chosen because that is how README.md is currently formatted
180 # and moving help text even further to the right is undesirable.
181 # This can be reduced in the future to get a prettier output
182 max_help_position
= int(0.47 * max_width
)
184 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
185 fmt
.format_option_strings
= _format_option_string
188 'version': __version__
,
190 'usage': '%prog [OPTIONS] URL [URL...]',
191 'conflict_handler': 'resolve',
194 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
196 general
= optparse
.OptionGroup(parser
, 'General Options')
200 help='Print this help text and exit')
204 help='Print program version and exit')
207 action
='store_true', dest
='update_self',
208 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
210 '-i', '--ignore-errors',
211 action
='store_true', dest
='ignoreerrors',
212 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
214 '--no-abort-on-error',
215 action
='store_const', dest
='ignoreerrors', const
='only_download',
216 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
218 '--abort-on-error', '--no-ignore-errors',
219 action
='store_false', dest
='ignoreerrors',
220 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
223 action
='store_true', dest
='dump_user_agent', default
=False,
224 help='Display the current user-agent and exit')
227 action
='store_true', dest
='list_extractors', default
=False,
228 help='List all supported extractors and exit')
230 '--extractor-descriptions',
231 action
='store_true', dest
='list_extractor_descriptions', default
=False,
232 help='Output descriptions of all supported extractors and exit')
234 '--force-generic-extractor',
235 action
='store_true', dest
='force_generic_extractor', default
=False,
236 help='Force extraction to use the generic extractor')
239 dest
='default_search', metavar
='PREFIX',
240 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')
242 '--ignore-config', '--no-config',
243 action
='store_true', dest
='ignoreconfig',
245 'Disable loading any configuration files except the one provided by --config-location. '
246 'When given inside a configuration file, no further configuration files are loaded. '
247 'Additionally, (for backward compatibility) if this option is found inside the '
248 'system configuration file, the user configuration is not loaded'))
251 dest
='config_location', metavar
='PATH',
252 help='Location of the main configuration file; either the path to the config or its containing directory')
255 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
256 help='Do not extract the videos of a playlist, only list them')
258 '--no-flat-playlist',
259 action
='store_false', dest
='extract_flat',
260 help='Extract the videos of a playlist')
263 action
='store_true', dest
='live_from_start',
264 help='Download livestreams from the start. Currently only supported for YouTube')
266 '--no-live-from-start',
267 action
='store_false', dest
='live_from_start',
268 help='Download livestreams from the current time (default)')
271 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
273 'Wait for scheduled streams to become available. '
274 'Pass the minimum number of seconds (or range) to wait between retries'))
276 '--no-wait-for-video',
277 dest
='wait_for_video', action
='store_const', const
=None,
278 help='Do not wait for scheduled streams (default)')
281 action
='store_true', dest
='mark_watched', default
=False,
282 help='Mark videos watched (even with --simulate). Currently only supported for YouTube')
285 action
='store_false', dest
='mark_watched',
286 help='Do not mark videos watched (default)')
289 action
='store_true', dest
='no_color', default
=False,
290 help='Do not emit color codes in output')
293 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
294 action
='callback', callback
=_set_from_options_callback
,
297 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
298 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
299 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', 'embed-metadata',
300 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
302 'youtube-dl': ['-multistreams', 'all'],
303 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
306 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
307 'configurations by reverting some of the changes made in yt-dlp. '
308 'See "Differences in default behavior" for details'))
310 network
= optparse
.OptionGroup(parser
, 'Network Options')
312 '--proxy', dest
='proxy',
313 default
=None, metavar
='URL',
315 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
316 'SOCKS proxy, specify a proper scheme. For example '
317 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
318 'for direct connection'))
321 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
322 help='Time to wait before giving up, in seconds')
325 metavar
='IP', dest
='source_address', default
=None,
326 help='Client-side IP address to bind to',
329 '-4', '--force-ipv4',
330 action
='store_const', const
='0.0.0.0', dest
='source_address',
331 help='Make all connections via IPv4',
334 '-6', '--force-ipv6',
335 action
='store_const', const
='::', dest
='source_address',
336 help='Make all connections via IPv6',
339 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
341 '--geo-verification-proxy',
342 dest
='geo_verification_proxy', default
=None, metavar
='URL',
344 'Use this proxy to verify the IP address for some geo-restricted sites. '
345 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
347 '--cn-verification-proxy',
348 dest
='cn_verification_proxy', default
=None, metavar
='URL',
349 help=optparse
.SUPPRESS_HELP
)
352 action
='store_true', dest
='geo_bypass', default
=True,
353 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
356 action
='store_false', dest
='geo_bypass', default
=True,
357 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
359 '--geo-bypass-country', metavar
='CODE',
360 dest
='geo_bypass_country', default
=None,
361 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
363 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
364 dest
='geo_bypass_ip_block', default
=None,
365 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
367 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
368 selection
.add_option(
370 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
371 help='Playlist video to start at (default is %default)')
372 selection
.add_option(
374 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
375 help='Playlist video to end at (default is last)')
376 selection
.add_option(
378 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
379 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')
380 selection
.add_option(
382 dest
='matchtitle', metavar
='REGEX',
383 help=optparse
.SUPPRESS_HELP
)
384 selection
.add_option(
386 dest
='rejecttitle', metavar
='REGEX',
387 help=optparse
.SUPPRESS_HELP
)
388 selection
.add_option(
390 metavar
='SIZE', dest
='min_filesize', default
=None,
391 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
392 selection
.add_option(
394 metavar
='SIZE', dest
='max_filesize', default
=None,
395 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
396 selection
.add_option(
398 metavar
='DATE', dest
='date', default
=None,
400 'Download only videos uploaded on this date. '
401 'The date can be "YYYYMMDD" or in the format '
402 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
403 selection
.add_option(
405 metavar
='DATE', dest
='datebefore', default
=None,
407 'Download only videos uploaded on or before this date. '
408 'The date formats accepted is the same as --date'))
409 selection
.add_option(
411 metavar
='DATE', dest
='dateafter', default
=None,
413 'Download only videos uploaded on or after this date. '
414 'The date formats accepted is the same as --date'))
415 selection
.add_option(
417 metavar
='COUNT', dest
='min_views', default
=None, type=int,
418 help=optparse
.SUPPRESS_HELP
)
419 selection
.add_option(
421 metavar
='COUNT', dest
='max_views', default
=None, type=int,
422 help=optparse
.SUPPRESS_HELP
)
423 selection
.add_option(
425 metavar
='FILTER', dest
='match_filter', default
=None,
427 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
428 'number or a string using the operators defined in "Filtering formats". '
429 'You can also simply specify a field to match if the field is present '
430 'and "!field" to check if the field is not present. In addition, '
431 'Python style regular expression matching can be done using "~=", '
432 'and multiple filters can be checked with "&". '
433 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
434 '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
435 'matches only videos that are not live, has a like count more than 100 '
436 '(or the like field is not available), and also has a description '
437 'that contains the phrase "cats & dogs" (ignoring case)'))
438 selection
.add_option(
440 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
441 help='Do not use generic video filter (default)')
442 selection
.add_option(
444 action
='store_true', dest
='noplaylist', default
=False,
445 help='Download only the video, if the URL refers to a video and a playlist')
446 selection
.add_option(
448 action
='store_false', dest
='noplaylist',
449 help='Download the playlist, if the URL refers to a video and a playlist')
450 selection
.add_option(
452 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
453 help='Download only videos suitable for the given age')
454 selection
.add_option(
455 '--download-archive', metavar
='FILE',
456 dest
='download_archive',
457 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
458 selection
.add_option(
459 '--no-download-archive',
460 dest
='download_archive', action
="store_const", const
=None,
461 help='Do not use archive file (default)')
462 selection
.add_option(
464 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
465 help='Abort after downloading NUMBER files')
466 selection
.add_option(
467 '--break-on-existing',
468 action
='store_true', dest
='break_on_existing', default
=False,
469 help='Stop the download process when encountering a file that is in the archive')
470 selection
.add_option(
472 action
='store_true', dest
='break_on_reject', default
=False,
473 help='Stop the download process when encountering a file that has been filtered out')
474 selection
.add_option(
476 action
='store_true', dest
='break_per_url', default
=False,
477 help='Make --break-on-existing and --break-on-reject act only on the current input URL')
478 selection
.add_option(
479 '--no-break-per-input',
480 action
='store_false', dest
='break_per_url',
481 help='--break-on-existing and --break-on-reject terminates the entire download queue')
482 selection
.add_option(
483 '--skip-playlist-after-errors', metavar
='N',
484 dest
='skip_playlist_after_errors', default
=None, type=int,
485 help='Number of allowed failures until the rest of the playlist is skipped')
486 selection
.add_option(
488 dest
='include_ads', action
='store_true',
489 help=optparse
.SUPPRESS_HELP
)
490 selection
.add_option(
492 dest
='include_ads', action
='store_false',
493 help=optparse
.SUPPRESS_HELP
)
495 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
496 authentication
.add_option(
498 dest
='username', metavar
='USERNAME',
499 help='Login with this account ID')
500 authentication
.add_option(
502 dest
='password', metavar
='PASSWORD',
503 help='Account password. If this option is left out, yt-dlp will ask interactively')
504 authentication
.add_option(
506 dest
='twofactor', metavar
='TWOFACTOR',
507 help='Two-factor authentication code')
508 authentication
.add_option(
510 action
='store_true', dest
='usenetrc', default
=False,
511 help='Use .netrc authentication data')
512 authentication
.add_option(
514 dest
='netrc_location', metavar
='PATH',
515 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
516 authentication
.add_option(
518 dest
='videopassword', metavar
='PASSWORD',
519 help='Video password (vimeo, youku)')
520 authentication
.add_option(
522 dest
='ap_mso', metavar
='MSO',
523 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
524 authentication
.add_option(
526 dest
='ap_username', metavar
='USERNAME',
527 help='Multiple-system operator account login')
528 authentication
.add_option(
530 dest
='ap_password', metavar
='PASSWORD',
531 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
532 authentication
.add_option(
534 action
='store_true', dest
='ap_list_mso', default
=False,
535 help='List all supported multiple-system operators')
537 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
538 video_format
.add_option(
540 action
='store', dest
='format', metavar
='FORMAT', default
=None,
541 help='Video format code, see "FORMAT SELECTION" for more details')
542 video_format
.add_option(
543 '-S', '--format-sort', metavar
='SORTORDER',
544 dest
='format_sort', default
=[], type='str', action
='callback',
545 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
546 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
547 video_format
.add_option(
548 '--format-sort-force', '--S-force',
549 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
551 'Force user specified sort order to have precedence over all fields, '
552 'see "Sorting Formats" for more details'))
553 video_format
.add_option(
554 '--no-format-sort-force',
555 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
557 'Some fields have precedence over the user specified sort order (default), '
558 'see "Sorting Formats" for more details'))
559 video_format
.add_option(
560 '--video-multistreams',
561 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
562 help='Allow multiple video streams to be merged into a single file')
563 video_format
.add_option(
564 '--no-video-multistreams',
565 action
='store_false', dest
='allow_multiple_video_streams',
566 help='Only one video stream is downloaded for each output file (default)')
567 video_format
.add_option(
568 '--audio-multistreams',
569 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
570 help='Allow multiple audio streams to be merged into a single file')
571 video_format
.add_option(
572 '--no-audio-multistreams',
573 action
='store_false', dest
='allow_multiple_audio_streams',
574 help='Only one audio stream is downloaded for each output file (default)')
575 video_format
.add_option(
577 action
='store_const', dest
='format', const
='all',
578 help=optparse
.SUPPRESS_HELP
)
579 video_format
.add_option(
580 '--prefer-free-formats',
581 action
='store_true', dest
='prefer_free_formats', default
=False,
583 'Prefer video formats with free containers over non-free ones of same quality. '
584 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
585 video_format
.add_option(
586 '--no-prefer-free-formats',
587 action
='store_false', dest
='prefer_free_formats', default
=False,
588 help="Don't give any special preference to free containers (default)")
589 video_format
.add_option(
591 action
='store_const', const
='selected', dest
='check_formats', default
=None,
592 help='Check that the selected formats are actually downloadable')
593 video_format
.add_option(
594 '--check-all-formats',
595 action
='store_true', dest
='check_formats',
596 help='Check all formats for whether they are actually downloadable')
597 video_format
.add_option(
598 '--no-check-formats',
599 action
='store_false', dest
='check_formats',
600 help='Do not check that the formats are actually downloadable')
601 video_format
.add_option(
602 '-F', '--list-formats',
603 action
='store_true', dest
='listformats',
604 help='List available formats of each video. Simulate unless --no-simulate is used')
605 video_format
.add_option(
606 '--list-formats-as-table',
607 action
='store_true', dest
='listformats_table', default
=True,
608 help=optparse
.SUPPRESS_HELP
)
609 video_format
.add_option(
610 '--list-formats-old', '--no-list-formats-as-table',
611 action
='store_false', dest
='listformats_table',
612 help=optparse
.SUPPRESS_HELP
)
613 video_format
.add_option(
614 '--merge-output-format',
615 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
617 'If a merge is required (e.g. bestvideo+bestaudio), '
618 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
619 'Ignored if no merge is required'))
620 video_format
.add_option(
621 '--allow-unplayable-formats',
622 action
='store_true', dest
='allow_unplayable_formats', default
=False,
623 help=optparse
.SUPPRESS_HELP
)
624 video_format
.add_option(
625 '--no-allow-unplayable-formats',
626 action
='store_false', dest
='allow_unplayable_formats',
627 help=optparse
.SUPPRESS_HELP
)
629 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
630 subtitles
.add_option(
631 '--write-subs', '--write-srt',
632 action
='store_true', dest
='writesubtitles', default
=False,
633 help='Write subtitle file')
634 subtitles
.add_option(
635 '--no-write-subs', '--no-write-srt',
636 action
='store_false', dest
='writesubtitles',
637 help='Do not write subtitle file (default)')
638 subtitles
.add_option(
639 '--write-auto-subs', '--write-automatic-subs',
640 action
='store_true', dest
='writeautomaticsub', default
=False,
641 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
642 subtitles
.add_option(
643 '--no-write-auto-subs', '--no-write-automatic-subs',
644 action
='store_false', dest
='writeautomaticsub', default
=False,
645 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
646 subtitles
.add_option(
648 action
='store_true', dest
='allsubtitles', default
=False,
649 help=optparse
.SUPPRESS_HELP
)
650 subtitles
.add_option(
652 action
='store_true', dest
='listsubtitles', default
=False,
653 help='List available subtitles of each video. Simulate unless --no-simulate is used')
654 subtitles
.add_option(
656 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
657 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
658 subtitles
.add_option(
659 '--sub-langs', '--srt-langs',
660 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
661 default
=[], callback
=_list_from_options_callback
,
663 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
664 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
665 'Use --list-subs for a list of available language tags'))
667 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
668 downloader
.add_option(
669 '-N', '--concurrent-fragments',
670 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
671 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
672 downloader
.add_option(
673 '-r', '--limit-rate', '--rate-limit',
674 dest
='ratelimit', metavar
='RATE',
675 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
676 downloader
.add_option(
678 dest
='throttledratelimit', metavar
='RATE',
679 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
680 downloader
.add_option(
682 dest
='retries', metavar
='RETRIES', default
=10,
683 help='Number of retries (default is %default), or "infinite"')
684 downloader
.add_option(
685 '--file-access-retries',
686 dest
='file_access_retries', metavar
='RETRIES', default
=10,
687 help='Number of times to retry on file access error (default is %default), or "infinite"')
688 downloader
.add_option(
689 '--fragment-retries',
690 dest
='fragment_retries', metavar
='RETRIES', default
=10,
691 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
692 downloader
.add_option(
693 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
694 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
695 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
696 downloader
.add_option(
697 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
698 action
='store_false', dest
='skip_unavailable_fragments',
699 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
700 downloader
.add_option(
702 action
='store_true', dest
='keep_fragments', default
=False,
703 help='Keep downloaded fragments on disk after downloading is finished')
704 downloader
.add_option(
705 '--no-keep-fragments',
706 action
='store_false', dest
='keep_fragments',
707 help='Delete downloaded fragments after downloading is finished (default)')
708 downloader
.add_option(
710 dest
='buffersize', metavar
='SIZE', default
='1024',
711 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
712 downloader
.add_option(
714 action
='store_false', dest
='noresizebuffer',
715 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
716 downloader
.add_option(
717 '--no-resize-buffer',
718 action
='store_true', dest
='noresizebuffer', default
=False,
719 help='Do not automatically adjust the buffer size')
720 downloader
.add_option(
722 dest
='http_chunk_size', metavar
='SIZE', default
=None,
724 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
725 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
726 downloader
.add_option(
728 action
='store_true', dest
='test', default
=False,
729 help=optparse
.SUPPRESS_HELP
)
730 downloader
.add_option(
731 '--playlist-reverse',
733 help='Download playlist videos in reverse order')
734 downloader
.add_option(
735 '--no-playlist-reverse',
736 action
='store_false', dest
='playlist_reverse',
737 help='Download playlist videos in default order (default)')
738 downloader
.add_option(
741 help='Download playlist videos in random order')
742 downloader
.add_option(
743 '--xattr-set-filesize',
744 dest
='xattr_set_filesize', action
='store_true',
745 help='Set file xattribute ytdl.filesize with expected file size')
746 downloader
.add_option(
747 '--hls-prefer-native',
748 dest
='hls_prefer_native', action
='store_true', default
=None,
749 help=optparse
.SUPPRESS_HELP
)
750 downloader
.add_option(
751 '--hls-prefer-ffmpeg',
752 dest
='hls_prefer_native', action
='store_false', default
=None,
753 help=optparse
.SUPPRESS_HELP
)
754 downloader
.add_option(
756 dest
='hls_use_mpegts', action
='store_true', default
=None,
758 'Use the mpegts container for HLS videos; '
759 'allowing some players to play the video while downloading, '
760 'and reducing the chance of file corruption if download is interrupted. '
761 'This is enabled by default for live streams'))
762 downloader
.add_option(
763 '--no-hls-use-mpegts',
764 dest
='hls_use_mpegts', action
='store_false',
766 'Do not use the mpegts container for HLS videos. '
767 'This is default when not downloading live streams'))
768 downloader
.add_option(
769 '--downloader', '--external-downloader',
770 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
771 action
='callback', callback
=_dict_from_options_callback
,
773 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
774 'default_key': 'default',
777 'Name or path of the external downloader to use (optionally) prefixed by '
778 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
779 'Currently supports native, %s (Recommended: aria2c). '
780 'You can use this option multiple times to set different downloaders for different protocols. '
781 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
782 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
783 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
784 downloader
.add_option(
785 '--downloader-args', '--external-downloader-args',
786 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
787 action
='callback', callback
=_dict_from_options_callback
,
789 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()),
790 'default_key': 'default',
791 'process': compat_shlex_split
793 'Give these arguments to the external downloader. '
794 'Specify the downloader name and the arguments separated by a colon ":". '
795 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
796 'You can use this option multiple times to give different arguments to different downloaders '
797 '(Alias: --external-downloader-args)'))
799 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
800 workarounds
.add_option(
802 dest
='encoding', metavar
='ENCODING',
803 help='Force the specified encoding (experimental)')
804 workarounds
.add_option(
805 '--no-check-certificates',
806 action
='store_true', dest
='no_check_certificate', default
=False,
807 help='Suppress HTTPS certificate validation')
808 workarounds
.add_option(
809 '--prefer-insecure', '--prefer-unsecure',
810 action
='store_true', dest
='prefer_insecure',
811 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
812 workarounds
.add_option(
814 metavar
='UA', dest
='user_agent',
815 help='Specify a custom user agent')
816 workarounds
.add_option(
818 metavar
='URL', dest
='referer', default
=None,
819 help='Specify a custom referer, use if the video access is restricted to one domain',
821 workarounds
.add_option(
823 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
824 action
='callback', callback
=_dict_from_options_callback
,
825 callback_kwargs
={'multiple_keys': False, 'process_key': None}
,
826 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
828 workarounds
.add_option(
830 dest
='bidi_workaround', action
='store_true',
831 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
832 workarounds
.add_option(
833 '--sleep-requests', metavar
='SECONDS',
834 dest
='sleep_interval_requests', type=float,
835 help='Number of seconds to sleep between requests during data extraction')
836 workarounds
.add_option(
837 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
838 dest
='sleep_interval', type=float,
840 'Number of seconds to sleep before each download. '
841 'This is the minimum time to sleep when used along with --max-sleep-interval '
842 '(Alias: --min-sleep-interval)'))
843 workarounds
.add_option(
844 '--max-sleep-interval', metavar
='SECONDS',
845 dest
='max_sleep_interval', type=float,
846 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
847 workarounds
.add_option(
848 '--sleep-subtitles', metavar
='SECONDS',
849 dest
='sleep_interval_subtitles', default
=0, type=int,
850 help='Number of seconds to sleep before each subtitle download')
852 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
853 verbosity
.add_option(
855 action
='store_true', dest
='quiet', default
=False,
856 help='Activate quiet mode. If used with --verbose, print the log to stderr')
857 verbosity
.add_option(
859 dest
='no_warnings', action
='store_true', default
=False,
860 help='Ignore warnings')
861 verbosity
.add_option(
863 action
='store_true', dest
='simulate', default
=None,
864 help='Do not download the video and do not write anything to disk')
865 verbosity
.add_option(
867 action
='store_false', dest
='simulate',
868 help='Download the video even if printing/listing options are used')
869 verbosity
.add_option(
870 '--ignore-no-formats-error',
871 action
='store_true', dest
='ignore_no_formats_error', default
=False,
873 'Ignore "No video formats" error. Useful for extracting metadata '
874 'even if the videos are not actually available for download (experimental)'))
875 verbosity
.add_option(
876 '--no-ignore-no-formats-error',
877 action
='store_false', dest
='ignore_no_formats_error',
878 help='Throw error when no downloadable video formats are found (default)')
879 verbosity
.add_option(
880 '--skip-download', '--no-download',
881 action
='store_true', dest
='skip_download', default
=False,
882 help='Do not download the video but write all related files (Alias: --no-download)')
883 verbosity
.add_option(
885 metavar
='TEMPLATE', action
='append', dest
='forceprint',
887 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. '
888 'Either a field name or same syntax as the output template can be used'))
889 verbosity
.add_option(
891 action
='store_true', dest
='geturl', default
=False,
892 help=optparse
.SUPPRESS_HELP
)
893 verbosity
.add_option(
895 action
='store_true', dest
='gettitle', default
=False,
896 help=optparse
.SUPPRESS_HELP
)
897 verbosity
.add_option(
899 action
='store_true', dest
='getid', default
=False,
900 help=optparse
.SUPPRESS_HELP
)
901 verbosity
.add_option(
903 action
='store_true', dest
='getthumbnail', default
=False,
904 help=optparse
.SUPPRESS_HELP
)
905 verbosity
.add_option(
907 action
='store_true', dest
='getdescription', default
=False,
908 help=optparse
.SUPPRESS_HELP
)
909 verbosity
.add_option(
911 action
='store_true', dest
='getduration', default
=False,
912 help=optparse
.SUPPRESS_HELP
)
913 verbosity
.add_option(
915 action
='store_true', dest
='getfilename', default
=False,
916 help=optparse
.SUPPRESS_HELP
)
917 verbosity
.add_option(
919 action
='store_true', dest
='getformat', default
=False,
920 help=optparse
.SUPPRESS_HELP
)
921 verbosity
.add_option(
923 action
='store_true', dest
='dumpjson', default
=False,
924 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
925 verbosity
.add_option(
926 '-J', '--dump-single-json',
927 action
='store_true', dest
='dump_single_json', default
=False,
929 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
930 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
931 verbosity
.add_option(
933 action
='store_true', dest
='print_json', default
=False,
934 help=optparse
.SUPPRESS_HELP
)
935 verbosity
.add_option(
936 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
937 action
='store_true', dest
='force_write_download_archive', default
=False,
939 'Force download archive entries to be written as far as no errors occur, '
940 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
941 verbosity
.add_option(
943 action
='store_true', dest
='progress_with_newline', default
=False,
944 help='Output progress bar as new lines')
945 verbosity
.add_option(
947 action
='store_true', dest
='noprogress', default
=None,
948 help='Do not print progress bar')
949 verbosity
.add_option(
951 action
='store_false', dest
='noprogress',
952 help='Show progress bar, even if in quiet mode')
953 verbosity
.add_option(
955 action
='store_true', dest
='consoletitle', default
=False,
956 help='Display progress in console titlebar')
957 verbosity
.add_option(
958 '--progress-template',
959 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
960 action
='callback', callback
=_dict_from_options_callback
,
962 'allowed_keys': '(download|postprocess)(-title)?',
963 'default_key': 'download'
965 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
966 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
967 'The video\'s fields are accessible under the "info" key and '
968 'the progress attributes are accessible under "progress" key. E.g.: '
969 # TODO: Document the fields inside "progress"
970 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
971 verbosity
.add_option(
973 action
='store_true', dest
='verbose', default
=False,
974 help='Print various debugging information')
975 verbosity
.add_option(
976 '--dump-pages', '--dump-intermediate-pages',
977 action
='store_true', dest
='dump_intermediate_pages', default
=False,
978 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
979 verbosity
.add_option(
981 action
='store_true', dest
='write_pages', default
=False,
982 help='Write downloaded intermediary pages to files in the current directory to debug problems')
983 verbosity
.add_option(
984 '--youtube-print-sig-code',
985 action
='store_true', dest
='youtube_print_sig_code', default
=False,
986 help=optparse
.SUPPRESS_HELP
)
987 verbosity
.add_option(
988 '--print-traffic', '--dump-headers',
989 dest
='debug_printtraffic', action
='store_true', default
=False,
990 help='Display sent and read HTTP traffic')
991 verbosity
.add_option(
993 dest
='call_home', action
='store_true', default
=False,
994 # help='[Broken] Contact the yt-dlp server for debugging')
995 help=optparse
.SUPPRESS_HELP
)
996 verbosity
.add_option(
998 dest
='call_home', action
='store_false',
999 # help='Do not contact the yt-dlp server for debugging (default)')
1000 help=optparse
.SUPPRESS_HELP
)
1002 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1003 filesystem
.add_option(
1004 '-a', '--batch-file',
1005 dest
='batchfile', metavar
='FILE',
1007 'File containing URLs to download ("-" for stdin), one URL per line. '
1008 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1009 filesystem
.add_option(
1011 dest
='batchfile', action
='store_const', const
=None,
1012 help='Do not read URLs from batch file (default)')
1013 filesystem
.add_option(
1014 '--id', default
=False,
1015 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1016 filesystem
.add_option(
1018 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1019 action
='callback', callback
=_dict_from_options_callback
,
1021 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
1022 'default_key': 'home'
1024 'The paths where the files should be downloaded. '
1025 'Specify the type of file and the path separated by a colon ":". '
1026 'All the same TYPES as --output are supported. '
1027 'Additionally, you can also provide "home" (default) and "temp" paths. '
1028 'All intermediary files are first downloaded to the temp path and '
1029 'then the final files are moved over to the home path after download is finished. '
1030 'This option is ignored if --output is an absolute path'))
1031 filesystem
.add_option(
1033 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1034 action
='callback', callback
=_dict_from_options_callback
,
1036 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
1037 'default_key': 'default'
1038 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1039 filesystem
.add_option(
1040 '--output-na-placeholder',
1041 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1042 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
1043 filesystem
.add_option(
1044 '--autonumber-size',
1045 dest
='autonumber_size', metavar
='NUMBER', type=int,
1046 help=optparse
.SUPPRESS_HELP
)
1047 filesystem
.add_option(
1048 '--autonumber-start',
1049 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1050 help=optparse
.SUPPRESS_HELP
)
1051 filesystem
.add_option(
1052 '--restrict-filenames',
1053 action
='store_true', dest
='restrictfilenames', default
=False,
1054 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1055 filesystem
.add_option(
1056 '--no-restrict-filenames',
1057 action
='store_false', dest
='restrictfilenames',
1058 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1059 filesystem
.add_option(
1060 '--windows-filenames',
1061 action
='store_true', dest
='windowsfilenames', default
=False,
1062 help='Force filenames to be Windows-compatible')
1063 filesystem
.add_option(
1064 '--no-windows-filenames',
1065 action
='store_false', dest
='windowsfilenames',
1066 help='Make filenames Windows-compatible only if using Windows (default)')
1067 filesystem
.add_option(
1068 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1069 dest
='trim_file_name', default
=0, type=int,
1070 help='Limit the filename length (excluding extension) to the specified number of characters')
1071 filesystem
.add_option(
1072 '-w', '--no-overwrites',
1073 action
='store_false', dest
='overwrites', default
=None,
1074 help='Do not overwrite any files')
1075 filesystem
.add_option(
1076 '--force-overwrites', '--yes-overwrites',
1077 action
='store_true', dest
='overwrites',
1078 help='Overwrite all video and metadata files. This option includes --no-continue')
1079 filesystem
.add_option(
1080 '--no-force-overwrites',
1081 action
='store_const', dest
='overwrites', const
=None,
1082 help='Do not overwrite the video, but overwrite related files (default)')
1083 filesystem
.add_option(
1085 action
='store_true', dest
='continue_dl', default
=True,
1086 help='Resume partially downloaded files/fragments (default)')
1087 filesystem
.add_option(
1089 action
='store_false', dest
='continue_dl',
1091 'Do not resume partially downloaded fragments. '
1092 'If the file is not fragmented, restart download of the entire file'))
1093 filesystem
.add_option(
1095 action
='store_false', dest
='nopart', default
=False,
1096 help='Use .part files instead of writing directly into output file (default)')
1097 filesystem
.add_option(
1099 action
='store_true', dest
='nopart',
1100 help='Do not use .part files - write directly into output file')
1101 filesystem
.add_option(
1103 action
='store_true', dest
='updatetime', default
=True,
1104 help='Use the Last-modified header to set the file modification time (default)')
1105 filesystem
.add_option(
1107 action
='store_false', dest
='updatetime',
1108 help='Do not use the Last-modified header to set the file modification time')
1109 filesystem
.add_option(
1110 '--write-description',
1111 action
='store_true', dest
='writedescription', default
=False,
1112 help='Write video description to a .description file')
1113 filesystem
.add_option(
1114 '--no-write-description',
1115 action
='store_false', dest
='writedescription',
1116 help='Do not write video description (default)')
1117 filesystem
.add_option(
1118 '--write-info-json',
1119 action
='store_true', dest
='writeinfojson', default
=False,
1120 help='Write video metadata to a .info.json file (this may contain personal information)')
1121 filesystem
.add_option(
1122 '--no-write-info-json',
1123 action
='store_false', dest
='writeinfojson',
1124 help='Do not write video metadata (default)')
1125 filesystem
.add_option(
1126 '--write-annotations',
1127 action
='store_true', dest
='writeannotations', default
=False,
1128 help=optparse
.SUPPRESS_HELP
)
1129 filesystem
.add_option(
1130 '--no-write-annotations',
1131 action
='store_false', dest
='writeannotations',
1132 help=optparse
.SUPPRESS_HELP
)
1133 filesystem
.add_option(
1134 '--write-playlist-metafiles',
1135 action
='store_true', dest
='allow_playlist_files', default
=None,
1137 'Write playlist metadata in addition to the video metadata '
1138 'when using --write-info-json, --write-description etc. (default)'))
1139 filesystem
.add_option(
1140 '--no-write-playlist-metafiles',
1141 action
='store_false', dest
='allow_playlist_files',
1142 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1143 filesystem
.add_option(
1145 action
='store_true', dest
='clean_infojson', default
=None,
1147 'Remove some private fields such as filenames from the infojson. '
1148 'Note that it could still contain some personal information (default)'))
1149 filesystem
.add_option(
1150 '--no-clean-infojson',
1151 action
='store_false', dest
='clean_infojson',
1152 help='Write all fields to the infojson')
1153 filesystem
.add_option(
1154 '--write-comments', '--get-comments',
1155 action
='store_true', dest
='getcomments', default
=False,
1157 'Retrieve video comments to be placed in the infojson. '
1158 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1159 filesystem
.add_option(
1160 '--no-write-comments', '--no-get-comments',
1161 action
='store_false', dest
='getcomments',
1162 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1163 filesystem
.add_option(
1164 '--load-info-json', '--load-info',
1165 dest
='load_info_filename', metavar
='FILE',
1166 help='JSON file containing the video information (created with the "--write-info-json" option)')
1167 filesystem
.add_option(
1169 dest
='cookiefile', metavar
='FILE',
1170 help='Netscape formatted file to read cookies from and dump cookie jar in')
1171 filesystem
.add_option(
1173 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1174 help='Do not read/dump cookies from/to file (default)')
1175 filesystem
.add_option(
1176 '--cookies-from-browser',
1177 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE]',
1179 'The name of the browser and (optionally) the name/path of '
1180 'the profile to load cookies from, separated by a ":". '
1181 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1182 'By default, the most recently accessed profile is used. '
1183 'The keyring used for decrypting Chromium cookies on Linux can be '
1184 '(optionally) specified after the browser name separated by a "+". '
1185 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1186 filesystem
.add_option(
1187 '--no-cookies-from-browser',
1188 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1189 help='Do not load cookies from browser (default)')
1190 filesystem
.add_option(
1191 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1192 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')
1193 filesystem
.add_option(
1194 '--no-cache-dir', action
='store_false', dest
='cachedir',
1195 help='Disable filesystem caching')
1196 filesystem
.add_option(
1198 action
='store_true', dest
='rm_cachedir',
1199 help='Delete all filesystem cache files')
1201 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1202 thumbnail
.add_option(
1203 '--write-thumbnail',
1204 action
='callback', dest
='writethumbnail', default
=False,
1205 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1206 callback
=lambda option
, _
, __
, parser
: setattr(
1207 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1208 help='Write thumbnail image to disk')
1209 thumbnail
.add_option(
1210 '--no-write-thumbnail',
1211 action
='store_false', dest
='writethumbnail',
1212 help='Do not write thumbnail image to disk (default)')
1213 thumbnail
.add_option(
1214 '--write-all-thumbnails',
1215 action
='store_const', dest
='writethumbnail', const
='all',
1216 help='Write all thumbnail image formats to disk')
1217 thumbnail
.add_option(
1218 '--list-thumbnails',
1219 action
='store_true', dest
='list_thumbnails', default
=False,
1220 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1222 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1225 action
='store_true', dest
='writelink', default
=False,
1226 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1229 action
='store_true', dest
='writeurllink', default
=False,
1230 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1232 '--write-webloc-link',
1233 action
='store_true', dest
='writewebloclink', default
=False,
1234 help='Write a .webloc macOS internet shortcut')
1236 '--write-desktop-link',
1237 action
='store_true', dest
='writedesktoplink', default
=False,
1238 help='Write a .desktop Linux internet shortcut')
1240 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1241 postproc
.add_option(
1242 '-x', '--extract-audio',
1243 action
='store_true', dest
='extractaudio', default
=False,
1244 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1245 postproc
.add_option(
1246 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1248 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1249 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1250 postproc
.add_option(
1251 '--audio-quality', metavar
='QUALITY',
1252 dest
='audioquality', default
='5',
1253 help='Specify ffmpeg audio quality, insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')
1254 postproc
.add_option(
1256 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1258 'Remux the video into another container if necessary (currently supported: %s). '
1259 'If target container does not support the video/audio codec, remuxing will fail. '
1260 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1261 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1262 postproc
.add_option(
1264 metavar
='FORMAT', dest
='recodevideo', default
=None,
1266 'Re-encode the video into another format if re-encoding is necessary. '
1267 'The syntax and supported formats are the same as --remux-video'))
1268 postproc
.add_option(
1269 '--postprocessor-args', '--ppa',
1270 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1271 action
='callback', callback
=_dict_from_options_callback
,
1273 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1274 'process': compat_shlex_split
,
1275 'multiple_keys': False
1277 'Give these arguments to the postprocessors. '
1278 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1279 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1280 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1281 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1282 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1283 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1284 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1285 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1286 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1287 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1288 'You can use this option multiple times to give different arguments to different '
1289 'postprocessors. (Alias: --ppa)'))
1290 postproc
.add_option(
1291 '-k', '--keep-video',
1292 action
='store_true', dest
='keepvideo', default
=False,
1293 help='Keep the intermediate video file on disk after post-processing')
1294 postproc
.add_option(
1296 action
='store_false', dest
='keepvideo',
1297 help='Delete the intermediate video file after post-processing (default)')
1298 postproc
.add_option(
1299 '--post-overwrites',
1300 action
='store_false', dest
='nopostoverwrites',
1301 help='Overwrite post-processed files (default)')
1302 postproc
.add_option(
1303 '--no-post-overwrites',
1304 action
='store_true', dest
='nopostoverwrites', default
=False,
1305 help='Do not overwrite post-processed files')
1306 postproc
.add_option(
1308 action
='store_true', dest
='embedsubtitles', default
=False,
1309 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1310 postproc
.add_option(
1312 action
='store_false', dest
='embedsubtitles',
1313 help='Do not embed subtitles (default)')
1314 postproc
.add_option(
1315 '--embed-thumbnail',
1316 action
='store_true', dest
='embedthumbnail', default
=False,
1317 help='Embed thumbnail in the video as cover art')
1318 postproc
.add_option(
1319 '--no-embed-thumbnail',
1320 action
='store_false', dest
='embedthumbnail',
1321 help='Do not embed thumbnail (default)')
1322 postproc
.add_option(
1323 '--embed-metadata', '--add-metadata',
1324 action
='store_true', dest
='addmetadata', default
=False,
1326 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1327 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1328 postproc
.add_option(
1329 '--no-embed-metadata', '--no-add-metadata',
1330 action
='store_false', dest
='addmetadata',
1331 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1332 postproc
.add_option(
1333 '--embed-chapters', '--add-chapters',
1334 action
='store_true', dest
='addchapters', default
=None,
1335 help='Add chapter markers to the video file (Alias: --add-chapters)')
1336 postproc
.add_option(
1337 '--no-embed-chapters', '--no-add-chapters',
1338 action
='store_false', dest
='addchapters',
1339 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1340 postproc
.add_option(
1341 '--embed-info-json',
1342 action
='store_true', dest
='embed_infojson', default
=None,
1343 help='Embed the infojson as an attachment to mkv/mka video files')
1344 postproc
.add_option(
1345 '--no-embed-info-json',
1346 action
='store_false', dest
='embed_infojson',
1347 help='Do not embed the infojson as an attachment to the video file')
1348 postproc
.add_option(
1349 '--metadata-from-title',
1350 metavar
='FORMAT', dest
='metafromtitle',
1351 help=optparse
.SUPPRESS_HELP
)
1352 postproc
.add_option(
1354 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1356 'Parse additional metadata like title/artist from other fields; '
1357 'see "MODIFYING METADATA" for details'))
1358 postproc
.add_option(
1359 '--replace-in-metadata',
1360 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1361 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1362 postproc
.add_option(
1364 action
='store_true', dest
='xattrs', default
=False,
1365 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1366 postproc
.add_option(
1368 metavar
='POLICY', dest
='fixup', default
=None,
1369 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1371 'Automatically correct known faults of the file. '
1372 'One of never (do nothing), warn (only emit a warning), '
1373 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1374 'force (try fixing even if file already exists)'))
1375 postproc
.add_option(
1376 '--prefer-avconv', '--no-prefer-ffmpeg',
1377 action
='store_false', dest
='prefer_ffmpeg',
1378 help=optparse
.SUPPRESS_HELP
)
1379 postproc
.add_option(
1380 '--prefer-ffmpeg', '--no-prefer-avconv',
1381 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1382 help=optparse
.SUPPRESS_HELP
)
1383 postproc
.add_option(
1384 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1385 dest
='ffmpeg_location',
1386 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1387 postproc
.add_option(
1388 '--exec', metavar
='CMD',
1389 action
='append', dest
='exec_cmd',
1391 'Execute a command on the file after downloading and post-processing. '
1392 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1393 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1394 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1395 'This option can be used multiple times'))
1396 postproc
.add_option(
1398 action
='store_const', dest
='exec_cmd', const
=[],
1399 help='Remove any previously defined --exec')
1400 postproc
.add_option(
1401 '--exec-before-download', metavar
='CMD',
1402 action
='append', dest
='exec_before_dl_cmd',
1404 'Execute a command before the actual download. '
1405 'The syntax is the same as --exec but "filepath" is not available. '
1406 'This option can be used multiple times'))
1407 postproc
.add_option(
1408 '--no-exec-before-download',
1409 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1410 help='Remove any previously defined --exec-before-download')
1411 postproc
.add_option(
1412 '--convert-subs', '--convert-sub', '--convert-subtitles',
1413 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1415 'Convert the subtitles to another format (currently supported: %s) '
1416 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1417 postproc
.add_option(
1418 '--convert-thumbnails',
1419 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1421 'Convert the thumbnails to another format '
1422 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1423 postproc
.add_option(
1424 '--split-chapters', '--split-tracks',
1425 dest
='split_chapters', action
='store_true', default
=False,
1427 'Split video into multiple files based on internal chapters. '
1428 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1429 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1430 postproc
.add_option(
1431 '--no-split-chapters', '--no-split-tracks',
1432 dest
='split_chapters', action
='store_false',
1433 help='Do not split video based on chapters (default)')
1434 postproc
.add_option(
1435 '--remove-chapters',
1436 metavar
='REGEX', dest
='remove_chapters', action
='append',
1438 'Remove chapters whose title matches the given regular expression. '
1439 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1440 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1441 'This option can be used multiple times'))
1442 postproc
.add_option(
1443 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1444 help='Do not remove any chapters from the file (default)')
1445 postproc
.add_option(
1446 '--force-keyframes-at-cuts',
1447 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1449 'Force keyframes around the chapters before removing/splitting them. '
1450 'Requires a re-encode and thus is very slow, but the resulting video '
1451 'may have fewer artifacts around the cuts'))
1452 postproc
.add_option(
1453 '--no-force-keyframes-at-cuts',
1454 action
='store_false', dest
='force_keyframes_at_cuts',
1455 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1456 _postprocessor_opts_parser
= lambda key
, val
='': (
1457 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1458 ('key', remove_end(key
, 'PP')))
1459 postproc
.add_option(
1460 '--use-postprocessor',
1461 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1462 action
='callback', callback
=_list_from_options_callback
,
1465 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1467 'The (case sensitive) name of plugin postprocessors to be enabled, '
1468 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1469 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1470 'The "when" argument determines when the postprocessor is invoked. '
1471 'It can be one of "pre_process" (after extraction), '
1472 '"before_dl" (before video download), "post_process" (after video download; default) '
1473 'or "after_move" (after moving file to their final locations). '
1474 'This option can be used multiple times to add different postprocessors'))
1476 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1477 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1478 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1479 sponsorblock
.add_option(
1480 '--sponsorblock-mark', metavar
='CATS',
1481 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1482 callback
=_set_from_options_callback
, callback_kwargs
={
1483 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1484 'aliases': {'default': ['all']}
1486 'SponsorBlock categories to create chapters for, separated by commas. '
1487 f
'Available categories are all, default(=all), {", ".join(SponsorBlockPP.CATEGORIES.keys())}. '
1488 'You can prefix the category with a "-" to exempt it. See [1] for description of the categories. '
1489 'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1490 sponsorblock
.add_option(
1491 '--sponsorblock-remove', metavar
='CATS',
1492 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1493 callback
=_set_from_options_callback
, callback_kwargs
={
1494 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.POI_CATEGORIES
.keys()),
1495 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1496 # The filler category is very aggressive.
1497 # It is strongly recommended to not use this in a client by default.
1498 'aliases': {'default': ['all', '-filler']}
1500 'SponsorBlock categories to be removed from the video file, separated by commas. '
1501 'If a category is present in both mark and remove, remove takes precedence. '
1502 'The syntax and available categories are the same as for --sponsorblock-mark '
1503 'except that "default" refers to "all,-filler" '
1504 f
'and {", ".join(SponsorBlockPP.POI_CATEGORIES.keys())} is not available'))
1505 sponsorblock
.add_option(
1506 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1507 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1509 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1510 'The same syntax as the output template is used, but the only available fields are '
1511 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1512 sponsorblock
.add_option(
1513 '--no-sponsorblock', default
=False,
1514 action
='store_true', dest
='no_sponsorblock',
1515 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1516 sponsorblock
.add_option(
1517 '--sponsorblock-api', metavar
='URL',
1518 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1519 help='SponsorBlock API location, defaults to %default')
1521 sponsorblock
.add_option(
1523 action
='store_true', dest
='sponskrub', default
=False,
1524 help=optparse
.SUPPRESS_HELP
)
1525 sponsorblock
.add_option(
1527 action
='store_false', dest
='sponskrub',
1528 help=optparse
.SUPPRESS_HELP
)
1529 sponsorblock
.add_option(
1530 '--sponskrub-cut', default
=False,
1531 action
='store_true', dest
='sponskrub_cut',
1532 help=optparse
.SUPPRESS_HELP
)
1533 sponsorblock
.add_option(
1534 '--no-sponskrub-cut',
1535 action
='store_false', dest
='sponskrub_cut',
1536 help=optparse
.SUPPRESS_HELP
)
1537 sponsorblock
.add_option(
1538 '--sponskrub-force', default
=False,
1539 action
='store_true', dest
='sponskrub_force',
1540 help=optparse
.SUPPRESS_HELP
)
1541 sponsorblock
.add_option(
1542 '--no-sponskrub-force',
1543 action
='store_true', dest
='sponskrub_force',
1544 help=optparse
.SUPPRESS_HELP
)
1545 sponsorblock
.add_option(
1546 '--sponskrub-location', metavar
='PATH',
1547 dest
='sponskrub_path', default
='',
1548 help=optparse
.SUPPRESS_HELP
)
1549 sponsorblock
.add_option(
1550 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1551 help=optparse
.SUPPRESS_HELP
)
1553 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1554 extractor
.add_option(
1555 '--extractor-retries',
1556 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1557 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1558 extractor
.add_option(
1559 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1560 action
='store_true', dest
='dynamic_mpd', default
=True,
1561 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1562 extractor
.add_option(
1563 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1564 action
='store_false', dest
='dynamic_mpd',
1565 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1566 extractor
.add_option(
1567 '--hls-split-discontinuity',
1568 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1569 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1571 extractor
.add_option(
1572 '--no-hls-split-discontinuity',
1573 dest
='hls_split_discontinuity', action
='store_false',
1574 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1575 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1576 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1577 extractor
.add_option(
1579 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1580 action
='callback', callback
=_dict_from_options_callback
,
1582 'multiple_keys': False,
1583 'process': lambda val
: dict(
1584 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1586 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1587 'You can use this option multiple times to give arguments for different extractors'))
1588 extractor
.add_option(
1589 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1590 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1591 help=optparse
.SUPPRESS_HELP
)
1592 extractor
.add_option(
1593 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1594 action
='store_false', dest
='youtube_include_dash_manifest',
1595 help=optparse
.SUPPRESS_HELP
)
1596 extractor
.add_option(
1597 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1598 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1599 help=optparse
.SUPPRESS_HELP
)
1600 extractor
.add_option(
1601 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1602 action
='store_false', dest
='youtube_include_hls_manifest',
1603 help=optparse
.SUPPRESS_HELP
)
1605 parser
.add_option_group(general
)
1606 parser
.add_option_group(network
)
1607 parser
.add_option_group(geo
)
1608 parser
.add_option_group(selection
)
1609 parser
.add_option_group(downloader
)
1610 parser
.add_option_group(filesystem
)
1611 parser
.add_option_group(thumbnail
)
1612 parser
.add_option_group(link
)
1613 parser
.add_option_group(verbosity
)
1614 parser
.add_option_group(workarounds
)
1615 parser
.add_option_group(video_format
)
1616 parser
.add_option_group(subtitles
)
1617 parser
.add_option_group(authentication
)
1618 parser
.add_option_group(postproc
)
1619 parser
.add_option_group(sponsorblock
)
1620 parser
.add_option_group(extractor
)
1622 if overrideArguments
is not None:
1623 opts
, args
= parser
.parse_args(overrideArguments
)
1625 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1627 def compat_conf(conf
):
1628 if sys
.version_info
< (3,):
1629 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1633 'command-line': compat_conf(sys
.argv
[1:]),
1634 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1635 paths
= {'command-line': False}
1637 def read_options(name
, path
, user
=False):
1638 ''' loads config files and returns ignoreconfig '''
1639 # Multiple package names can be given here
1640 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1641 # the configuration file of any of these three packages
1642 for package
in ('yt-dlp',):
1644 config
, current_path
= _readUserConf(package
, default
=None)
1646 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1647 config
= _readOptions(current_path
, default
=None)
1648 if config
is not None:
1649 current_path
= os
.path
.realpath(current_path
)
1650 if current_path
in paths
.values():
1652 configs
[name
], paths
[name
] = config
, current_path
1653 return parser
.parse_args(config
)[0].ignoreconfig
1657 opts
, _
= parser
.parse_args(configs
['command-line'])
1658 if opts
.config_location
is not None:
1659 location
= compat_expanduser(opts
.config_location
)
1660 if os
.path
.isdir(location
):
1661 location
= os
.path
.join(location
, 'yt-dlp.conf')
1662 if not os
.path
.exists(location
):
1663 parser
.error('config-location %s does not exist.' % location
)
1664 config
= _readOptions(location
, default
=None)
1666 configs
['custom'], paths
['custom'] = config
, location
1668 if opts
.ignoreconfig
:
1670 if parser
.parse_args(configs
['custom'])[0].ignoreconfig
:
1672 if read_options('portable', get_executable_path()):
1674 opts
, _
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])
1675 if read_options('home', expand_path(opts
.paths
.get('home', '')).strip()):
1677 if read_options('system', '/etc'):
1679 if read_options('user', None, user
=True):
1680 configs
['system'], paths
['system'] = [], None
1683 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1684 opts
, args
= parser
.parse_args(argv
)
1686 for label
in ('Command-line', 'Custom', 'Portable', 'Home', 'User', 'System'):
1689 write_string(f
'[debug] {label} config file: {paths[key]}\n')
1690 if paths
.get(key
) is not None:
1691 write_string(f
'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
1693 return parser
, opts
, args