Encapsulate configuration file parser #44
Conversation
Changes to make it more easy to make changes to the configuration file format: - both generation and parsing are in one module - name of config no longer hardcoded in several places - abstraction from direct access to ConfigObject class It is now possible to start steve-cmd from a subdir of the project directory (e.g. the json dir)
|
PR 44 puts all the internals of accessing the config file in one place. The routine to access the config file is still there, but it returns a SteveConfig object that has a .get() method (exactly like ConfigObj but no longer directly). The name and creation are done via two new routines in util.py. The above allows for implementation of an alternative configuration file format. I intend to provide a YAML based format (mapping within mapping), so that I can also save the config file easiliy without losing information (ConfigObj, drops the comments on a roundtrip). |
|
I'm not excited about storing state in the config file. Issue #18 covers storing state. There are probably other things we want to store, like an item-by-item last_updated kind of thing. I'd rather not keep that in the config file. Better to have it elsewhere. |
| @@ -73,62 +200,31 @@ def _with_config(*args, **kw): | |||
|
|
|||
| def get_project_config(): | |||
| """Finds and opens the config file in the current directory | |||
| or parent directory | |||
There was a problem hiding this comment.
Nit: This should be dedented two spaces or alternatively reduce the length of the sentence and have it all on one line.
|
Other than that nit, this looks good. I'm going to land it now and fix the nit in another commit. Thank you! |
|
The "let's steve-cmd run in sub directories" thing is particularly awesome. |
Encapsulate configuration file parser
Changes to make it more easy to make changes to the configuration file
format:
There is an explicit jsonpath entry in the config file that can be set to have the JSON files
not reside under the directory with the configuration file.
It is now possible to start steve-cmd from a subdir of the project directory
(e.g. the json sub dir)