cli: deprecate old config files and plugin dirs #3784
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- wrap deprecated config and plugin paths in `DeprecatedPath`, subclassed from pathlib.Path - log info messages when loading deprecated configs or plugins - return success from `Streamlink.load_plugins(path)` to be able to log plugin loading messages in the main cli module
bastimeyer
commented
Jun 6, 2021
Comment on lines
+667
to
+679
| if streamlink and args.url: | ||
| # Only load first available plugin config | ||
| with ignored(NoPluginError): | ||
| plugin = streamlink.resolve_url(args.url) | ||
| for config_file in CONFIG_FILES: | ||
| config_file = config_file.with_name(f"{config_file.name}.{plugin.module}") | ||
| if not config_file.is_file(): | ||
| continue | ||
| if type(config_file) is DeprecatedPath: | ||
| log.info(f"Loaded plugin config from deprecated path, see CLI docs for how to migrate: {config_file}") | ||
| config_files.append(config_file) | ||
| break | ||
|
|
There was a problem hiding this comment.
There is a small change in logic here. Previously it was trying to load multiple plugin specific config files, eg. ~/.config/streamlink/config.twitch and ~/.streamlinkrc.twitch, but since only the first non-plugin-specific default config file gets loaded (see above), plugin configs should have the same logic.
I'm also not sure if we should disable plugin config loading when --config is set or if we should add something like --no-plugin-config for disabling loading plugin configs.
- Don't log when loading a config from a deprecated path when using the `--config` argument - Only load the first existing plugin-specific config file - Keep config file loading order - Add tests for setup_config_args
bastimeyer
force-pushed
the
cli/deprecate-old-config-file-and-plugin-dir-paths
branch
from
ecf58ed to
f2c4081
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecated config file paths
%APPDATA%\streamlink\streamlinkrc${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config${HOME}/.streamlinkrc${HOME}/.streamlinkrcDeprecated plugin directories
${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/pluginsUpdated primary config file paths
%APPDATA%\streamlink\config${HOME}/Library/Application Support/streamlink/config${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config(no changes)Updated primary plugin directories
%APPDATA%\streamlink\plugins(no changes)${HOME}/Library/Application Support/streamlink/plugins${XDG_DATA_HOME:-${HOME}/.local/share}/streamlink/plugins