This repository was archived by the owner on Jan 19, 2018. It is now read-only.
Refactor Nulecule config. #720
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| import copy | ||
| import logging | ||
|
|
||
| from atomicapp.constants import (GLOBAL_CONF, | ||
| LOGGER_COCKPIT, | ||
| DEFAULT_PROVIDER, | ||
| DEFAULT_ANSWERS) | ||
| from collections import defaultdict | ||
|
|
||
| cockpit_logger = logging.getLogger(LOGGER_COCKPIT) | ||
|
|
||
|
|
||
| class Config(object): | ||
| """ | ||
| This class allows to store config data in different scopes along with | ||
| source info for the data. When fetching the value for a key in a scope, | ||
| the source info and the PRIORITY order of sources is taken into account. | ||
|
|
||
| Data sources: | ||
| cli: Config data coming from the CLI | ||
| runtime: Config data resolved during atomic app runtime. For example, | ||
| when the value for a parameter in a Nulecule or Nulecule graph | ||
| item is missing in answers data, we first try to load the default | ||
| value for the parameter. When there's no default value, or when | ||
| the user has specified to forcefully ask the user for values, we | ||
| ask the user for data. These data collected/resolved during runtime | ||
| form the runtime data. | ||
| answers: Config data coming from answers file | ||
| defaults: Default config data specified in atomicapp/constants.py | ||
|
|
||
| The priority order of the data sources is: | ||
| cli > runtime > answers > defaults | ||
| """ | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Can we get a summary of each |
||
| PRIORITY = ( | ||
| 'cli', | ||
| 'runtime', | ||
| 'answers', | ||
| 'defaults' | ||
| ) | ||
|
|
||
| def __init__(self, answers=None, cli=None): | ||
| """ | ||
| Initialize a Config instance. | ||
|
|
||
| Args: | ||
| answers (dict): Answers data | ||
| cli (dict): CLI data | ||
| """ | ||
| answers = answers or {} | ||
| cli = cli or {} | ||
| # We use a defaultdict of defaultdicts so that we can avoid doing | ||
| # redundant checks in a nested dictionary if the value of the keys | ||
| # are dictionaries or None. | ||
| self._data = defaultdict(defaultdict) | ||
| # Initialize default data dict | ||
| self._data['defaults'] = defaultdict(defaultdict) | ||
| # Initialize answers data dict | ||
| self._data['answers'] = defaultdict(defaultdict) | ||
| # Initialize cli data dict | ||
| self._data['cli'] = defaultdict(defaultdict) | ||
| # Initialize runtime data dict | ||
| self._data['runtime'] = defaultdict(defaultdict) | ||
|
|
||
|
Contributor
There was a problem hiding this comment. would be nice to have a 1 line comment above each one of these for loops below |
||
| # Load default answers | ||
| for scope, data in DEFAULT_ANSWERS.items(): | ||
| for key, value in data.items(): | ||
| self.set(key, value, scope=scope, source='defaults') | ||
| self.set('provider', DEFAULT_PROVIDER, scope=GLOBAL_CONF, source='defaults') | ||
|
|
||
| # Load answers data | ||
| for scope, data in answers.items(): | ||
| for key, value in data.items(): | ||
| self.set(key, value, scope=scope, source='answers') | ||
|
|
||
| # Load cli data | ||
| for key, value in cli.items(): | ||
| self.set(key, value, scope=GLOBAL_CONF, source='cli') | ||
|
|
||
| def get(self, key, scope=GLOBAL_CONF, ignore_sources=[]): | ||
| """ | ||
| Get the value of a key in a scope. This takes care of resolving | ||
| the value by going through the PRIORITY order of the various | ||
| sources of data. | ||
|
|
||
| Args: | ||
| key (str): Key | ||
| scope (str): Scope from which to fetch the value for the key | ||
|
|
||
| Returns: | ||
| Value for the key. | ||
| """ | ||
| for source in self.PRIORITY: | ||
| if source in ignore_sources: | ||
| continue | ||
| value = self._data[source][scope].get(key) or self._data[source][ | ||
| GLOBAL_CONF].get(key) | ||
| if value: | ||
| return value | ||
|
Contributor
There was a problem hiding this comment. I know |
||
| return None | ||
|
|
||
| def set(self, key, value, source, scope=GLOBAL_CONF): | ||
| """ | ||
| Set the value for a key within a scope along with specifying the | ||
| source of the value. | ||
|
|
||
| Args: | ||
| key (str): Key | ||
| value: Value | ||
| scope (str): Scope in which to store the value | ||
| source (str): Source of the value | ||
| """ | ||
| self._data[source][scope][key] = value | ||
|
|
||
| def context(self, scope=GLOBAL_CONF): | ||
| """ | ||
| Get context data for the scope of Nulecule graph item by aggregating | ||
| the data from various sources taking their priority order into | ||
| account. This context data, which is a flat dictionary, is used to | ||
| render the variables in the artifacts of Nulecule graph item. | ||
|
|
||
| Args: | ||
| scope (str): Scope (or namespace) for the Nulecule graph item. | ||
| Returns: | ||
| A dictionary | ||
| """ | ||
| result = {} | ||
| for source in reversed(self.PRIORITY): | ||
| source_data = self._data[source] | ||
| result.update(copy.deepcopy(source_data.get(GLOBAL_CONF) or {})) | ||
| if scope != GLOBAL_CONF: | ||
| result.update(copy.deepcopy(source_data.get(scope) or {})) | ||
| return result | ||
|
|
||
| def runtime_answers(self): | ||
| """ | ||
| Get runtime answers. | ||
|
|
||
| Returns: | ||
| A defaultdict containing runtime answers data. | ||
| """ | ||
| answers = defaultdict(dict) | ||
|
|
||
| for source in reversed(self.PRIORITY): | ||
| for scope, data in (self._data.get(source) or {}).items(): | ||
| answers[scope].update(copy.deepcopy(data)) | ||
|
|
||
| # Remove empty sections for answers | ||
| for key, value in answers.items(): | ||
| if not value: | ||
| answers.pop(key) | ||
|
|
||
| return answers | ||
|
|
||
| def update_source(self, source, data): | ||
| """ | ||
| Update answers data for a source. | ||
|
|
||
| Args: | ||
| source (str): Source name | ||
| data (dict): Answers data | ||
| """ | ||
| data = data or {} | ||
| if source not in self._data: | ||
| raise | ||
|
|
||
| # clean up source data | ||
| for k in self._data[source]: | ||
| self._data[source].pop(k) | ||
|
|
||
| for scope, data in data.items(): | ||
| for key, value in data.items(): | ||
| self.set(key, value, scope=scope, source=source) | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this FIXME can be removed since you're fixing it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yay! 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the FIXME comment is still there in the code.