mooch.settings 1.0.0__tar.gz → 1.0.1__tar.gz

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mooch.settings
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python settings management package (mooch.settings). Uses a TOML file.
 Author-email: Nick Stuer <nickstuer@duck.com>
 Project-URL: Homepage, https://github.com/nickstuer/mooch.settings
@@ -28,7 +28,9 @@ Dynamic: license-file
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![license](https://img.shields.io/github/license/nickstuer/mooch.settings.svg)](LICENSE)
 
-This Python package is a collection of useful Python code that is commonly used on all types of Python projects.
+A lightweight, TOML-backed configuration/settings utility that feels like a dictionary.
+
+mooch.settings is a Python configuration library designed for simplicity and developer ergonomics. It loads settings data from TOML files and exposes them as standard Python dictionaries — allowing you to work with settings in a familiar, Python way.
 
 ## Table of Contents
 
@@ -40,9 +42,11 @@ This Python package is a collection of useful Python code that is commonly used
 
 ## 📖 Features
 
-
-### Settings File
-Uses a TOML settings file. Easily get/set settings values. Automatically sets values to defaults if they're not currently saved in the setting file.
+ - TOML-powered: Uses toml under the hood for modern, human-friendly config files.
+ - Dictionary-like interface: Access and manipulate settings with regular dict operations.
+ - Nested access: Supports nested structures and dotted key notation.
+ - Safe defaults: Easily provide fallback values or defaults when keys are missing from the config file.
+ - Optional dynamic reload: Reloads config file everytime a key is read. (Enabled by default)
 
 
 ## 🛠 Install
@@ -61,17 +65,20 @@ Python 3.9 or greater
 
 ## 🎮 Usage
 
-### settings File
+### Example
+This will create/use a 'settings.toml' file located in the .mooch directory of the user's home directory.
 ```python
 from mooch.settings import Settings
+from pathlib import Path
+
 default_settings = {
     "settings": {
-        "name": "MyName,
+        "name": "MyName",
         "mood": "happy",
     },
 }
 
-settings = Settings("settings.toml", default_settings)
+settings = Settings(Path.home() / ".mooch/settings.toml", default_settings)
 
 print(settings["settings.mood"])
 settings["settings.mood"] = "angry"

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/README.md

@@ -11,7 +11,9 @@
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![license](https://img.shields.io/github/license/nickstuer/mooch.settings.svg)](LICENSE)
 
-This Python package is a collection of useful Python code that is commonly used on all types of Python projects.
+A lightweight, TOML-backed configuration/settings utility that feels like a dictionary.
+
+mooch.settings is a Python configuration library designed for simplicity and developer ergonomics. It loads settings data from TOML files and exposes them as standard Python dictionaries — allowing you to work with settings in a familiar, Python way.
 
 ## Table of Contents
 
@@ -23,9 +25,11 @@ This Python package is a collection of useful Python code that is commonly used
 
 ## 📖 Features
 
-
-### Settings File
-Uses a TOML settings file. Easily get/set settings values. Automatically sets values to defaults if they're not currently saved in the setting file.
+ - TOML-powered: Uses toml under the hood for modern, human-friendly config files.
+ - Dictionary-like interface: Access and manipulate settings with regular dict operations.
+ - Nested access: Supports nested structures and dotted key notation.
+ - Safe defaults: Easily provide fallback values or defaults when keys are missing from the config file.
+ - Optional dynamic reload: Reloads config file everytime a key is read. (Enabled by default)
 
 
 ## 🛠 Install
@@ -44,17 +48,20 @@ Python 3.9 or greater
 
 ## 🎮 Usage
 
-### settings File
+### Example
+This will create/use a 'settings.toml' file located in the .mooch directory of the user's home directory.
 ```python
 from mooch.settings import Settings
+from pathlib import Path
+
 default_settings = {
     "settings": {
-        "name": "MyName,
+        "name": "MyName",
         "mood": "happy",
     },
 }
 
-settings = Settings("settings.toml", default_settings)
+settings = Settings(Path.home() / ".mooch/settings.toml", default_settings)
 
 print(settings["settings.mood"])
 settings["settings.mood"] = "angry"

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mooch.settings"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
   { name="Nick Stuer", email="nickstuer@duck.com" },
 ]

