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