Added support for TOML file parsing

Author: shadowy-pycoder

README.md

@@ -1,4 +1,4 @@
-# pyya - Simple tool that converts YAML configuration files to Python objects
+# pyya - Simple tool that converts YAML/TOML configuration files to Python objects
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dd/pyya)
 [![ClickPy Dashboard](https://img.shields.io/badge/clickpy-dashboard-orange)](https://clickpy.clickhouse.com/dashboard/pyya)
@@ -13,10 +13,10 @@
 
 - Very `lightweight` and `simple` API (currently it contains only one function)
 - `Easy` to use
-- Based on popular and well-tested libraries (like `pydantic`, `camel-converter`, `PyYAML` and `munch`)
+- Based on popular and well-tested libraries (like `pydantic`, `camel-converter`, `PyYAML`, `toml` and `munch`)
 - Automatically `merge` default and production configuration files
 - Convert keys in configuration files to `snake_case`
-- YAML validation with `Pydantic` models
+- YAML/TOML validation with `Pydantic` models
 - Generate stub files for your dynamic configuration with `pyya` CLI tool.
 
 ## Installation
@@ -94,6 +94,8 @@ 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.
 
+For TOML files the logic is the same except you should point `pyya` to correct TOML files (e.g. `config.toml`)
+
 ### Flags
 
 ```python

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "pyya"
-version = "0.1.10"
-description = "Convert YAML configuration files to Python objects"
+version = "0.1.11"
+description = "Convert YAML/TOML configuration files to Python objects"
 readme = "README.md"
 requires-python = ">=3.8"
 authors = [
@@ -25,7 +25,9 @@ dependencies = [
   "munch>=4.0.0",
   "pydantic>=2.5.2",
   "pyyaml>=6.0.2",
+  "toml>=0.10.2",
   "types-pyyaml>=6.0.12.20240917",
+  "types-toml>=0.10.8.20240310",
 ]
 
 [project.urls]

pyya.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: pyya
-Version: 0.1.10
-Summary: Convert YAML configuration files to Python objects
+Version: 0.1.11
+Summary: Convert YAML/TOML configuration files to Python objects
 Author-email: shadowy-pycoder <shadowy-pycoder@example.com>
 Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
 Project-URL: Issues, https://github.com/shadowy-pycoder/pyya/issues
@@ -23,9 +23,11 @@ Requires-Dist: camel-converter>=3.1.2
 Requires-Dist: munch>=4.0.0
 Requires-Dist: pydantic>=2.5.2
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: toml>=0.10.2
 Requires-Dist: types-pyyaml>=6.0.12.20240917
+Requires-Dist: types-toml>=0.10.8.20240310
 
-# pyya - Simple tool that converts YAML configuration files to Python objects
+# pyya - Simple tool that converts YAML/TOML configuration files to Python objects
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dd/pyya)
 [![ClickPy Dashboard](https://img.shields.io/badge/clickpy-dashboard-orange)](https://clickpy.clickhouse.com/dashboard/pyya)
@@ -40,10 +42,10 @@ Requires-Dist: types-pyyaml>=6.0.12.20240917
 
 - Very `lightweight` and `simple` API (currently it contains only one function)
 - `Easy` to use
-- Based on popular and well-tested libraries (like `pydantic`, `camel-converter`, `PyYAML` and `munch`)
+- Based on popular and well-tested libraries (like `pydantic`, `camel-converter`, `PyYAML`, `toml` and `munch`)
 - Automatically `merge` default and production configuration files
 - Convert keys in configuration files to `snake_case`
-- YAML validation with `Pydantic` models
+- YAML/TOML validation with `Pydantic` models
 - Generate stub files for your dynamic configuration with `pyya` CLI tool.
 
 ## Installation
@@ -121,6 +123,8 @@ 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.
 
+For TOML files the logic is the same except you should point `pyya` to correct TOML files (e.g. `config.toml`)
+
 ### Flags
 
 ```python

pyya.egg-info/requires.txt

@@ -2,4 +2,6 @@ camel-converter>=3.1.2
 munch>=4.0.0
 pydantic>=2.5.2
 pyyaml>=6.0.2
+toml>=0.10.2
 types-pyyaml>=6.0.12.20240917
+types-toml>=0.10.8.20240310

pyya/__init__.py

@@ -5,11 +5,12 @@
 from pprint import pformat
 from typing import Any, Dict, List, Optional, Tuple, Type, Union
 
+import toml as _toml
 import yaml as _yaml
 from camel_converter import to_snake as _to_snake
-from munch import Munch as _Munch
 from munch import munchify as _munchify
 from pydantic import BaseModel, ConfigDict, Field, create_model, model_validator
+from toml import decoder as _toml_decoder
 
 
 logging.basicConfig(format='%(asctime)-15s \t%(levelname)-8s \t%(name)-8s \t%(message)s')
@@ -19,7 +20,7 @@
 ConfigType = Dict[str, Any]
 
 
-class PyyaConfig(_Munch): ...
+PyyaConfig = Any
 
 
 class PyyaError(RuntimeError): ...
@@ -40,7 +41,7 @@ def init_config(
     _generate_stub: bool = False,
     _stub_variable_name: str = 'config',
 ) -> PyyaConfig:
-    """Initialize attribute-stylish configuration from YAML file.
+    """Initialize attribute-stylish configuration from YAML/TOML file.
 
     Args:
         config: path to production config file
@@ -100,7 +101,7 @@ def _sanitize_section(section: str) -> str:
 
     def _pop_ignored_keys(data: ConfigType) -> ConfigType:
         for key, entry in data.copy().items():
-            if key in sections_ignored_on_merge:
+            if sections_ignored_on_merge and key in sections_ignored_on_merge:
                 data.pop(key)
                 logger.debug(f'section `{key}` ignored on merge')
             elif isinstance(entry, Dict):
@@ -203,17 +204,26 @@ def _model_and_stub_from_dict(
     def _get_default_raw_data() -> ConfigType:
         try:
             try:
+                file_path = Path(default_config)
+                if (ext := file_path.suffix) not in ('.yaml', '.yml', '.toml'):
+                    raise PyyaError(f'{default_config} file format is not supported') from None
+                file_handler = _yaml.safe_load if ext in ('.yaml', '.yml') else _toml.load
                 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
+                    _default_raw_data: Optional[ConfigType] = file_handler(fstream)
+            except (_yaml.YAMLError, _toml_decoder.TomlDecodeError) as e:
+                raise PyyaError(f'{default_config} file is corrupted: {e}') from None
             if _default_raw_data is None:
                 raise FileNotFoundError()
         except FileNotFoundError as e:
             logger.error(e)
             raise PyyaError(f'{default_config} file is missing or empty') from None
+        except PyyaError as e:
+            logger.error(e)
+            raise e from None
+        except Exception as e:
+            err_msg = f'{default_config} Unknown error: {e}'
+            logger.error(err_msg)
+            raise PyyaError(err_msg) from None
         _default_raw_data = _sanitize_keys(_default_raw_data)
         return _default_raw_data
 
@@ -226,27 +236,36 @@ def _get_default_raw_data() -> ConfigType:
         _default_raw_data = _get_default_raw_data()
         _, stub = _model_and_stub_from_dict('Config', _default_raw_data)
         stub_full = (
-            f'# {output_file} was autogenerated with pyya CLI tool, see `pyya -h`\nfrom typing import Any, Dict, List\n\n'
+            f'# {output_file} was autogenerated from {default_config} with pyya CLI tool, see `pyya -h`\nfrom typing import Any, Dict, List\n\n'
             f'{stub}\n\n'
             '# for type hints to work the variable name created with pyya.init_config\n'
             '# should have the same name (e.g. config = pyya.init_config())\n'
             f'{_stub_variable_name}: Config\n'
         )
         output_file.write_text(stub_full)
         logger.info(f'{output_file} created')
-        return PyyaConfig()
+        return None
 
     try:
+        file_path = Path(config)
+        if (ext := file_path.suffix) not in ('.yaml', '.yml', '.toml'):
+            raise PyyaError(f'{config} file format is not supported') from None
+        file_handler = _yaml.safe_load if ext in ('.yaml', '.yml') else _toml.load
         with open(Path(config)) as fstream:
-            _raw_data: ConfigType = _yaml.safe_load(fstream) or {}
+            _raw_data: ConfigType = file_handler(fstream) or {}
             _raw_data = _sanitize_keys(_raw_data)
-    except _yaml.YAMLError as e:
-        err_msg = f'{config} file is corrupted: {e}'
-        logger.error(err_msg)
-        raise PyyaError(err_msg) from None
+    except (_yaml.YAMLError, _toml_decoder.TomlDecodeError) as e:
+        raise PyyaError(f'{config} file is corrupted: {e}') from None
     except FileNotFoundError:
         logger.warning(f'{config} file not found, using {default_config}')
         _raw_data = {}
+    except PyyaError as e:
+        logger.error(e)
+        raise e from None
+    except Exception as e:
+        err_msg = f'{config} Unknown error: {e}'
+        logger.error(err_msg)
+        raise PyyaError(err_msg) from None
 
     if merge_configs:
         if sections_ignored_on_merge is None:
@@ -281,8 +300,11 @@ def _get_default_raw_data() -> ConfigType:
             logger.info(f'The following sections were overwritten:\n{pformat(_raw_data_copy)}')
     try:
         logger.debug(f'Resulting config:\n{pformat(_raw_data)}')
-        return PyyaConfig(_munchify(_raw_data))
+        return _munchify(_raw_data)
     except Exception as e:
         err_msg = f'Failed parsing config file: {e!r}'
         logger.error(err_msg)
         raise PyyaError(err_msg) from None
+
+
+__all__ = ['init_config', 'logger']

pyya/__main__.py

@@ -8,7 +8,7 @@
 def main() -> None:
     parser = argparse.ArgumentParser(description='stub generator for pyya')
     parser.add_argument(
-        '-i', '--input', default='default.config.yaml', help='path to YAML file from which to generate stub file'
+        '-i', '--input', default='default.config.yaml', help='path to YAML/TOML file from which to generate stub file'
     )
     parser.add_argument('-o', '--output', default='config.pyi', help='path to resulting stub pyi file')
     parser.add_argument('--var-name', default='config', help='variable name to refer to config object')