mooch_settings-1.0.1/src/mooch/settings/utils.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+import re
+from typing import Any
+
+
+def is_valid_key(key: str) -> bool:
+    # Bare keys: a-z, A-Z, 0-9, _, -, no quotes or spaces
+    # No support for keys with nested quotes
+    return bool(re.fullmatch(r"[A-Za-z0-9_-]+", key))
+
+
+def set_nested(d: dict, key: str, value: Any, sep: str = ".") -> None:  # noqa: ANN401
+    """Set a nested value in a dictionary by key."""
+    keys = key.split(sep)
+    for k in keys[:-1]:
+        if not is_valid_key(k):
+            error_msg = (
+                f"Invalid key: '{k}'. "
+                "Keys must be alphanumeric, underscores, or dashes, "
+                "and cannot contain spaces or quotes."
+            )
+            raise ValueError(error_msg)
+
+        if k not in d or not isinstance(d[k], dict):
+            d[k] = {}
+        d = d[k]
+    if not is_valid_key(keys[-1]):
+        error_msg = (
+            f"Invalid key: '{keys[-1]}'. "
+            "Keys must be alphanumeric, underscores, or dashes, "
+            "and cannot contain spaces or quotes."
+        )
+        raise ValueError(error_msg)
+    d[keys[-1]] = value
+
+
+def get_nested(d: dict, key: str, sep: str = ".") -> Any | None:  # noqa: ANN401
+    """Get a nested value from a dictionary by key."""
+    keys = key.split(sep)
+    for k in keys:
+        if not is_valid_key(k):
+            error_msg = (
+                f"Invalid key: '{k}'. "
+                "Keys must be alphanumeric, underscores, or dashes, "
+                "and cannot contain spaces or quotes."
+            )
+            raise ValueError(error_msg)
+        if isinstance(d, dict) and k in d:
+            d = d[k]
+        else:
+            return None
+    return d

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/src/mooch.settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mooch.settings
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python settings management package (mooch.settings). Uses a TOML file.
 Author-email: Nick Stuer <nickstuer@duck.com>
 Project-URL: Homepage, https://github.com/nickstuer/mooch.settings
