SponsorBlockPP,
)
from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
-from .update import detect_variant, is_non_updateable
+from .update import UPDATE_SOURCES, detect_variant, is_non_updateable
from .utils import (
OUTTMPL_TYPES,
POSTPROCESS_WHEN,
expand_path,
format_field,
get_executable_path,
+ get_system_config_dirs,
+ get_user_config_dirs,
join_nonempty,
orderedSet_from_options,
remove_end,
write_string,
)
-from .version import __version__
+from .version import CHANNEL, __version__
def parseOpts(overrideArguments=None, ignore_config_files='if_override'):
+ PACKAGE_NAME = 'yt-dlp'
+
root = Config(create_parser())
if ignore_config_files == 'if_override':
ignore_config_files = overrideArguments is not None
- def _readUserConf(package_name, default=[]):
- # .config
- xdg_config_home = os.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 = Config.read_file(userConfFile, default=None)
- if userConf is not None:
- return userConf, userConfFile
-
- # appdata
- appdata_dir = os.getenv('appdata')
- if appdata_dir:
- userConfFile = os.path.join(appdata_dir, package_name, 'config')
- userConf = Config.read_file(userConfFile, default=None)
- if userConf is None:
- userConfFile += '.txt'
- userConf = Config.read_file(userConfFile, default=None)
- if userConf is not None:
- return userConf, userConfFile
+ def read_config(*paths):
+ path = os.path.join(*paths)
+ conf = Config.read_file(path, default=None)
+ if conf is not None:
+ return conf, path
- # home
- userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
- userConf = Config.read_file(userConfFile, default=None)
- if userConf is None:
- userConfFile += '.txt'
- userConf = Config.read_file(userConfFile, default=None)
- if userConf is not None:
- return userConf, userConfFile
+ def _load_from_config_dirs(config_dirs):
+ for config_dir in config_dirs:
+ head, tail = os.path.split(config_dir)
+ assert tail == PACKAGE_NAME or config_dir == os.path.join(compat_expanduser('~'), f'.{PACKAGE_NAME}')
- return default, None
+ yield read_config(head, f'{PACKAGE_NAME}.conf')
+ if tail.startswith('.'): # ~/.PACKAGE_NAME
+ yield read_config(head, f'{PACKAGE_NAME}.conf.txt')
+ yield read_config(config_dir, 'config')
+ yield read_config(config_dir, 'config.txt')
- def add_config(label, path, user=False):
+ def add_config(label, path=None, func=None):
""" Adds config and returns whether to continue """
if root.parse_known_args()[0].ignoreconfig:
return False
- # Multiple package names can be given here
- # E.g. ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
- # the configuration file of any of these three packages
- for package in ('yt-dlp',):
- if user:
- args, current_path = _readUserConf(package, default=None)
- else:
- current_path = os.path.join(path, '%s.conf' % package)
- args = Config.read_file(current_path, default=None)
- if args is not None:
- root.append_config(args, current_path, label=label)
- return True
+ elif func:
+ assert path is None
+ args, current_path = next(
+ filter(None, _load_from_config_dirs(func(PACKAGE_NAME))), (None, None))
+ else:
+ current_path = os.path.join(path, 'yt-dlp.conf')
+ args = Config.read_file(current_path, default=None)
+ if args is not None:
+ root.append_config(args, current_path, label=label)
return True
def load_configs():
yield not ignore_config_files
yield add_config('Portable', get_executable_path())
yield add_config('Home', expand_path(root.parse_known_args()[0].paths.get('home', '')).strip())
- yield add_config('User', None, user=True)
- yield add_config('System', '/etc')
+ yield add_config('User', func=get_user_config_dirs)
+ yield add_config('System', func=get_system_config_dirs)
opts = optparse.Values({'verbose': True, 'print_help': False})
try:
try:
- if overrideArguments:
+ if overrideArguments is not None:
root.append_config(overrideArguments, label='Override')
else:
root.append_config(sys.argv[1:], label='Command-line')
if multiple_keys:
allowed_keys = fr'({allowed_keys})(,({allowed_keys}))*'
mobj = re.match(
- fr'(?i)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
+ fr'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
value[0] if multiple_args else value)
if mobj is not None:
keys, val = mobj.group('keys').split(','), mobj.group('val')
action='store_true', dest='update_self',
help=format_field(
is_non_updateable(), None, 'Check if updates are available. %s',
- default='Update this program to the latest version'))
+ default=f'Update this program to the latest {CHANNEL} version'))
general.add_option(
'--no-update',
action='store_false', dest='update_self',
help='Do not check for updates (default)')
+ general.add_option(
+ '--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)}'))
general.add_option(
'-i', '--ignore-errors',
action='store_true', dest='ignoreerrors',
'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',
- 'no-attach-info-json', 'embed-metadata', 'embed-thumbnail-atomicparsley',
- 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
+ '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',
}, 'aliases': {
'youtube-dl': ['all', '-multistreams'],
'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat'],
+ '2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'],
+ '2022': ['no-external-downloader-progress'],
}
}, help=(
'Options that can help keep compatibility with youtube-dl or youtube-dlc '
action='store_const', const='::', dest='source_address',
help='Make all connections via IPv6',
)
+ network.add_option(
+ '--enable-file-urls', action='store_true',
+ dest='enable_file_urls', default=False,
+ help='Enable file:// URLs. This is disabled by default for security reasons.'
+ )
geo = optparse.OptionGroup(parser, 'Geo-restriction')
geo.add_option(
'--date',
metavar='DATE', dest='date', default=None,
help=(
- 'Download only videos uploaded on this date. The date can be "YYYYMMDD" or in the format '
- '[now|today|yesterday][-N[day|week|month|year]]. E.g. --date today-2weeks'))
+ 'Download only videos uploaded on this date. '
+ 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
+ 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
selection.add_option(
'--datebefore',
metavar='DATE', dest='datebefore', default=None,
'Use "--match-filter -" to interactively ask whether to download each video'))
selection.add_option(
'--no-match-filter',
- metavar='FILTER', dest='match_filter', action='store_const', const=None,
- help='Do not use generic video filter (default)')
+ dest='match_filter', action='store_const', const=None,
+ help='Do not use any --match-filter (default)')
+ selection.add_option(
+ '--break-match-filters',
+ metavar='FILTER', dest='breaking_match_filter', action='append',
+ help='Same as "--match-filters" but stops the download process when a video is rejected')
+ selection.add_option(
+ '--no-break-match-filters',
+ dest='breaking_match_filter', action='store_const', const=None,
+ help='Do not use any --break-match-filters (default)')
selection.add_option(
'--no-playlist',
action='store_true', dest='noplaylist', default=False,
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')
+ help=optparse.SUPPRESS_HELP)
selection.add_option(
'--break-per-input',
action='store_true', dest='break_per_url', default=False,
- help='Alters --max-downloads, --break-on-existing, --break-on-reject, and autonumber to reset per input URL')
+ help='Alters --max-downloads, --break-on-existing, --break-match-filter, and autonumber to reset per input URL')
selection.add_option(
'--no-break-per-input',
action='store_false', dest='break_per_url',
'This option can be used multiple times to set the sleep for the different retry types, '
'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
downloader.add_option(
- '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
+ '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
action='store_true', dest='skip_unavailable_fragments', default=True,
- help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragment)')
+ help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
downloader.add_option(
- '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
+ '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
action='store_false', dest='skip_unavailable_fragments',
help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
downloader.add_option(
metavar='URL', dest='referer', default=None,
help=optparse.SUPPRESS_HELP)
workarounds.add_option(
- '--add-header',
+ '--add-headers',
metavar='FIELD:VALUE', dest='headers', default={}, type='str',
action='callback', callback=_dict_from_options_callback,
callback_kwargs={'multiple_keys': False},
verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
verbosity.add_option(
'-q', '--quiet',
- action='store_true', dest='quiet', default=False,
+ action='store_true', dest='quiet', default=None,
help='Activate quiet mode. If used with --verbose, print the log to stderr')
+ verbosity.add_option(
+ '--no-quiet',
+ action='store_false', dest='quiet',
+ help='Deactivate quiet mode. (Default)')
verbosity.add_option(
'--no-warnings',
dest='no_warnings', action='store_true', default=False,
'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)q is appended to the end of the command. '
+ 'is also available, and 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