compat_shlex_split,
)
from .utils import (
+ expand_path,
+ get_executable_path,
preferredencoding,
write_string,
)
optionf.close()
return res
- def _readUserConf():
- xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
- if xdg_config_home:
- userConfFile = os.path.join(xdg_config_home, 'youtube-dlc', 'config')
- if not os.path.isfile(userConfFile):
- userConfFile = os.path.join(xdg_config_home, 'youtube-dlc.conf')
- else:
- userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dlc', 'config')
- if not os.path.isfile(userConfFile):
- userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dlc.conf')
- userConf = _readOptions(userConfFile, None)
-
- if userConf is None:
- appdata_dir = compat_getenv('appdata')
- if appdata_dir:
- userConf = _readOptions(
- os.path.join(appdata_dir, 'youtube-dlc', 'config'),
- default=None)
- if userConf is None:
- userConf = _readOptions(
- os.path.join(appdata_dir, 'youtube-dlc', 'config.txt'),
- default=None)
+ def _readUserConf(package_name, default=[]):
+ # .config
+ xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
+ userConfFile = os.path.join(xdg_config_home, package_name, 'config')
+ if not os.path.isfile(userConfFile):
+ userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name)
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
- if userConf is None:
- userConf = _readOptions(
- os.path.join(compat_expanduser('~'), 'youtube-dlc.conf'),
- default=None)
- if userConf is None:
- userConf = _readOptions(
- os.path.join(compat_expanduser('~'), 'youtube-dlc.conf.txt'),
- default=None)
+ # appdata
+ appdata_dir = compat_getenv('appdata')
+ if appdata_dir:
+ userConfFile = os.path.join(appdata_dir, package_name, 'config')
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is None:
+ userConfFile += '.txt'
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
+ # home
+ userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
+ userConf = _readOptions(userConfFile, default=None)
if userConf is None:
- userConf = []
+ userConfFile += '.txt'
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
- return userConf
+ return default, None
def _format_option_string(option):
''' ('-o', '--option') -> -o, --format METAVAR'''
def _comma_separated_values_options_callback(option, opt_str, value, parser):
setattr(parser.values, option.dest, value.split(','))
+ def _dict_from_multiple_values_options_callback(
+ option, opt_str, value, parser, allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None):
+
+ out_dict = getattr(parser.values, option.dest)
+ mobj = re.match(r'(?i)(?P<key>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value)
+ if mobj is not None:
+ key, val = mobj.group('key').lower(), mobj.group('val')
+ elif default_key is not None:
+ key, val = default_key, value
+ else:
+ raise optparse.OptionValueError(
+ 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value))
+ out_dict[key] = process(val) if callable(process) else val
+
# No need to wrap help messages if we're on a wide console
columns = compat_get_terminal_size().columns
max_width = columns if columns else 80
general.add_option(
'-U', '--update',
action='store_true', dest='update_self',
- help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
+ help='[BROKEN] Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
general.add_option(
- '-i', '--ignore-errors',
- action='store_true', dest='ignoreerrors', default=False,
- help='Continue on download errors, for example to skip unavailable videos in a playlist')
+ '-i', '--ignore-errors', '--no-abort-on-error',
+ action='store_true', dest='ignoreerrors', default=True,
+ help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
general.add_option(
- '--abort-on-error',
+ '--abort-on-error', '--no-ignore-errors',
action='store_false', dest='ignoreerrors',
- help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
+ help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
general.add_option(
'--dump-user-agent',
action='store_true', dest='dump_user_agent', default=False,
general.add_option(
'--default-search',
dest='default_search', metavar='PREFIX',
- help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dlc "large apple". Use the value "auto" to let youtube-dlc 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.')
+ help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl 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')
general.add_option(
- '--ignore-config',
+ '--ignore-config', '--no-config',
action='store_true',
- help='Do not read configuration files. '
- 'When given in the global configuration file /etc/youtube-dlc.conf: '
- 'Do not read the user configuration in ~/.config/youtube-dlc/config '
- '(%APPDATA%/youtube-dlc/config.txt on Windows)')
+ help=(
+ 'Disable loading any configuration files except the one provided by --config-location. '
+ 'When given inside a configuration file, no further configuration files are loaded. '
+ 'Additionally, (for backward compatibility) if this option is found inside the '
+ 'system configuration file, the user configuration is not loaded'))
general.add_option(
'--config-location',
dest='config_location', metavar='PATH',
- help='Location of the configuration file; either the path to the config or its containing directory.')
+ help='Location of the main configuration file; either the path to the config or its containing directory')
general.add_option(
'--flat-playlist',
- action='store_const', dest='extract_flat', const='in_playlist',
- default=False,
- help='Do not extract the videos of a playlist, only list them.')
+ action='store_const', dest='extract_flat', const='in_playlist', default=False,
+ help='Do not extract the videos of a playlist, only list them')
+ general.add_option(
+ '--flat-videos',
+ action='store_true', dest='extract_flat',
+ help='Do not resolve the video urls')
+ general.add_option(
+ '--no-flat-playlist',
+ action='store_false', dest='extract_flat',
+ help='Extract the videos of a playlist')
general.add_option(
'--mark-watched',
action='store_true', dest='mark_watched', default=False,
general.add_option(
'--no-mark-watched',
action='store_false', dest='mark_watched', default=False,
- help='Do not mark videos watched (YouTube only)')
+ help='Do not mark videos watched')
general.add_option(
- '--no-color', '--no-colors',
+ '--no-colors',
action='store_true', dest='no_color',
default=False,
help='Do not emit color codes in output')
network.add_option(
'--proxy', dest='proxy',
default=None, metavar='URL',
- help='Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
- 'SOCKS proxy, specify a proper scheme. For example '
- 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
- 'for direct connection')
+ help=(
+ 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
+ 'SOCKS proxy, specify a proper scheme. For example '
+ 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
+ 'for direct connection'))
network.add_option(
'--socket-timeout',
dest='socket_timeout', type=float, default=None, metavar='SECONDS',
geo.add_option(
'--geo-verification-proxy',
dest='geo_verification_proxy', default=None, metavar='URL',
- help='Use this proxy to verify the IP address for some geo-restricted sites. '
- 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading.')
+ help=(
+ 'Use this proxy to verify the IP address for some geo-restricted sites. '
+ 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
geo.add_option(
'--cn-verification-proxy',
dest='cn_verification_proxy', default=None, metavar='URL',
selection.add_option(
'--playlist-items',
dest='playlist_items', metavar='ITEM_SPEC', default=None,
- 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.')
+ 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')
selection.add_option(
'--match-title',
dest='matchtitle', metavar='REGEX',
selection.add_option(
'--date',
metavar='DATE', dest='date', default=None,
- help='Download only videos uploaded in this date')
+ help=(
+ 'Download only videos uploaded in this date. '
+ 'The date can be "YYYYMMDD" or in the format '
+ '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
selection.add_option(
'--datebefore',
metavar='DATE', dest='datebefore', default=None,
- help='Download only videos uploaded on or before this date (i.e. inclusive)')
+ help=(
+ 'Download only videos uploaded on or before this date. '
+ 'The date formats accepted is the same as --date'))
selection.add_option(
'--dateafter',
metavar='DATE', dest='dateafter', default=None,
- help='Download only videos uploaded on or after this date (i.e. inclusive)')
+ help=(
+ 'Download only videos uploaded on or after this date. '
+ 'The date formats accepted is the same as --date'))
selection.add_option(
'--min-views',
metavar='COUNT', dest='min_views', default=None, type=int,
metavar='FILTER', dest='match_filter', default=None,
help=(
'Generic video filter. '
- 'Specify any key (see the "OUTPUT TEMPLATE" for a list of available keys) to '
+ 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
'match if the key is present, '
'!key to check if the key is not present, '
- 'key > NUMBER (like "comment_count > 12", also works with '
+ 'key>NUMBER (like "comment_count > 12", also works with '
'>=, <, <=, !=, =) to compare against a number, '
'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
'to match against a string literal '
'100 times and disliked less than 50 times (or the dislike '
'functionality is not available at the given service), but who '
'also have a description, use --match-filter '
- '"like_count > 100 & dislike_count <? 50 & description" .'
- ))
+ '"like_count > 100 & dislike_count <? 50 & description"'))
+ selection.add_option(
+ '--no-match-filter',
+ metavar='FILTER', dest='match_filter', action='store_const', const=None,
+ help='Do not use generic video filter (default)')
selection.add_option(
'--no-playlist',
action='store_true', dest='noplaylist', default=False,
- help='Download only the video, if the URL refers to a video and a playlist.')
+ help='Download only the video, if the URL refers to a video and a playlist')
selection.add_option(
'--yes-playlist',
action='store_false', dest='noplaylist', default=False,
- help='Download the playlist, if the URL refers to a video and a playlist.')
+ help='Download the playlist, if the URL refers to a video and a playlist')
selection.add_option(
'--age-limit',
metavar='YEARS', dest='age_limit', default=None, type=int,
selection.add_option(
'--download-archive', metavar='FILE',
dest='download_archive',
- help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
+ help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
+ selection.add_option(
+ '--break-on-existing',
+ action='store_true', dest='break_on_existing', default=False,
+ help='Stop the download process when encountering a file that is in the archive')
+ selection.add_option(
+ '--break-on-reject',
+ action='store_true', dest='break_on_reject', default=False,
+ help='Stop the download process when encountering a file that has been filtered out')
+ selection.add_option(
+ '--no-download-archive',
+ dest='download_archive', action="store_const", const=None,
+ help='Do not use archive file (default)')
selection.add_option(
'--include-ads',
dest='include_ads', action='store_true',
help='Download advertisements as well (experimental)')
+ selection.add_option(
+ '--no-include-ads',
+ dest='include_ads', action='store_false',
+ help='Do not download advertisements (default)')
authentication = optparse.OptionGroup(parser, 'Authentication Options')
authentication.add_option(
authentication.add_option(
'-p', '--password',
dest='password', metavar='PASSWORD',
- help='Account password. If this option is left out, youtube-dlc will ask interactively.')
+ help='Account password. If this option is left out, youtube-dlc will ask interactively')
authentication.add_option(
'-2', '--twofactor',
dest='twofactor', metavar='TWOFACTOR',
authentication.add_option(
'--video-password',
dest='videopassword', metavar='PASSWORD',
- help='Video password (vimeo, smotri, youku)')
+ help='Video password (vimeo, youku)')
adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
adobe_pass.add_option(
adobe_pass.add_option(
'--ap-password',
dest='ap_password', metavar='PASSWORD',
- help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively.')
+ help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively')
adobe_pass.add_option(
'--ap-list-mso',
action='store_true', dest='ap_list_mso', default=False,
video_format.add_option(
'-f', '--format',
action='store', dest='format', metavar='FORMAT', default=None,
- help='Video format code, see the "FORMAT SELECTION" for all the info')
+ help='Video format code, see "FORMAT SELECTION" for more details')
+ video_format.add_option(
+ '-S', '--format-sort', metavar='SORTORDER',
+ dest='format_sort', default=[],
+ action='callback', callback=_comma_separated_values_options_callback, type='str',
+ help='Sort the formats by the fields given, see "Sorting Formats" for more details')
+ video_format.add_option(
+ '--format-sort-force', '--S-force',
+ action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
+ help=(
+ 'Force user specified sort order to have precedence over all fields, '
+ 'see "Sorting Formats" for more details'))
+ video_format.add_option(
+ '--no-format-sort-force',
+ action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
+ help=(
+ 'Some fields have precedence over the user specified sort order (default), '
+ 'see "Sorting Formats" for more details'))
+ video_format.add_option(
+ '--video-multistreams',
+ action='store_true', dest='allow_multiple_video_streams', default=False,
+ help='Allow multiple video streams to be merged into a single file')
+ video_format.add_option(
+ '--no-video-multistreams',
+ action='store_false', dest='allow_multiple_video_streams',
+ help='Only one video stream is downloaded for each output file (default)')
+ video_format.add_option(
+ '--audio-multistreams',
+ action='store_true', dest='allow_multiple_audio_streams', default=False,
+ help='Allow multiple audio streams to be merged into a single file')
+ video_format.add_option(
+ '--no-audio-multistreams',
+ action='store_false', dest='allow_multiple_audio_streams',
+ help='Only one audio stream is downloaded for each output file (default)')
video_format.add_option(
'--all-formats',
action='store_const', dest='format', const='all',
video_format.add_option(
'--prefer-free-formats',
action='store_true', dest='prefer_free_formats', default=False,
- help='Prefer free video formats unless a specific one is requested')
+ help='Prefer free video formats over non-free formats of same quality')
video_format.add_option(
'-F', '--list-formats',
action='store_true', dest='listformats',
help='List all available formats of requested videos')
video_format.add_option(
- '--youtube-include-dash-manifest',
+ '--list-formats-as-table',
+ action='store_true', dest='listformats_table', default=True,
+ help='Present the output of -F in tabular form (default)')
+ video_format.add_option(
+ '--list-formats-old', '--no-list-formats-as-table',
+ action='store_false', dest='listformats_table',
+ help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
+ video_format.add_option(
+ '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
action='store_true', dest='youtube_include_dash_manifest', default=True,
- help=optparse.SUPPRESS_HELP)
+ help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
video_format.add_option(
- '--youtube-skip-dash-manifest',
+ '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
action='store_false', dest='youtube_include_dash_manifest',
- help='Do not download the DASH manifests and related data on YouTube videos')
+ help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
video_format.add_option(
- '--youtube-include-hls-manifest',
+ '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
action='store_true', dest='youtube_include_hls_manifest', default=True,
- help=optparse.SUPPRESS_HELP)
+ help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
video_format.add_option(
- '--youtube-skip-hls-manifest',
+ '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
action='store_false', dest='youtube_include_hls_manifest',
- help='Do not download the HLS manifests and related data on YouTube videos')
+ help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
video_format.add_option(
'--merge-output-format',
action='store', dest='merge_output_format', metavar='FORMAT', default=None,
subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
subtitles.add_option(
- '--write-sub', '--write-srt',
+ '--write-subs', '--write-srt',
action='store_true', dest='writesubtitles', default=False,
help='Write subtitle file')
subtitles.add_option(
- '--write-auto-sub', '--write-automatic-sub',
+ '--no-write-subs', '--no-write-srt',
+ action='store_false', dest='writesubtitles',
+ help='Do not write subtitle file (default)')
+ subtitles.add_option(
+ '--write-auto-subs', '--write-automatic-subs',
action='store_true', dest='writeautomaticsub', default=False,
help='Write automatically generated subtitle file (YouTube only)')
+ subtitles.add_option(
+ '--no-write-auto-subs', '--no-write-automatic-subs',
+ action='store_false', dest='writeautomaticsub', default=False,
+ help='Do not write automatically generated subtitle file (default)')
subtitles.add_option(
'--all-subs',
action='store_true', dest='allsubtitles', default=False,
downloader.add_option(
'-R', '--retries',
dest='retries', metavar='RETRIES', default=10,
- help='Number of retries (default is %default), or "infinite".')
+ help='Number of retries (default is %default), or "infinite"')
downloader.add_option(
'--fragment-retries',
dest='fragment_retries', metavar='RETRIES', default=10,
help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
downloader.add_option(
- '--skip-unavailable-fragments',
+ '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
action='store_true', dest='skip_unavailable_fragments', default=True,
- help='Skip unavailable fragments (DASH, hlsnative and ISM)')
+ help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
downloader.add_option(
- '--abort-on-unavailable-fragment',
+ '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
action='store_false', dest='skip_unavailable_fragments',
- help='Abort downloading when some fragment is not available')
+ help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
downloader.add_option(
'--keep-fragments',
action='store_true', dest='keep_fragments', default=False,
- help='Keep downloaded fragments on disk after downloading is finished; fragments are erased by default')
+ help='Keep downloaded fragments on disk after downloading is finished')
+ downloader.add_option(
+ '--no-keep-fragments',
+ action='store_false', dest='keep_fragments',
+ help='Delete downloaded fragments after downloading is finished (default)')
downloader.add_option(
'--buffer-size',
dest='buffersize', metavar='SIZE', default='1024',
help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
+ downloader.add_option(
+ '--resize-buffer',
+ action='store_false', dest='noresizebuffer',
+ help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
downloader.add_option(
'--no-resize-buffer',
action='store_true', dest='noresizebuffer', default=False,
- help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
+ help='Do not automatically adjust the buffer size')
downloader.add_option(
'--http-chunk-size',
dest='http_chunk_size', metavar='SIZE', default=None,
- help='Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
- 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)')
+ help=(
+ 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
+ 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
downloader.add_option(
'--test',
action='store_true', dest='test', default=False,
'--playlist-reverse',
action='store_true',
help='Download playlist videos in reverse order')
+ downloader.add_option(
+ '--no-playlist-reverse',
+ action='store_false', dest='playlist_reverse',
+ help='Download playlist videos in default order (default)')
downloader.add_option(
'--playlist-random',
action='store_true',
downloader.add_option(
'--hls-use-mpegts',
dest='hls_use_mpegts', action='store_true',
- help='Use the mpegts container for HLS videos, allowing to play the '
- 'video while downloading (some players may not be able to play it)')
+ help=(
+ 'Use the mpegts container for HLS videos, allowing to play the '
+ 'video while downloading (some players may not be able to play it)'))
downloader.add_option(
'--external-downloader',
- dest='external_downloader', metavar='COMMAND',
- help='Use the specified external downloader. '
- 'Currently supports %s' % ','.join(list_external_downloaders()))
+ dest='external_downloader', metavar='NAME',
+ help=(
+ 'Use the specified external downloader. '
+ 'Currently supports %s' % ', '.join(list_external_downloaders())))
downloader.add_option(
- '--external-downloader-args',
- dest='external_downloader_args', metavar='ARGS',
- help='Give these arguments to the external downloader')
+ '--downloader-args', '--external-downloader-args',
+ metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
+ action='callback', callback=_dict_from_multiple_values_options_callback,
+ callback_kwargs={
+ 'allowed_keys': '|'.join(list_external_downloaders()),
+ 'default_key': 'default', 'process': compat_shlex_split},
+ help=(
+ 'Give these arguments to the external downloader. '
+ 'Specify the downloader name and the arguments separated by a colon ":". '
+ 'You can use this option multiple times (Alias: --external-downloader-args)'))
workarounds = optparse.OptionGroup(parser, 'Workarounds')
workarounds.add_option(
action='store_true', dest='no_check_certificate', default=False,
help='Suppress HTTPS certificate validation')
workarounds.add_option(
- '--prefer-insecure',
- '--prefer-unsecure', action='store_true', dest='prefer_insecure',
+ '--prefer-insecure', '--prefer-unsecure',
+ action='store_true', dest='prefer_insecure',
help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
workarounds.add_option(
'--user-agent',
)
workarounds.add_option(
'--add-header',
- metavar='FIELD:VALUE', dest='headers', action='append',
- help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
+ metavar='FIELD:VALUE', dest='headers', default={}, type='str',
+ action='callback', callback=_dict_from_multiple_values_options_callback,
+ help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
)
workarounds.add_option(
'--bidi-workaround',
'Number of seconds to sleep before each download when used alone '
'or a lower bound of a range for randomized sleep before each download '
'(minimum possible number of seconds to sleep) when used along with '
- '--max-sleep-interval.'))
+ '--max-sleep-interval'))
workarounds.add_option(
'--max-sleep-interval', metavar='SECONDS',
dest='max_sleep_interval', type=float,
help=(
'Upper bound of a range for randomized sleep before each download '
'(maximum possible number of seconds to sleep). Must only be used '
- 'along with --min-sleep-interval.'))
+ 'along with --min-sleep-interval'))
workarounds.add_option(
- '--sleep-subtitles',
- dest='sleep_interval_subtitles', action='store_true', default=0,
+ '--sleep-subtitles', metavar='SECONDS',
+ dest='sleep_interval_subtitles', default=0, type=int,
help='Enforce sleep interval on subtitles as well')
verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
action='store_true', dest='simulate', default=False,
help='Do not download the video and do not write anything to disk')
verbosity.add_option(
- '--skip-download',
+ '--skip-download', '--no-download',
action='store_true', dest='skip_download', default=False,
help='Do not download the video')
verbosity.add_option(
verbosity.add_option(
'-j', '--dump-json',
action='store_true', dest='dumpjson', default=False,
- help='Simulate, quiet but print JSON information. See the "OUTPUT TEMPLATE" for a description of available keys.')
+ help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
verbosity.add_option(
'-J', '--dump-single-json',
action='store_true', dest='dump_single_json', default=False,
- help='Simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
+ help=(
+ 'Simulate, quiet but print JSON information for each command-line argument. '
+ 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
verbosity.add_option(
'--print-json',
action='store_true', dest='print_json', default=False,
- help='Be quiet and print the video information as JSON (video is still being downloaded).',
- )
+ help='Be quiet and print the video information as JSON (video is still being downloaded)')
+ verbosity.add_option(
+ '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
+ action='store_true', dest='force_write_download_archive', default=False,
+ help=(
+ 'Force download archive entries to be written as far as no errors occur,'
+ 'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
verbosity.add_option(
'--newline',
action='store_true', dest='progress_with_newline', default=False,
verbosity.add_option(
'-C', '--call-home',
dest='call_home', action='store_true', default=False,
- help='Contact the youtube-dlc server for debugging')
+ help='[Broken] Contact the youtube-dlc server for debugging')
verbosity.add_option(
'--no-call-home',
- dest='call_home', action='store_false', default=False,
- help='Do NOT contact the youtube-dlc server for debugging')
+ dest='call_home', action='store_false',
+ help='Do not contact the youtube-dlc server for debugging (default)')
filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
filesystem.add_option(
'-a', '--batch-file',
dest='batchfile', metavar='FILE',
help="File containing URLs to download ('-' for stdin), one URL per line. "
- "Lines starting with '#', ';' or ']' are considered as comments and ignored.")
+ "Lines starting with '#', ';' or ']' are considered as comments and ignored")
filesystem.add_option(
'--id', default=False,
- action='store_true', dest='useid', help='Use only video ID in file name')
+ action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
+ filesystem.add_option(
+ '-P', '--paths',
+ metavar='TYPE:PATH', dest='paths', default={}, type='str',
+ action='callback', callback=_dict_from_multiple_values_options_callback,
+ callback_kwargs={
+ 'allowed_keys': 'home|temp|config|description|annotation|subtitle|infojson|thumbnail',
+ 'process': lambda x: x.strip()},
+ help=(
+ 'The paths where the files should be downloaded. '
+ 'Specify the type of file and the path separated by a colon ":" '
+ '(supported: description|annotation|subtitle|infojson|thumbnail). '
+ 'Additionally, you can also provide "home" and "temp" paths. '
+ 'All intermediary files are first downloaded to the temp path and '
+ 'then the final files are moved over to the home path after download is finished. '
+ 'Note that this option is ignored if --output is an absolute path'))
filesystem.add_option(
'-o', '--output',
dest='outtmpl', metavar='TEMPLATE',
- help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info'))
+ help='Output filename template, see "OUTPUT TEMPLATE" for details')
filesystem.add_option(
'--autonumber-size',
dest='autonumber_size', metavar='NUMBER', type=int,
'--restrict-filenames',
action='store_true', dest='restrictfilenames', default=False,
help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
+ filesystem.add_option(
+ '--no-restrict-filenames',
+ action='store_false', dest='restrictfilenames', default=False,
+ help='Allow Unicode characters, "&" and spaces in filenames (default)')
filesystem.add_option(
'-A', '--auto-number',
action='store_true', dest='autonumber', default=False,
help=optparse.SUPPRESS_HELP)
filesystem.add_option(
'-w', '--no-overwrites',
- action='store_true', dest='nooverwrites', default=False,
- help='Do not overwrite files')
+ action='store_false', dest='overwrites', default=None,
+ help='Do not overwrite any files')
+ filesystem.add_option(
+ '--force-overwrites', '--yes-overwrites',
+ action='store_true', dest='overwrites',
+ help='Overwrite all video and metadata files. This option includes --no-continue')
+ filesystem.add_option(
+ '--no-force-overwrites',
+ action='store_const', dest='overwrites', const=None,
+ help='Do not overwrite the video, but overwrite related files (default)')
filesystem.add_option(
'-c', '--continue',
action='store_true', dest='continue_dl', default=True,
- help='Force resume of partially downloaded files. By default, youtube-dlc will resume downloads if possible.')
+ help='Resume partially downloaded files (default)')
filesystem.add_option(
'--no-continue',
action='store_false', dest='continue_dl',
- help='Do not resume partially downloaded files (restart from beginning)')
+ help='Restart download of partially downloaded files from beginning')
+ filesystem.add_option(
+ '--part',
+ action='store_false', dest='nopart', default=False,
+ help='Use .part files instead of writing directly into output file (default)')
filesystem.add_option(
'--no-part',
- action='store_true', dest='nopart', default=False,
+ action='store_true', dest='nopart',
help='Do not use .part files - write directly into output file')
+ filesystem.add_option(
+ '--mtime',
+ action='store_true', dest='updatetime', default=True,
+ help='Use the Last-modified header to set the file modification time (default)')
filesystem.add_option(
'--no-mtime',
- action='store_false', dest='updatetime', default=True,
+ action='store_false', dest='updatetime',
help='Do not use the Last-modified header to set the file modification time')
filesystem.add_option(
'--write-description',
action='store_true', dest='writedescription', default=False,
help='Write video description to a .description file')
+ filesystem.add_option(
+ '--no-write-description',
+ action='store_false', dest='writedescription',
+ help='Do not write video description (default)')
filesystem.add_option(
'--write-info-json',
action='store_true', dest='writeinfojson', default=False,
help='Write video metadata to a .info.json file')
+ filesystem.add_option(
+ '--no-write-info-json',
+ action='store_false', dest='writeinfojson',
+ help='Do not write video metadata (default)')
filesystem.add_option(
'--write-annotations',
action='store_true', dest='writeannotations', default=False,
help='Write video annotations to a .annotations.xml file')
+ filesystem.add_option(
+ '--no-write-annotations',
+ action='store_false', dest='writeannotations',
+ help='Do not write video annotations (default)')
filesystem.add_option(
'--load-info-json', '--load-info',
dest='load_info_filename', metavar='FILE',
'--cookies',
dest='cookiefile', metavar='FILE',
help='File to read cookies from and dump cookie jar in')
+ filesystem.add_option(
+ '--no-cookies',
+ action='store_const', const=None, dest='cookiefile', metavar='FILE',
+ help='Do not read/dump cookies (default)')
filesystem.add_option(
'--cache-dir', dest='cachedir', default=None, metavar='DIR',
- help='Location in the filesystem where youtube-dlc can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dlc or ~/.cache/youtube-dlc . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.')
+ help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change')
filesystem.add_option(
- '--no-cache-dir', action='store_const', const=False, dest='cachedir',
+ '--no-cache-dir', action='store_false', dest='cachedir',
help='Disable filesystem caching')
filesystem.add_option(
'--rm-cache-dir',
action='store_true', dest='rm_cachedir',
help='Delete all filesystem cache files')
filesystem.add_option(
- '--trim-file-name', dest='trim_file_name', default=0, type=int,
+ '--trim-file-name', metavar='LENGTH',
+ dest='trim_file_name', default=0, type=int,
help='Limit the filename length (extension excluded)')
- thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
+ thumbnail = optparse.OptionGroup(parser, 'Thumbnail Images')
thumbnail.add_option(
'--write-thumbnail',
action='store_true', dest='writethumbnail', default=False,
help='Write thumbnail image to disk')
+ thumbnail.add_option(
+ '--no-write-thumbnail',
+ action='store_false', dest='writethumbnail',
+ help='Do not write thumbnail image to disk (default)')
thumbnail.add_option(
'--write-all-thumbnails',
action='store_true', dest='write_all_thumbnails', default=False,
action='store_true', dest='list_thumbnails', default=False,
help='Simulate and list all available thumbnail formats')
- postproc = optparse.OptionGroup(parser, 'Post-processing Options')
+ link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
+ link.add_option(
+ '--write-link',
+ action='store_true', dest='writelink', default=False,
+ help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
+ link.add_option(
+ '--write-url-link',
+ action='store_true', dest='writeurllink', default=False,
+ help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
+ link.add_option(
+ '--write-webloc-link',
+ action='store_true', dest='writewebloclink', default=False,
+ help='Write a .webloc macOS internet shortcut')
+ link.add_option(
+ '--write-desktop-link',
+ action='store_true', dest='writedesktoplink', default=False,
+ help='Write a .desktop Linux internet shortcut')
+
+ postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
postproc.add_option(
'-x', '--extract-audio',
action='store_true', dest='extractaudio', default=False,
postproc.add_option(
'--remux-video',
metavar='FORMAT', dest='remuxvideo', default=None,
- help='Remux the video to another container format if necessary (currently supported: mp4|mkv, target container format must support video / audio encoding, remuxing may fail)')
+ help=(
+ 'Remux the video into another container if necessary (currently supported: mp4|mkv). '
+ 'If target container does not support the video/audio codec, remuxing will fail'))
postproc.add_option(
'--recode-video',
metavar='FORMAT', dest='recodevideo', default=None,
- help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
+ help='Re-encode the video into another format if re-encoding is necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
postproc.add_option(
- '--postprocessor-args',
- dest='postprocessor_args', metavar='ARGS',
- help='Give these arguments to the postprocessor')
+ '--postprocessor-args', '--ppa',
+ metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
+ action='callback', callback=_dict_from_multiple_values_options_callback,
+ callback_kwargs={'default_key': 'default-compat', 'allowed_keys': r'\w+(?:\+\w+)?', 'process': compat_shlex_split},
+ help=(
+ 'Give these arguments to the postprocessors. '
+ 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
+ 'to give the argument to the specified postprocessor/executable. Supported postprocessors are: '
+ 'SponSkrub, ExtractAudio, VideoRemuxer, VideoConvertor, EmbedSubtitle, Metadata, Merger, '
+ 'FixupStretched, FixupM4a, FixupM3u8, SubtitlesConvertor and EmbedThumbnail. '
+ 'The supported executables are: SponSkrub, FFmpeg, FFprobe, avconf, avprobe and AtomicParsley. '
+ 'You can use this option multiple times to give different arguments to different postprocessors. '
+ 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
+ 'only when being used by the specified postprocessor. '
+ 'You can use this option multiple times (Alias: --ppa)'))
postproc.add_option(
'-k', '--keep-video',
action='store_true', dest='keepvideo', default=False,
- help='Keep the video file on disk after the post-processing; the video is erased by default')
+ help='Keep the intermediate video file on disk after post-processing')
+ postproc.add_option(
+ '--no-keep-video',
+ action='store_false', dest='keepvideo',
+ help='Delete the intermediate video file after post-processing (default)')
+ postproc.add_option(
+ '--post-overwrites',
+ action='store_false', dest='nopostoverwrites',
+ help='Overwrite post-processed files (default)')
postproc.add_option(
'--no-post-overwrites',
action='store_true', dest='nopostoverwrites', default=False,
- help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
+ help='Do not overwrite post-processed files')
postproc.add_option(
'--embed-subs',
action='store_true', dest='embedsubtitles', default=False,
help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
+ postproc.add_option(
+ '--no-embed-subs',
+ action='store_false', dest='embedsubtitles',
+ help='Do not embed subtitles (default)')
postproc.add_option(
'--embed-thumbnail',
action='store_true', dest='embedthumbnail', default=False,
help='Embed thumbnail in the audio as cover art')
+ postproc.add_option(
+ '--no-embed-thumbnail',
+ action='store_false', dest='embedthumbnail',
+ help='Do not embed thumbnail (default)')
postproc.add_option(
'--add-metadata',
action='store_true', dest='addmetadata', default=False,
help='Write metadata to the video file')
+ postproc.add_option(
+ '--no-add-metadata',
+ action='store_false', dest='addmetadata',
+ help='Do not write metadata (default)')
postproc.add_option(
'--metadata-from-title',
metavar='FORMAT', dest='metafromtitle',
- help='Parse additional metadata like song title / artist from the video title. '
- 'The format syntax is the same as --output. Regular expression with '
- 'named capture groups may also be used. '
- 'The parsed parameters replace existing values. '
- 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
- '"Coldplay - Paradise". '
- 'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"')
+ help=(
+ 'Parse additional metadata like song title / artist from the video title. '
+ 'The format syntax is the same as --output. Regular expression with '
+ 'named capture groups may also be used. '
+ 'The parsed parameters replace existing values. '
+ 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
+ '"Coldplay - Paradise". '
+ 'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"'))
postproc.add_option(
'--xattrs',
action='store_true', dest='xattrs', default=False,
postproc.add_option(
'--fixup',
metavar='POLICY', dest='fixup', default='detect_or_warn',
- help='Automatically correct known faults of the file. '
- 'One of never (do nothing), warn (only emit a warning), '
- 'detect_or_warn (the default; fix file if we can, warn otherwise)')
+ help=(
+ 'Automatically correct known faults of the file. '
+ 'One of never (do nothing), warn (only emit a warning), '
+ 'detect_or_warn (the default; fix file if we can, warn otherwise)'))
postproc.add_option(
- '--prefer-avconv',
+ '--prefer-avconv', '--no-prefer-ffmpeg',
action='store_false', dest='prefer_ffmpeg',
- help='Prefer avconv over ffmpeg for running the postprocessors')
+ help='Prefer avconv over ffmpeg for running the postprocessors (Alias: --no-prefer-ffmpeg)')
postproc.add_option(
- '--prefer-ffmpeg',
+ '--prefer-ffmpeg', '--no-prefer-avconv',
action='store_true', dest='prefer_ffmpeg',
- help='Prefer ffmpeg over avconv for running the postprocessors (default)')
+ help='Prefer ffmpeg over avconv for running the postprocessors (default) (Alias: --no-prefer-avconv)')
postproc.add_option(
'--ffmpeg-location', '--avconv-location', metavar='PATH',
dest='ffmpeg_location',
- help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
+ help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory (Alias: --avconv-location)')
postproc.add_option(
'--exec',
metavar='CMD', dest='exec_cmd',
metavar='FORMAT', dest='convertsubtitles', default=None,
help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
+ sponskrub = optparse.OptionGroup(parser, 'SponSkrub (SponsorBlock) Options', description=(
+ 'SponSkrub (https://github.com/pukkandan/SponSkrub) is a utility to mark/remove sponsor segments '
+ 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
+ sponskrub.add_option(
+ '--sponskrub',
+ action='store_true', dest='sponskrub', default=None,
+ help=(
+ 'Use sponskrub to mark sponsored sections. '
+ 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
+ sponskrub.add_option(
+ '--no-sponskrub',
+ action='store_false', dest='sponskrub',
+ help='Do not use sponskrub')
+ sponskrub.add_option(
+ '--sponskrub-cut', default=False,
+ action='store_true', dest='sponskrub_cut',
+ help='Cut out the sponsor sections instead of simply marking them')
+ sponskrub.add_option(
+ '--no-sponskrub-cut',
+ action='store_false', dest='sponskrub_cut',
+ help='Simply mark the sponsor sections, not cut them out (default)')
+ sponskrub.add_option(
+ '--sponskrub-force', default=False,
+ action='store_true', dest='sponskrub_force',
+ help='Run sponskrub even if the video was already downloaded')
+ sponskrub.add_option(
+ '--no-sponskrub-force',
+ action='store_true', dest='sponskrub_force',
+ help='Do not cut out the sponsor sections if the video was already downloaded (default)')
+ sponskrub.add_option(
+ '--sponskrub-location', metavar='PATH',
+ dest='sponskrub_path', default='',
+ help='Location of the sponskrub binary; either the path to the binary or its containing directory')
+ sponskrub.add_option(
+ '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
+ help=optparse.SUPPRESS_HELP)
+
extractor = optparse.OptionGroup(parser, 'Extractor Options')
extractor.add_option(
- '--allow-dynamic-mpd',
+ '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
action='store_true', dest='dynamic_mpd', default=True,
- help=optparse.SUPPRESS_HELP)
+ help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
extractor.add_option(
- '--ignore-dynamic-mpd',
+ '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
action='store_false', dest='dynamic_mpd',
- help='Do not process dynamic DASH manifests')
+ help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
parser.add_option_group(general)
parser.add_option_group(network)
parser.add_option_group(downloader)
parser.add_option_group(filesystem)
parser.add_option_group(thumbnail)
+ parser.add_option_group(link)
parser.add_option_group(verbosity)
parser.add_option_group(workarounds)
parser.add_option_group(video_format)
parser.add_option_group(authentication)
parser.add_option_group(adobe_pass)
parser.add_option_group(postproc)
+ parser.add_option_group(sponskrub)
parser.add_option_group(extractor)
if overrideArguments is not None:
return [a.decode(preferredencoding(), 'replace') for a in conf]
return conf
- command_line_conf = compat_conf(sys.argv[1:])
- opts, args = parser.parse_args(command_line_conf)
+ configs = {
+ 'command-line': compat_conf(sys.argv[1:]),
+ 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
+ paths = {'command-line': False}
+ opts, args = parser.parse_args(configs['command-line'])
- system_conf = user_conf = custom_conf = []
+ def get_configs():
+ if '--config-location' in configs['command-line']:
+ location = compat_expanduser(opts.config_location)
+ if os.path.isdir(location):
+ location = os.path.join(location, 'youtube-dlc.conf')
+ if not os.path.exists(location):
+ parser.error('config-location %s does not exist.' % location)
+ configs['custom'] = _readOptions(location, default=None)
+ if configs['custom'] is None:
+ configs['custom'] = []
+ else:
+ paths['custom'] = location
+ if '--ignore-config' in configs['command-line']:
+ return
+ if '--ignore-config' in configs['custom']:
+ return
- if '--config-location' in command_line_conf:
- location = compat_expanduser(opts.config_location)
- if os.path.isdir(location):
- location = os.path.join(location, 'youtube-dlc.conf')
- if not os.path.exists(location):
- parser.error('config-location %s does not exist.' % location)
- custom_conf = _readOptions(location)
- elif '--ignore-config' in command_line_conf:
- pass
- else:
- system_conf = _readOptions('/etc/youtube-dlc.conf')
- if '--ignore-config' not in system_conf:
- user_conf = _readUserConf()
+ def read_options(path, user=False):
+ func = _readUserConf if user else _readOptions
+ current_path = os.path.join(path, 'yt-dlp.conf')
+ config = func(current_path, default=None)
+ if user:
+ config, current_path = config
+ if config is None:
+ current_path = os.path.join(path, 'youtube-dlc.conf')
+ config = func(current_path, default=None)
+ if user:
+ config, current_path = config
+ if config is None:
+ return [], None
+ return config, current_path
+
+ configs['portable'], paths['portable'] = read_options(get_executable_path())
+ if '--ignore-config' in configs['portable']:
+ return
+
+ def get_home_path():
+ opts = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])[0]
+ return expand_path(opts.paths.get('home', '')).strip()
+
+ configs['home'], paths['home'] = read_options(get_home_path())
+ if '--ignore-config' in configs['home']:
+ return
+
+ configs['system'], paths['system'] = read_options('/etc')
+ if '--ignore-config' in configs['system']:
+ return
+
+ configs['user'], paths['user'] = read_options('', True)
+ if '--ignore-config' in configs['user']:
+ configs['system'], paths['system'] = [], None
- argv = system_conf + user_conf + custom_conf + command_line_conf
+ get_configs()
+ argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line']
opts, args = parser.parse_args(argv)
if opts.verbose:
- for conf_label, conf in (
- ('System config', system_conf),
- ('User config', user_conf),
- ('Custom config', custom_conf),
- ('Command-line args', command_line_conf)):
- write_string('[debug] %s: %s\n' % (conf_label, repr(_hide_login_info(conf))))
+ for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
+ key = label.lower()
+ if paths.get(key) is None:
+ continue
+ if paths[key]:
+ write_string('[debug] %s config file: %s\n' % (label, paths[key]))
+ write_string('[debug] %s config: %s\n' % (label, repr(_hide_login_info(configs[key]))))
return parser, opts, args
projects / yt-dlp.git / blobdiff