pyya 0.1.0__py3-none-any.whl

pyya/__init__.py

@@ -0,0 +1,71 @@
+import keyword
+import logging
+from pathlib import Path
+from typing import Any, Dict, Optional, Union
+
+import yaml
+from camel_converter import to_snake
+from munch import Munch, munchify
+
+
+logging.basicConfig(format='%(asctime)-15s \t%(levelname)-8s \t%(name)-8s \t%(message)s')
+logger = logging.getLogger('paya')
+
+
+ConfigType = Dict[str, Any]
+
+
+class PayaError(RuntimeError): ...
+
+
+def init_config(
+    config: Union[str, Path] = 'config.yaml',
+    default_config: Union[str, Path] = 'default.config.yaml',
+    *,
+    convert_keys_to_snake_case: 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}')
+            elif isinstance(entry, dict):
+                section = _sanitize_section(section)
+                _merge_configs(_raw_data[section], entry)
+
+    def _sanitize_section(section: str) -> str:
+        if convert_keys_to_snake_case:
+            logger.warning(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 PayaError(err_msg)
+        if 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)
+        if _default_raw_data is None:
+            raise FileNotFoundError()
+    except FileNotFoundError as e:
+        logger.error(e)
+        raise PayaError(f'{default_config} file is missing or empty') from None
+    try:
+        with open(Path(config)) as fstream:
+            _raw_data: ConfigType = yaml.safe_load(fstream) or {}
+    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 PayaError(message) from None

pyya-0.1.0.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: pyya
+Version: 0.1.0
+Summary: Convert YAML configuration files to Python objects
+Author-email: shadowy-pycoder <shadowy-pycoder@example.com>
+Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
+Project-URL: Repository, https://github.com/shadowy-pycoder/pyya
+Project-URL: Issues, https://github.com/shadowy-pycoder/pyya/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: camel-converter >=3.1.2
+Requires-Dist: munch >=4.0.0
+Requires-Dist: pyyaml >=6.0.2
+Requires-Dist: types-pyyaml >=6.0.12.20240917
+
+# paya - Simple tool that converts YAML configuration files to Python objects
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
+## Installation
+
+```shell
+pip install pyya
+```
+
+## Usage
+
+Create YAML configuration files for your project:
+
+
+```yaml
+# default.config.yaml - this file usually goes to version control system
+database:   
+    host: localhost
+    port: 5432
+    username: postgres
+    password: postgres
+```
+
+```yaml
+# config.yaml - this file for production usage
+database:   
+    username: username
+    password: password
+```
+
+Import configuration files in your Python code with pyya:
+
+```python
+import json
+
+from pyya import init_config
+
+config = init_config(
+    'config.yaml', 'default.config.yaml', 
+    convert_keys_to_snake_case = False,
+    raise_error_non_identifiers = False)
+print(json.dumps(config.database))
+
+# Output:
+# {"host": "localhost", "port": 5432, "username": "username", "password": "password"}
+
+```
+
+As you can see, pyya automatically merges default config file with production config file.
+
+Under the hood `pyya` uses [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
+
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+
+If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+
+## Contributing
+
+Are you a developer?
+
+- Fork the repository
+- Create your feature branch: `git switch -c my-new-feature`
+- Commit your changes: `git commit -am 'Add some feature'`
+- Push to the branch: `git push origin my-new-feature`
+- Submit a pull request

pyya-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+pyya/__init__.py,sha256=khXPCVFAGOy4RjKqz45xYaePBZ5WIqKJ7rC5wp6609c,2662
+pyya-0.1.0.dist-info/METADATA,sha256=aNgp1BNEZFDMbIhvt6x0w7djyaNfxGjhzLur8mvzF0g,2848
+pyya-0.1.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+pyya-0.1.0.dist-info/top_level.txt,sha256=81clY-eZ87xIwCdhb-J4id4Cm3jzUOBVt5_AY3JBDvo,5
+pyya-0.1.0.dist-info/RECORD,,

pyya-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyya-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyya