[options] Fix --no-config and refactor reading of config files

Closes #912, #914
This commit is contained in:
pukkandan 2021-09-13 08:22:11 +05:30
parent f5aa5cfbff
commit 7303f84abe
No known key found for this signature in database
GPG Key ID: 0F00D95A001F4698

View File

@ -235,7 +235,7 @@ def _dict_from_options_callback(
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') 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')
general.add_option( general.add_option(
'--ignore-config', '--no-config', '--ignore-config', '--no-config',
action='store_true', action='store_true', dest='ignoreconfig',
help=( help=(
'Disable loading any configuration files except the one provided by --config-location. ' 'Disable loading any configuration files except the one provided by --config-location. '
'When given inside a configuration file, no further configuration files are loaded. ' 'When given inside a configuration file, no further configuration files are loaded. '
@ -1536,26 +1536,9 @@ def compat_conf(conf):
'command-line': compat_conf(sys.argv[1:]), 'command-line': compat_conf(sys.argv[1:]),
'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []} 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
paths = {'command-line': False} paths = {'command-line': False}
opts, args = parser.parse_args(configs['command-line'])
def get_configs(): def read_options(name, path, user=False):
if '--config-location' in configs['command-line']: ''' loads config files and returns ignoreconfig '''
location = compat_expanduser(opts.config_location)
if os.path.isdir(location):
location = os.path.join(location, 'yt-dlp.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
def read_options(path, user=False):
# Multiple package names can be given here # Multiple package names can be given here
# Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
# the configuration file of any of these three packages # the configuration file of any of these three packages
@ -1566,27 +1549,34 @@ def read_options(path, user=False):
current_path = os.path.join(path, '%s.conf' % package) current_path = os.path.join(path, '%s.conf' % package)
config = _readOptions(current_path, default=None) config = _readOptions(current_path, default=None)
if config is not None: if config is not None:
return config, current_path configs[name], paths[name] = config, current_path
return [], None return parser.parse_args(config)[0].ignoreconfig
return False
configs['portable'], paths['portable'] = read_options(get_executable_path()) def get_configs():
if '--ignore-config' in configs['portable']: opts, _ = parser.parse_args(configs['command-line'])
if opts.config_location is not None:
location = compat_expanduser(opts.config_location)
if os.path.isdir(location):
location = os.path.join(location, 'yt-dlp.conf')
if not os.path.exists(location):
parser.error('config-location %s does not exist.' % location)
config = _readOptions(location, default=None)
if config:
configs['custom'], paths['config'] = config, location
if opts.ignoreconfig:
return return
if parser.parse_args(configs['custom'])[0].ignoreconfig:
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 return
if read_options('portable', get_executable_path()):
configs['system'], paths['system'] = read_options('/etc')
if '--ignore-config' in configs['system']:
return return
opts, _ = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])
configs['user'], paths['user'] = read_options('', True) if read_options('home', expand_path(opts.paths.get('home', '')).strip()):
if '--ignore-config' in configs['user']: return
if read_options('system', '/etc'):
return
if read_options('user', None, user=True):
configs['system'], paths['system'] = [], None configs['system'], paths['system'] = [], None
get_configs() get_configs()
@ -1595,10 +1585,9 @@ def get_home_path():
if opts.verbose: if opts.verbose:
for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'): for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
key = label.lower() key = label.lower()
if paths.get(key) is None: if paths.get(key):
continue write_string(f'[debug] {label} config file: {paths[key]}\n')
if paths[key]: if paths.get(key) is not None:
write_string('[debug] %s config file: %s\n' % (label, paths[key])) write_string(f'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
write_string('[debug] %s config: %s\n' % (label, repr(_hide_login_info(configs[key]))))
return parser, opts, args return parser, opts, args