join_nonempty,
orderedSet_from_options,
remove_end,
+ variadic,
write_string,
)
from .version import CHANNEL, __version__
if multiple_args:
val = [val, *value[1:]]
elif default_key is not None:
- keys, val = [default_key], value
+ keys, val = variadic(default_key), value
else:
raise optparse.OptionValueError(
f'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
help='Print program version and exit')
general.add_option(
'-U', '--update',
- action='store_true', dest='update_self',
+ action='store_const', dest='update_self', const=CHANNEL,
help=format_field(
is_non_updateable(), None, 'Check if updates are available. %s',
default=f'Update this program to the latest {CHANNEL} version'))
'--update-to',
action='store', dest='update_self', metavar='[CHANNEL]@[TAG]',
help=(
- 'Upgrade/downgrade to a specific version. CHANNEL and TAG defaults to '
- f'"{CHANNEL}" and "latest" respectively if omitted; See "UPDATE" for details. '
- f'Supported channels: {", ".join(UPDATE_SOURCES)}'))
+ 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
+ f'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
+ f'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
general.add_option(
'-i', '--ignore-errors',
action='store_true', dest='ignoreerrors',
general.add_option(
'--no-flat-playlist',
action='store_false', dest='extract_flat',
- help='Extract the videos of a playlist')
+ help='Fully extract the videos of a playlist (default)')
general.add_option(
'--live-from-start',
action='store_true', dest='live_from_start',
help='Do not mark videos watched (default)')
general.add_option(
'--no-colors', '--no-colours',
- action='store_true', dest='no_color', default=False,
- help='Do not emit color codes in output (Alias: --no-colours)')
+ action='store_const', dest='color', const={
+ 'stdout': 'no_color',
+ 'stderr': 'no_color',
+ },
+ help=optparse.SUPPRESS_HELP)
+ general.add_option(
+ '--color',
+ dest='color', metavar='[STREAM:]POLICY', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': 'stdout|stderr',
+ 'default_key': ['stdout', 'stderr'],
+ 'process': str.strip,
+ }, help=(
+ 'Whether to emit color codes in output, optionally prefixed by '
+ 'the STREAM (stdout or stderr) to apply the setting to. '
+ 'Can be one of "always", "auto" (default), "never", or '
+ '"no_color" (use non color terminal sequences). '
+ 'Can be used multiple times'))
general.add_option(
'--compat-options',
metavar='OPTS', dest='compat_opts', default=set(), type='str',
callback_kwargs={
'allowed_values': {
'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
- 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
+ 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter',
'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
+ 'prefer-legacy-http-handler'
}, 'aliases': {
- 'youtube-dl': ['all', '-multistreams'],
- 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat'],
+ 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter'],
+ 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter'],
'2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'],
- '2022': ['no-external-downloader-progress'],
+ '2022': ['no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler'],
}
}, help=(
'Options that can help keep compatibility with youtube-dl or youtube-dlc '
'--cn-verification-proxy',
dest='cn_verification_proxy', default=None, metavar='URL',
help=optparse.SUPPRESS_HELP)
+ geo.add_option(
+ '--xff', metavar='VALUE',
+ dest='geo_bypass', default='default',
+ help=(
+ 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
+ 'One of "default" (only when known to be useful), "never", '
+ 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
geo.add_option(
'--geo-bypass',
- action='store_true', dest='geo_bypass', default=True,
- help='Bypass geographic restriction via faking X-Forwarded-For HTTP header (default)')
+ action='store_const', dest='geo_bypass', const='default',
+ help=optparse.SUPPRESS_HELP)
geo.add_option(
'--no-geo-bypass',
- action='store_false', dest='geo_bypass',
- help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
+ action='store_const', dest='geo_bypass', const='never',
+ help=optparse.SUPPRESS_HELP)
geo.add_option(
- '--geo-bypass-country', metavar='CODE',
- dest='geo_bypass_country', default=None,
- help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
+ '--geo-bypass-country', metavar='CODE', dest='geo_bypass',
+ help=optparse.SUPPRESS_HELP)
geo.add_option(
- '--geo-bypass-ip-block', metavar='IP_BLOCK',
- dest='geo_bypass_ip_block', default=None,
- help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
+ '--geo-bypass-ip-block', metavar='IP_BLOCK', dest='geo_bypass',
+ help=optparse.SUPPRESS_HELP)
selection = optparse.OptionGroup(parser, 'Video Selection')
selection.add_option(
'that contains the phrase "cats & dogs" (caseless). '
'Use "--match-filter -" to interactively ask whether to download each video'))
selection.add_option(
- '--no-match-filter',
+ '--no-match-filters',
dest='match_filter', action='store_const', const=None,
help='Do not use any --match-filter (default)')
selection.add_option(
'--netrc-location',
dest='netrc_location', metavar='PATH',
help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
+ authentication.add_option(
+ '--netrc-cmd',
+ dest='netrc_cmd', metavar='NETRC_CMD',
+ help='Command to execute to get the credentials for an extractor.')
authentication.add_option(
'--video-password',
dest='videopassword', metavar='PASSWORD',
- help='Video password (vimeo, youku)')
+ help='Video-specific password')
authentication.add_option(
'--ap-mso',
dest='ap_mso', metavar='MSO',
'--download-sections',
metavar='REGEX', dest='download_ranges', action='append',
help=(
- 'Download only chapters whose title matches the given regular expression. '
- 'Time ranges prefixed by a "*" can also be used in place of chapters to download the specified range. '
+ 'Download only chapters that match the regular expression. '
+ 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
+ '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
downloader.add_option(
'--clean-info-json', '--clean-infojson',
action='store_true', dest='clean_infojson', default=None,
help=(
- 'Remove some private fields such as filenames from the infojson. '
- 'Note that it could still contain some personal information (default)'))
+ 'Remove some internal metadata such as filenames from the infojson (default)'))
filesystem.add_option(
'--no-clean-info-json', '--no-clean-infojson',
action='store_false', dest='clean_infojson',
'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
'Same syntax as the output template can be used to pass any field as arguments to the command. '
- 'After download, an additional field "filepath" that contains the final path of the downloaded file '
- 'is also available, and if no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
+ 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
'This option can be used multiple times'))
postproc.add_option(
'--no-exec',
projects / yt-dlp.git / blobdiff