Added replacing dashes with underscores in section names and keys, added basic tests

Author: shadowy-pycoder

.gitignore

@@ -5,6 +5,5 @@ __pycache__/
 .mypy_cache
 .coverage
 .env
-config.yaml
 .test.env
-*.log
+*.log

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 shadowy-pycoder
+Copyright (c) 2025 shadowy-pycoder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -73,6 +73,7 @@ config = init_config(
     convert_keys_to_snake_case = False,
     add_underscore_prefix_to_keywords = False,
     raise_error_non_identifiers = False,
+    replace_dashes_with_underscores = False,
     merge_configs = True,
     sections_ignored_on_merge = ['redis'], # do not include redis in your config
     validate_data_types = True,
@@ -113,6 +114,11 @@ add_underscore_prefix_to_keywords=False
 raise_error_non_identifiers=False
 ```
 
+```python
+# replace dashes with underscores in section names and keys
+replace_dashes_with_underscores=False
+```
+
 ```python
 # merge default and production configuration files
 # setting to `False` disables below flags and makes default config optional

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyya"
-version = "0.1.11"
+version = "0.1.12"
 description = "Convert YAML/TOML configuration files to Python objects"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -38,6 +38,11 @@ Repository = "https://github.com/shadowy-pycoder/pyya"
 [project.scripts]
 pyya = "pyya.__main__:main"
 
+[dependency-groups]
+dev = [
+  "pytest>=8.3.5",
+]
+
 [tool.mypy]
 python_version = "3.8"
 cache_dir = ".mypy_cache/strict"
@@ -67,9 +72,6 @@ filterwarnings = [
   "ignore::ResourceWarning",
 ]
 pythonpath = "."
-asyncio_mode = "auto"
-env_files = ".test.env"
-env_override_existing_values = true
 
 [tool.ruff]
 exclude = [

pyya.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyya
-Version: 0.1.11
+Version: 0.1.12
 Summary: Convert YAML/TOML configuration files to Python objects
 Author-email: shadowy-pycoder <[email protected]>
 Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
@@ -102,6 +102,7 @@ config = init_config(
     convert_keys_to_snake_case = False,
     add_underscore_prefix_to_keywords = False,
     raise_error_non_identifiers = False,
+    replace_dashes_with_underscores = False,
     merge_configs = True,
     sections_ignored_on_merge = ['redis'], # do not include redis in your config
     validate_data_types = True,
@@ -142,6 +143,11 @@ add_underscore_prefix_to_keywords=False
 raise_error_non_identifiers=False
 ```
 
+```python
+# replace dashes with underscores in section names and keys
+replace_dashes_with_underscores=False
+```
+
 ```python
 # merge default and production configuration files
 # setting to `False` disables below flags and makes default config optional

pyya.egg-info/SOURCES.txt

@@ -9,4 +9,6 @@ pyya.egg-info/SOURCES.txt
 pyya.egg-info/dependency_links.txt
 pyya.egg-info/entry_points.txt
 pyya.egg-info/requires.txt
-pyya.egg-info/top_level.txt
+pyya.egg-info/top_level.txt
+tests/test_toml.py
+tests/test_yaml.py

pyya/__init__.py

@@ -33,6 +33,7 @@ def init_config(
     convert_keys_to_snake_case: bool = False,
     add_underscore_prefix_to_keywords: bool = False,
     raise_error_non_identifiers: bool = False,
+    replace_dashes_with_underscores: bool = False,
     merge_configs: bool = True,
     sections_ignored_on_merge: Optional[List[str]] = None,
     validate_data_types: bool = True,
@@ -49,6 +50,7 @@ def init_config(
         convert_keys_to_snake_case: convert config section names to snake case
         add_underscore_prefix_to_keywords: add underscore prefix to Python keywords
         raise_error_non_identifiers: raise error if config section name is not a valid identifier
+        replace_dashes_with_underscores: replace dashes with underscores in section names and keys
         merge_configs: merge default config with production config (setting to `False` disables flags below)
         sections_ignored_on_merge: list of sections to ignore when merging configs
         validate_data_types: raise error if data types in production config are not the same as default
@@ -94,8 +96,10 @@ def _sanitize_section(section: str) -> str:
             err_msg = f'section `{section}` is not a valid identifier, aborting'
             logger.error(err_msg)
             raise PyyaError(err_msg)
+        if replace_dashes_with_underscores:
+            section = section.replace('-', '_')
         if add_underscore_prefix_to_keywords and keyword.iskeyword(section):
-            logger.info(f'section `{section}` is a keyword, renaming to `_{section}`')
+            logger.debug(f'section `{section}` is a keyword, renaming to `_{section}`')
             section = f'_{section}'
         return section
 
@@ -163,7 +167,9 @@ def _model_and_stub_from_dict(
         fields: Dict[Any, Any] = {}
         if path is None:
             path = []
-        class_name = ''.join(part.capitalize() if i > 0 else part for i, part in enumerate(path + [name]))
+        class_name = ''.join(part.capitalize() if i > 0 else part for i, part in enumerate(path + [name])).replace(
+            '-', '_'
+        )
         stub_lines = [f'class {class_name}(Dict[str, Any]):']
         nested_stubs = []
         py_type: Any
@@ -198,7 +204,7 @@ def _model_and_stub_from_dict(
                 if not keyword.iskeyword(section) and section.isidentifier():
                     stub_lines.append(f'    {section}: {py_type.__name__}')
                 fields[section] = (py_type, entry)
-        stub_code = '\n\n'.join(nested_stubs + ['\n'.join(stub_lines)]).replace('-', '_')
+        stub_code = '\n\n'.join(nested_stubs + ['\n'.join(stub_lines)])
         return create_model(name, **fields, __base__=ExtraBase), stub_code
 
     def _get_default_raw_data() -> ConfigType:

pyya/__main__.py

@@ -14,6 +14,7 @@ def main() -> None:
     parser.add_argument('--var-name', default='config', help='variable name to refer to config object')
     parser.add_argument('--to-snake', action='store_true', help='convert config section names to snake case')
     parser.add_argument('--add-prefix', action='store_true', help='add underscore prefix to Python keywords')
+    parser.add_argument('--replace-dashes', action='store_true', help='replace dashes with underscores in names')
     parser.add_argument('--debug', action='store_true', help='print debug messages')
     args = parser.parse_args()
     logger.setLevel(logging.INFO)
@@ -25,6 +26,7 @@ def main() -> None:
             args.input,
             convert_keys_to_snake_case=args.to_snake,
             add_underscore_prefix_to_keywords=args.add_prefix,
+            replace_dashes_with_underscores=args.replace_dashes,
             _generate_stub=True,
             _stub_variable_name=args.var_name,
         )

tests/__init__.py

@@ -0,0 +1,47 @@
+from pathlib import Path
+
+import pytest
+
+import pyya
+
+
+config_path = Path(__file__).parent / 'testdata/config.toml'
+default_config_path = Path(__file__).parent / 'testdata/default.config.toml'
+
+
+def test_default_setup() -> None:
+    config = pyya.init_config(config=config_path, default_config=default_config_path, validate_data_types=False)
+    assert config.app.name == 'myapp_changed'
+    assert config.app.debug is True
+    assert config.app.port == 9091
+    assert config.database.password == 'secret_changed'
+    assert len(config.database.replicas) == 1
+    assert config.logging.level == 'debug'
+    assert config.logging.rotate.enabled is False
+    assert len(config.cache.servers) == 1
+
+
+def test_replace_dashes_with_undescores() -> None:
+    config = pyya.init_config(
+        config=config_path,
+        default_config=default_config_path,
+        replace_dashes_with_underscores=True,
+        validate_data_types=False,
+    )
+    assert config.logging.rotate.keep_files == 3
+
+
+def test_sections_ignored_on_merge() -> None:
+    with pytest.raises(AttributeError, match=r'environments'):
+        config = pyya.init_config(
+            config=config_path,
+            default_config=default_config_path,
+            sections_ignored_on_merge=['environments'],
+            validate_data_types=False,
+        )
+        _ = config.environments
+
+
+def test_validate_data_types() -> None:
+    with pytest.raises(pyya.PyyaError, match=r'cache.enabled'):
+        _ = pyya.init_config(config=config_path, default_config=default_config_path)