Support loading client config file from XDG_CONFIG_HOME #253
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
No functional changes yet: this is pure code motion. Signed-off-by: Stephen Finucane <[email protected]>
Otherwise, this fails when we later attempt to access the file. Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Stephen Finucane <[email protected]>
stephenfin
changed the title
mdujava
reviewed
Apr 24, 2025
| if user_config_file: | ||
| if not os.path.exists(user_config_file): | ||
| sys.stderr.write( | ||
| "File at '%s' indicated by BEAKER_CLIENT_CONF does not exist" |
|
|
||
| # ~/.beaker | ||
| user_config_file = os.path.expanduser('~/.beaker') | ||
| if os.path.exists(user_config_file): |
There was a problem hiding this comment.
better to check isfile instead of exists as it's passed to load_from_file
There was a problem hiding this comment.
Pull Request Overview
This PR updates client configuration loading to follow XDG_CONFIG_HOME standards and deprecates legacy config paths, while also addressing a bug where BEAKER_CLIENT_CONF points to an unavailable file.
- Introduces get_user_config_file to prioritize configuration from BEAKER_CLIENT_CONF, then XDG, and finally legacy paths with deprecation warnings.
- Adds get_system_config_file to load the system-wide configuration file.
- Adjusts initialization to use the updated configuration look-up functions.
Comments suppressed due to low confidence (1)
Client/src/bkr/client/init.py:29
- [nitpick] Consider appending a newline to the error message for improved readability.
File at '%s' indicated by BEAKER_CLIENT_CONF does not exist
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.
It's a standard, and it stop us littering our home directory with yet another config file :)
A small bug is addressed where the path indicated by
BEAKER_CLIENT_CONFdoes not exist is also addressed.