mooch.settings 0.0.1.dev4__py3-none-any.whl → 1.0.1__py3-none-any.whl

mooch/settings/utils.py

@@ -1,15 +1,37 @@
 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
 
 
@@ -17,6 +39,13 @@ 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:

{mooch_settings-0.0.1.dev4.dist-info → mooch_settings-1.0.1.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: mooch.settings
-Version: 0.0.1.dev4
+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
 Project-URL: Issues, https://github.com/nickstuer/mooch.settings/issues
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -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.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+mooch/__init__.py,sha256=_ZVUSDxucTCJe9q2wP1tI31qEX3m4QGcH7kn3BRv6ic,112
+mooch/settings/__init__.py,sha256=D5YbYh6gPIJXOwYlX0FDTRLDoUu0wfnJd1jdvh59ju0,83
+mooch/settings/filehandler.py,sha256=X3_kFcCtoJt3yI5v_r4GEKaoQIpimlwFPQxYPP5UKPE,1503
+mooch/settings/settings.py,sha256=zN6l-8amrrm66h8afOvifv-WdgObpHVlUIEzEs9mN3g,2603
+mooch/settings/utils.py,sha256=sWemTFz_hhDjEJMXse76_jxT9W-N1Jgt5OhXV_Fs86A,1688
+mooch_settings-1.0.1.dist-info/licenses/LICENSE,sha256=FU8uKPcPjgV4M_aaYQPSM5abrktGqLFX2VEUk9oBYIE,1067
+mooch_settings-1.0.1.dist-info/METADATA,sha256=34U-C9qXRoslRyYym0JblTyOPMdemhsbVeLt18pPdxs,3963
+mooch_settings-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mooch_settings-1.0.1.dist-info/top_level.txt,sha256=BbCxYfdneRNeyhPyAVvt8IEDA_Px7BIm5zhH6hEmsAo,6
+mooch_settings-1.0.1.dist-info/RECORD,,

mooch_settings-0.0.1.dev4.dist-info/RECORD

@@ -1,10 +0,0 @@
-mooch/__init__.py,sha256=_ZVUSDxucTCJe9q2wP1tI31qEX3m4QGcH7kn3BRv6ic,112
-mooch/settings/__init__.py,sha256=D5YbYh6gPIJXOwYlX0FDTRLDoUu0wfnJd1jdvh59ju0,83
-mooch/settings/filehandler.py,sha256=X3_kFcCtoJt3yI5v_r4GEKaoQIpimlwFPQxYPP5UKPE,1503
-mooch/settings/settings.py,sha256=zN6l-8amrrm66h8afOvifv-WdgObpHVlUIEzEs9mN3g,2603
-mooch/settings/utils.py,sha256=V-aFKlrLaDfuJed4Yn-1pxlIM8jzdr4xRrNflBxLfXc,665
-mooch_settings-0.0.1.dev4.dist-info/licenses/LICENSE,sha256=FU8uKPcPjgV4M_aaYQPSM5abrktGqLFX2VEUk9oBYIE,1067
-mooch_settings-0.0.1.dev4.dist-info/METADATA,sha256=saXexWmtLe3kfExxjGVRDIFLkhHuLG2pBVl46fp4MA4,3308
-mooch_settings-0.0.1.dev4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mooch_settings-0.0.1.dev4.dist-info/top_level.txt,sha256=BbCxYfdneRNeyhPyAVvt8IEDA_Px7BIm5zhH6hEmsAo,6
-mooch_settings-0.0.1.dev4.dist-info/RECORD,,