Lazy sources - after submodules #96
Open
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
sampsyo
reviewed
Jun 26, 2020
There was a problem hiding this comment.
Merged with master for legibility! Let me know if I broke anything obvious.
Because this is a fairly sensitive change and I would love to avoid breaking existing code, I'm thinking of trying to do this in a few discrete steps that are even more granular. These steps come to mind:
- The
ConfigSource.ofchanges that in turn makeConfig.addandConfig.setmuch simpler. This touches several pieces at once but should be fairly clearly behavior-preserving. - Add
YamlSource. - Finally, switch
LazyConfigto use all of that stuff instead of the current logic for lazy loading. This is the most potentially-accidentally-breaking change so we'll want to test it with real dependent projects (e.g., beets) somewhat thoroughly.
Is that phasing too outlandish?
|
|
||
| def _load_first(func): | ||
| '''Call self.load() before the function is called - used for lazy source | ||
| loading''' |
There was a problem hiding this comment.
Let's switch this to """ for uniformity.
| """ | ||
| def __init__(self, value, filename=None, default=False): | ||
| super(ConfigSource, self).__init__(value) | ||
| ''' |
There was a problem hiding this comment.
Likewise with the docstring """s.
| and os.path.splitext(value)[1] in YamlSource.EXTENSIONS) | ||
|
|
||
| def _load(self): | ||
| '''Load the file if it exists.''' |
|
I think we could do 1+2, and then do 3 separately. 1 doesn't do much for simplification unless we have 2 in place as well. |
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.
I know I keep doing new PRs, sorry. Hopefully this will be the last one!!
Basically the goal is: ConfigSources manage their entire state and minimal assumptions are made about the internal workings of a ConfigSource by other Config objects (making ConfigSources much more extendable).
So for example, say you have some custom complicated source that is made by combining multiple files and an API call (idk why). By abstracting away ConfigSource.exists for example, the config source can define that state on its own without Configuration ever having to be privy to those details.
Notes:
dict.keys(or anything else) when casting to dict, so a hotfix is to look forkeysin__getattribute__and call load ifkeyswas accessed. Obviously, I'd like to get rid of this, but I'm not sure what the best way is.2ea14dbkeyswhen casting to dict. I'm guessing that becauseConfigSourcesubclassesdict, it just doesisinstance(src, dict)