Fix config.get for iterable sections #2020
Merged
Conversation
This file contains 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
jpy-git
commented
Dec 1, 2021
| @@ -615,7 +615,11 @@ def get( | |||
| self, val: str, section: Union[str, Iterable[str]] = "core", default: Any = None | |||
| ): | |||
| """Get a particular value from the config.""" | |||
| return self._configs[section].get(val, default) | |||
There was a problem hiding this comment.
would only work for if session a str
| @@ -615,7 +615,11 @@ def get( | |||
| self, val: str, section: Union[str, Iterable[str]] = "core", default: Any = None | |||
| ): | |||
| """Get a particular value from the config.""" | |||
| return self._configs[section].get(val, default) | |||
| section_dict = self.get_section(section) | |||
There was a problem hiding this comment.
handles nested config sections
Comment on lines
+619
to
+620
| if section_dict is None: | ||
| return default |
There was a problem hiding this comment.
returns default if the section doesn't exist. Could alternatively raise a KeyError if preferred. Fine either way
Codecov Report
@@ Coverage Diff @@
## main #2020 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 148 148
Lines 10381 10384 +3
=========================================
+ Hits 10381 10384 +3
Continue to review full report at Codecov.
|
jpy-git
changed the title
|
@barrywhart could you take a look at this please, it's a quick bugfix for the config.get method |
barrywhart
approved these changes
Dec 2, 2021
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.
Brief summary of the change made
Was using config.get method and realised it should take an iterable of str to handle nested config sections but the current implementation only works for a single section str.
Used the already existing get_sections method to handle this.
Are there any other side effects of this change that we should be aware of?
No
Pull Request checklist
Please confirm you have completed any of the necessary steps below.
Included test cases to demonstrate any code changes, which may be one or more of the following:
.ymlrule test cases intest/fixtures/rules/std_rule_cases..sql/.ymlparser test cases intest/fixtures/dialects(note YML files can be auto generated withpython test/generate_parse_fixture_yml.pyor by runningtoxlocally).test/fixtures/linter/autofix.Added appropriate documentation for the change.
Created GitHub issues for any relevant followup/future enhancements if appropriate.