Allow cats_config.yml and cats_config.yaml #146
Draft
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
This change allows us to read configuration data from local files cats_config.yml, cats_config.yaml or config.yml. The first file found (in that order) is read and any others are ignored. I've also updated the tests to check that this works which involved fun with fixtures. Having thought about it a bit more this could probably be cleaned up with a parameterisation but I'm not sure about extracting the parameter for the test in the fixture ... something for another day.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #146 +/- ##
==========================================
+ Coverage 87.37% 87.80% +0.43%
==========================================
Files 13 13
Lines 602 648 +46
==========================================
+ Hits 526 569 +43
- Misses 76 79 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
abhidg
reviewed
Jun 6, 2025
| except FileNotFoundError: | ||
| logging.warning("CATS_CONFIG_FILE config file not found") | ||
| # if no path provided and no env variable, look for `config.yml` in current directory | ||
| config_file_names = ["cats_config.yml", "cats_config.yaml", "config.yml"] |
There was a problem hiding this comment.
Let's add config.yaml as well here?
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.
This change allows us to read configuration data from local files cats_config.yml, cats_config.yaml or config.yml. The first file found (in that order) is read and any others are ignored.
I've also updated the tests to check that this works which involved fun with fixtures. Having thought about it a bit more this could probably be cleaned up with a parameterisation but I'm not sure about extracting the parameter for the test in the fixture ... something for another day.
Still need to update the documentation to match and as well as cleanup in the tests, I'm pretty sure that config_from_file function could be simplified.
Fixes #145