@@ -28,7 +28,9 @@ Dynamic: license-file
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![license](https://img.shields.io/github/license/nickstuer/mooch.settings.svg)](LICENSE)
 
-This Python package is a collection of useful Python code that is commonly used on all types of Python projects.
+A lightweight, TOML-backed configuration/settings utility that feels like a dictionary.
+
+mooch.settings is a Python configuration library designed for simplicity and developer ergonomics. It loads settings data from TOML files and exposes them as standard Python dictionaries — allowing you to work with settings in a familiar, Python way.
 
 ## Table of Contents
 
@@ -40,9 +42,11 @@ This Python package is a collection of useful Python code that is commonly used
 
 ## 📖 Features
 
-
-### Settings File
-Uses a TOML settings file. Easily get/set settings values. Automatically sets values to defaults if they're not currently saved in the setting file.
+ - TOML-powered: Uses toml under the hood for modern, human-friendly config files.
+ - Dictionary-like interface: Access and manipulate settings with regular dict operations.
+ - Nested access: Supports nested structures and dotted key notation.
+ - Safe defaults: Easily provide fallback values or defaults when keys are missing from the config file.
+ - Optional dynamic reload: Reloads config file everytime a key is read. (Enabled by default)
 
 
 ## 🛠 Install
@@ -61,17 +65,20 @@ Python 3.9 or greater
 
 ## 🎮 Usage
 
-### settings File
+### Example
+This will create/use a 'settings.toml' file located in the .mooch directory of the user's home directory.
 ```python
 from mooch.settings import Settings
+from pathlib import Path
+
 default_settings = {
     "settings": {
-        "name": "MyName,
+        "name": "MyName",
         "mood": "happy",
     },
 }
 
-settings = Settings("settings.toml", default_settings)
+settings = Settings(Path.home() / ".mooch/settings.toml", default_settings)
 
 print(settings["settings.mood"])
 settings["settings.mood"] = "angry"

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/src/mooch.settings.egg-info/SOURCES.txt

@@ -2,7 +2,6 @@
 LICENSE
 README.md
 pyproject.toml
-settings.toml
 uv.lock
 .github/ISSUE_TEMPLATE/bug_report.md
 .github/workflows/publish.yml

{mooch_settings-1.0.0 → mooch_settings-1.0.1}/tests/test_settings.py

@@ -174,6 +174,35 @@ def test_settings_saves_settings_to_file(settings_filepath: Path):
     assert new_settings.get("mood") == "TestMood"
 
 
+def test_settings_with_different_cases_in_key(settings_filepath: Path):
+    settings = Settings(settings_filepath, default_settings)
+    settings["caseCheck"] = "value"
+
+    assert settings["caseCheck"] == "value"
+    assert settings["casecheck"] is None
+
+
+def test_settings_adds_metadata_after_init_with_default_settings(settings_filepath: Path):
+    settings = Settings(settings_filepath, default_settings)
+
+    # Check if metadata is added
+    assert settings["metadata.notice"] is not None
+    assert settings.get("metadata.notice") is not None
+    assert settings["metadata.created"] is not None
+    assert settings["metadata.updated"] is not None
+    assert settings["metadata.NotReal"] is None
+
+
+def test_settings_adds_metadata_after_init_without_default_settings(settings_filepath: Path):
+    settings = Settings(settings_filepath)
+
+    # Check if metadata is added
+    assert settings["metadata.notice"] is not None
+    assert settings["metadata.created"] is not None
+    assert settings["metadata.updated"] is not None
+    assert settings["metadata.NotReal"] is None
+
+
 def test_settings_no_default_settings(settings_filepath: Path):
     # Test with no default settings
     settings = Settings(settings_filepath)

mooch_settings-1.0.1/tests/test_utils.py

@@ -0,0 +1,107 @@
+import pytest
+
+from mooch.settings.utils import get_nested, is_valid_key, set_nested
+
+
+@pytest.mark.parametrize(
+    ("key", "expected"),
+    [
+        ("DEBUG", True),
+        ("debug-mode", True),
+        ("db.host", False),
+        ('"db.host"', False),
+        ("db host", False),
+        ("'db host'", False),
+        ('"bad"key"', False),
+        ("'bad'key'", False),
+        ("simple_key", True),
+        ("123key", True),
+        ("key-with-dash", True),
+        ("key with space", False),
+        ('"key with space in nested quotes"', False),
+        ('"key with \n newline"', False),
+        ("'single'quote'", False),
+        ("'valid key'", False),
+        ('"valid key"', False),
+        ('""', False),
+        ("", False),
+    ],
+)
+def test_is_valid_key(key, expected):
+    assert is_valid_key(key) == expected
+
+
+def test_get_nested_invalid_key():
+    d = {"a": {"b": {"c": 1}}}
+    with pytest.raises(ValueError):  # noqa: PT011
+        get_nested(d, "a.b ")
+    with pytest.raises(ValueError):  # noqa: PT011
+        get_nested(d, "b ")
+    with pytest.raises(ValueError):  # noqa: PT011
+        get_nested(d, "b .c.d.a")
+
+
+def test_set_nested_invalid_key():
+    d = {"a": {"b": {"c": 1}}}
+    with pytest.raises(ValueError):
+        set_nested(d, "a.b .c", 2)
+    with pytest.raises(ValueError):
+        set_nested(d, "b ", 2)
+    with pytest.raises(ValueError):
+        set_nested(d, "b .c.d.a", 2)
+    with pytest.raises(ValueError):
+        set_nested(d, "a.b.c ", 2)
+
+
+@pytest.mark.parametrize(
+    "initial, key, value, expected",
+    [
+        ({}, "a.b.c", 1, {"a": {"b": {"c": 1}}}),
+        ({"a": {}}, "a.b", 2, {"a": {"b": 2}}),
+        ({"a": {"b": 3}}, "a.b", 4, {"a": {"b": 4}}),
+        ({}, "x", 5, {"x": 5}),
+        ({"a": {"b": {"c": 1}}}, "a.b.d", 6, {"a": {"b": {"c": 1, "d": 6}}}),
+    ],
+)
+def test_set_nested(initial, key, value, expected):
+    d = initial.copy()
+    set_nested(d, key, value)
+    assert d == expected
+
+
+@pytest.mark.parametrize(
+    "d, key, expected",
+    [
+        ({"a": {"b": {"c": 1}}}, "a.b.c", 1),
+        ({"a": {"b": 2}}, "a.b", 2),
+        ({"x": 5}, "x", 5),
+        ({"a": {"b": {"c": 1}}}, "a.b", {"c": 1}),
+        ({"a": {"b": {"c": 1}}}, "a.b.c.d", None),
+        ({}, "foo.bar", None),
+        ({"a": 1}, "a.b", None),
+    ],
+)
+def test_get_nested(d, key, expected):
+    assert get_nested(d, key) == expected
+
+
+def test_set_nested_with_custom_separator():
+    d = {}
+    set_nested(d, "a|b|c", 10, sep="|")
+    assert d == {"a": {"b": {"c": 10}}}
+
+
+def test_get_nested_with_custom_separator():
+    d = {"a": {"b": {"c": 42}}}
+    assert get_nested(d, "a|b|c", sep="|") == 42
+
+
+def test_set_nested_overwrites_non_dict():
+    d = {"a": 1}
+    set_nested(d, "a.b", 2)
+    assert d == {"a": {"b": 2}}
+
+
+def test_get_nested_returns_none_for_non_dict():
+    d = {"a": 1}
+    assert get_nested(d, "a.b") is None

mooch_settings-1.0.0/settings.toml

@@ -1,4 +0,0 @@
-[metadata]
-notice = "This file was created by mooch.settings."
-created = "2025-06-30T04:10:17.433854+00:00"
-updated = "2025-06-30T04:10:17.433860+00:00"

mooch_settings-1.0.0/src/mooch/settings/utils.py

@@ -1,24 +0,0 @@
-from __future__ import annotations
-
-from typing import Any
-
-
-def set_nested(d: dict, key: str, value: Any, sep: str = ".") -> None:  # noqa: ANN401
-    """Set a nested value in a dictionary by key."""
-    keys = key.split(sep)
-    for k in keys[:-1]:
-        if k not in d or not isinstance(d[k], dict):
-            d[k] = {}
-        d = d[k]
-    d[keys[-1]] = value
-
-
-def get_nested(d: dict, key: str, sep: str = ".") -> Any | None:  # noqa: ANN401
-    """Get a nested value from a dictionary by key."""
-    keys = key.split(sep)
-    for k in keys:
-        if isinstance(d, dict) and k in d:
-            d = d[k]
-        else:
-            return None
-    return d

mooch_settings-1.0.0/tests/test_utils.py

@@ -1,57 +0,0 @@
-import pytest
-
-from mooch.settings.utils import get_nested, set_nested
-
-
-@pytest.mark.parametrize(
-    "initial, key, value, expected",
-    [
-        ({}, "a.b.c", 1, {"a": {"b": {"c": 1}}}),
-        ({"a": {}}, "a.b", 2, {"a": {"b": 2}}),
-        ({"a": {"b": 3}}, "a.b", 4, {"a": {"b": 4}}),
-        ({}, "x", 5, {"x": 5}),
-        ({"a": {"b": {"c": 1}}}, "a.b.d", 6, {"a": {"b": {"c": 1, "d": 6}}}),
-    ],
-)
-def test_set_nested(initial, key, value, expected):
-    d = initial.copy()
-    set_nested(d, key, value)
-    assert d == expected
-
-
-@pytest.mark.parametrize(
-    "d, key, expected",
-    [
-        ({"a": {"b": {"c": 1}}}, "a.b.c", 1),
-        ({"a": {"b": 2}}, "a.b", 2),
-        ({"x": 5}, "x", 5),
-        ({"a": {"b": {"c": 1}}}, "a.b", {"c": 1}),
-        ({"a": {"b": {"c": 1}}}, "a.b.c.d", None),
-        ({}, "foo.bar", None),
-        ({"a": 1}, "a.b", None),
-    ],
-)
-def test_get_nested(d, key, expected):
-    assert get_nested(d, key) == expected
-
-
-def test_set_nested_with_custom_separator():
-    d = {}
-    set_nested(d, "a|b|c", 10, sep="|")
-    assert d == {"a": {"b": {"c": 10}}}
-
-
-def test_get_nested_with_custom_separator():
-    d = {"a": {"b": {"c": 42}}}
-    assert get_nested(d, "a|b|c", sep="|") == 42
-
-
-def test_set_nested_overwrites_non_dict():
-    d = {"a": 1}
-    set_nested(d, "a.b", 2)
-    assert d == {"a": {"b": 2}}
-
-
-def test_get_nested_returns_none_for_non_dict():
-    d = {"a": 1}
-    assert get_nested(d, "a.b") is None