Impoved config merge, bumped to v0.1.3

Author: shadowy-pycoder

README.md

@@ -25,8 +25,9 @@ pip install pyya
 
 ## Usage
 
-Create YAML configuration files for your project:
+### Example
 
+Create YAML configuration files for your project:
 
 ```yaml
 # default.config.yaml - this file usually goes to version control system
@@ -54,6 +55,7 @@ from pyya import init_config
 config = init_config(
     'config.yaml', 'default.config.yaml', 
     convert_keys_to_snake_case = False,
+    add_underscore_prefix_to_keywords = False
     raise_error_non_identifiers = False)
 print(json.dumps(config.database))
 
@@ -66,9 +68,21 @@ As you can see, `pyya` automatically merges default config file with production
 
 Under the hood `pyya` uses [PyYAML](https://pypi.org/project/PyYAML/) to parse YAML files and [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
 
-`pyya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to `snake_case`. 
+ and can be configured to . 
+
+### Flags
 
-If `raise_error_non_identifiers=True`, `pyya` will raise error if section name is not valid Python identifier.
+```python 
+convert_keys_to_snake_case=True # `pyya` converts `camelCase` or `PascalCase` keys to `snake_case`
+``` 
+
+```python 
+add_underscore_prefix_to_keywords=True # `pyya` adds underscore prefix to keys that are Python keywords
+``` 
+
+```python 
+raise_error_non_identifiers=True # `pyya` raises error if key name is not valid Python identifier
+```
 
 ## Contributing
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyya"
-version = "0.1.2"
+version = "0.1.3"
 authors = [
   { name="shadowy-pycoder", email="[email protected]" },
 ]

pyya/__init__.py

@@ -23,34 +23,49 @@ def init_config(
     default_config: Union[str, Path] = 'default.config.yaml',
     *,
     convert_keys_to_snake_case: bool = False,
+    add_underscore_prefix_to_keywords: bool = False,
     raise_error_non_identifiers: bool = False,
 ) -> Munch:
     def _merge_configs(_raw_data: ConfigType, _default_raw_data: ConfigType) -> None:
         for section, entry in _default_raw_data.items():
             if section not in _raw_data or _raw_data[section] is None:
-                section = _sanitize_section(section)
-                _raw_data[section] = entry
-                logger.warning(f'section `{section}` with value `{entry}` taken from {default_config}')
+                f_section = _sanitize_section(section)
+                if f_section not in _raw_data:
+                    _raw_data[f_section] = entry
+                    logger.warning(f'section `{f_section}` with value `{entry}` taken from {default_config}')
+                else:
+                    logger.debug(f'section `{f_section}` already exists in {config}, skipping')
             elif isinstance(entry, dict):
-                section = _sanitize_section(section)
                 _merge_configs(_raw_data[section], entry)
+            # TODO: add support for merging lists
+            else:
+                f_section = _sanitize_section(section)
+                if f_section not in _raw_data:
+                    _raw_data[f_section] = _raw_data.pop(section, None)
+                else:
+                    logger.debug(f'section `{f_section}` already exists in {config}, skipping')
 
     def _sanitize_section(section: str) -> str:
         if convert_keys_to_snake_case:
-            logger.warning(f'converting section `{section}` to snake case')
+            logger.debug(f'converting section `{section}` to snake case')
             section = to_snake(section)
         if raise_error_non_identifiers and not section.isidentifier():
             err_msg = f'section `{section}` is not a valid identifier, aborting'
             logger.error(err_msg)
             raise PyyaError(err_msg)
-        if keyword.iskeyword(section):
+        if add_underscore_prefix_to_keywords and keyword.iskeyword(section):
             logger.warning(f'section `{section}` is a keyword, renaming to `_{section}`')
             section = f'_{section}'
         return section
 
     try:
-        with open(Path(default_config)) as fstream:
-            _default_raw_data: Optional[ConfigType] = yaml.safe_load(fstream)
+        try:
+            with open(Path(default_config)) as fstream:
+                _default_raw_data: Optional[ConfigType] = yaml.safe_load(fstream)
+        except yaml.YAMLError as e:
+            err_msg = f'{default_config} file is corrupted: {e}'
+            logger.error(err_msg)
+            raise PyyaError(err_msg) from None
         if _default_raw_data is None:
             raise FileNotFoundError()
     except FileNotFoundError as e:
@@ -59,13 +74,17 @@ def _sanitize_section(section: str) -> str:
     try:
         with open(Path(config)) as fstream:
             _raw_data: ConfigType = yaml.safe_load(fstream) or {}
+    except yaml.YAMLError as e:
+        err_msg = f'{config} file is corrupted: {e}'
+        logger.error(err_msg)
+        raise PyyaError(err_msg) from None
     except FileNotFoundError:
         logger.warning(f'{config} file not found, using {default_config}')
         _raw_data = {}
     _merge_configs(_raw_data, _default_raw_data)
     try:
         return munchify(_raw_data)
     except Exception as e:
-        message = f'{default_config} file is corrupted: {repr(e)}'
-        logger.error(message)
-        raise PyyaError(message) from None
+        err_msg = f'Failed parsing config file: {e}'
+        logger.error(err_msg)
+        raise PyyaError(err_msg) from None