mooch.settings 0.0.1.dev1__tar.gz → 0.0.1.dev3__tar.gz

mooch_settings-0.0.1.dev3/.github/workflows/run_tests.yml

@@ -0,0 +1,51 @@
+name: Run Tests and Upload Coverage
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
+
+
+      - name: Install dependencies
+        run: uv pip install --system . pytest pytest-cov
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=./ --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          directory: ./coverage/reports/
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          files: ./coverage.xml,!./cache
+          flags: unittests
+          name: codecov-umbrella
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+

{mooch_settings-0.0.1.dev1/src/mooch.settings.egg-info → mooch_settings-0.0.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mooch.settings
-Version: 0.0.1.dev1
+Version: 0.0.1.dev3
 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
@@ -21,6 +21,10 @@ Dynamic: license-file
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/mooch.settings)
 <img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/nickstuer/mooch.settings">
 
+![Python Versions](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12|%203.13-blue?logo=python)
+![Codecov](https://img.shields.io/codecov/c/github/nickstuer/mooch.settings)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/nickstuer/mooch.settings/run_tests.yml)
+
 [![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)
 
@@ -38,7 +42,7 @@ This Python package is a collection of useful Python code that is commonly used
 
 
 ### Settings File
-Uses a TOML settings file. Easily get/set settingsuration values. Automatically sets values to defaults if they're not currently saved in the settingsuration 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.
 
 
 ## 🛠 Install

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/README.md

@@ -4,6 +4,10 @@
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/mooch.settings)
 <img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/nickstuer/mooch.settings">
 
+![Python Versions](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12|%203.13-blue?logo=python)
+![Codecov](https://img.shields.io/codecov/c/github/nickstuer/mooch.settings)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/nickstuer/mooch.settings/run_tests.yml)
+
 [![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)
 
@@ -21,7 +25,7 @@ This Python package is a collection of useful Python code that is commonly used
 
 
 ### Settings File
-Uses a TOML settings file. Easily get/set settingsuration values. Automatically sets values to defaults if they're not currently saved in the settingsuration 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.
 
 
 ## 🛠 Install

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/pyproject.toml

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

mooch_settings-0.0.1.dev3/src/mooch/settings/__init__.py

@@ -0,0 +1,3 @@
+from mooch.settings.settings import Settings  # noqa: D104
+
+__all__ = ["Settings"]

mooch_settings-0.0.1.dev1/src/mooch/settings/file.py → mooch_settings-0.0.1.dev3/src/mooch/settings/filehandler.py

@@ -14,20 +14,22 @@ CREATED_KEY = "metadata.created"
 UPDATED_KEY = "metadata.updated"
 
 
-class File:
+class FileHandler:
     def __init__(self, settings_filepath: Path) -> None:
         self._filepath = settings_filepath
-        self.create_file_if_not_exists()
-
-    def create_file_if_not_exists(self) -> None:
-        """Create the settings file if it does not exist."""
         if not self._filepath.exists():
-            data = {}
-            set_nested(data, NOTICE_KEY, NOTICE)
-            set_nested(data, CREATED_KEY, datetime.now(tz=timezone.utc).isoformat())
-            set_nested(data, UPDATED_KEY, datetime.now(tz=timezone.utc).isoformat())
+            self.create_file_and_directories()
+
+    def create_file_and_directories(self) -> None:
+        """Create the settings file and directories."""
+        # Ensure the parent directory exists
+        self._filepath.parent.mkdir(parents=True, exist_ok=True)
+        data = {}
+        set_nested(data, NOTICE_KEY, NOTICE)
+        set_nested(data, CREATED_KEY, datetime.now(tz=timezone.utc).isoformat())
+        set_nested(data, UPDATED_KEY, datetime.now(tz=timezone.utc).isoformat())
 
-            self.save(data)
+        self.save(data)
 
     def load(self) -> dict[str, Any]:
         """Load the settings from the file."""

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/src/mooch/settings/settings.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from pathlib import Path
 from typing import Any
 
-from mooch.settings.file import File
+from mooch.settings.filehandler import FileHandler
 from mooch.settings.utils import get_nested, set_nested
 
 
@@ -12,9 +12,19 @@ class Settings:
         self,
         settings_filepath: Path,
         default_settings: dict | None = None,
+        *,
+        dynamic_reload: bool = True,
     ) -> None:
-        self._file = File(settings_filepath)
-        self.dynamic_reload = True
+        if not isinstance(settings_filepath, Path):
+            error_message = "settings_filepath must be a Path object"
+            raise TypeError(error_message)
+        if not isinstance(default_settings, dict) and default_settings is not None:
+            error_message = "default_settings must be a dictionary or None"
+            raise TypeError(error_message)
+
+        self._settings_filepath = settings_filepath
+        self._file = FileHandler(self._settings_filepath)
+        self.dynamic_reload = dynamic_reload
 
         self._data = self._file.load()
 
@@ -22,14 +32,6 @@ class Settings:
             self._set_defaults(default_settings)
             self._file.save(self._data)
 
-    @staticmethod
-    def home_directory() -> Path:
-        """Return the path to the home directory.
-
-        Returns: Path
-        """
-        return Path.home()
-
     def get(self, key: str) -> Any | None:  # noqa: ANN401
         """Return a value from the configuration by key.
 
@@ -74,3 +76,6 @@ class Settings:
 
             elif isinstance(v, dict):
                 self._set_defaults(v, full_key)
+
+    def __repr__(self) -> str:  # noqa: D105
+        return f"Settings Stored at: {self._settings_filepath}"

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3/src/mooch.settings.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mooch.settings
-Version: 0.0.1.dev1
+Version: 0.0.1.dev3
 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
@@ -21,6 +21,10 @@ Dynamic: license-file
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/mooch.settings)
 <img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/nickstuer/mooch.settings">
 
+![Python Versions](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12|%203.13-blue?logo=python)
+![Codecov](https://img.shields.io/codecov/c/github/nickstuer/mooch.settings)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/nickstuer/mooch.settings/run_tests.yml)
+
 [![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)
 
@@ -38,7 +42,7 @@ This Python package is a collection of useful Python code that is commonly used
 
 
 ### Settings File
-Uses a TOML settings file. Easily get/set settingsuration values. Automatically sets values to defaults if they're not currently saved in the settingsuration 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.
 
 
 ## 🛠 Install

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/src/mooch.settings.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ README.md
 pyproject.toml
 settings.toml
 uv.lock
+.github/workflows/run_tests.yml
 src/mooch/__init__.py
 src/mooch.settings.egg-info/PKG-INFO
 src/mooch.settings.egg-info/SOURCES.txt
@@ -11,7 +12,7 @@ src/mooch.settings.egg-info/dependency_links.txt
 src/mooch.settings.egg-info/requires.txt
 src/mooch.settings.egg-info/top_level.txt
 src/mooch/settings/__init__.py
-src/mooch/settings/file.py
+src/mooch/settings/filehandler.py
 src/mooch/settings/settings.py
 src/mooch/settings/utils.py
 tests/test_file.py

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/tests/test_file.py

@@ -4,7 +4,7 @@ from pathlib import Path
 import pytest
 import toml
 
-from mooch.settings.file import CREATED_KEY, NOTICE, UPDATED_KEY, File
+from mooch.settings.filehandler import CREATED_KEY, NOTICE, UPDATED_KEY, FileHandler
 
 
 @pytest.fixture
@@ -17,7 +17,7 @@ def temp_settings_file(tmp_path):
 
 
 def test_create_file_if_not_exists_creates_file_with_metadata(temp_settings_file):
-    file = File(temp_settings_file)
+    file = FileHandler(temp_settings_file)
     assert temp_settings_file.exists()
     data = toml.load(temp_settings_file)
     assert data["metadata"]["notice"] == NOTICE
@@ -26,7 +26,7 @@ def test_create_file_if_not_exists_creates_file_with_metadata(temp_settings_file
 
 
 def test_load_returns_correct_data(temp_settings_file):
-    file = File(temp_settings_file)
+    file = FileHandler(temp_settings_file)
     # Write some data
     data = {"foo": {"bar": 123}}
     file.save(data)
@@ -36,7 +36,7 @@ def test_load_returns_correct_data(temp_settings_file):
 
 
 def test_save_updates_updated_timestamp(temp_settings_file):
-    file = File(temp_settings_file)
+    file = FileHandler(temp_settings_file)
     data = file.load()
     old_updated = data["metadata"]["updated"]
     # Wait a moment to ensure timestamp changes
@@ -49,7 +49,7 @@ def test_save_updates_updated_timestamp(temp_settings_file):
 
 
 def test_save_and_load_roundtrip(temp_settings_file):
-    file = File(temp_settings_file)
+    file = FileHandler(temp_settings_file)
     data = {"alpha": 1, "beta": {"gamma": 2}}
     file.save(data)
     loaded = file.load()
@@ -62,7 +62,7 @@ def test_create_file_if_not_exists_does_not_overwrite_existing(temp_settings_fil
     # Create file manually
     with Path.open(temp_settings_file, "w", encoding="utf-8") as f:
         f.write('[custom]\nkey="value"\n')
-    file = File(temp_settings_file)
+    file = FileHandler(temp_settings_file)
     data = file.load()
     assert "custom" in data
     assert data["custom"]["key"] == "value"

{mooch_settings-0.0.1.dev1 → mooch_settings-0.0.1.dev3}/tests/test_settings.py

@@ -22,8 +22,8 @@ default_settings2 = {
 @pytest.fixture
 def settings_filepath(tmpdir_factory: pytest.TempdirFactory):
     temp_dir = str(tmpdir_factory.mktemp("temp"))
-    filepath = temp_dir + "/settings.toml"
-    yield Path(filepath)
+    temp_testing_dir = temp_dir + "/testing/settings.toml"
+    yield Path(temp_testing_dir)
     # yield Path("settings.toml")
     shutil.rmtree(temp_dir)
 
@@ -45,7 +45,37 @@ def test_settings_initializes_with_default_settings(settings_filepath: Path):
     assert settings.get("foo") is None
 
 
-def test_settings_sets_default_settings_if_not_present(settings_filepath: str):
+@pytest.mark.parametrize(
+    ("value"),
+    [
+        ("settings.toml"),
+        (523),
+        (None),
+        (["settings.toml"]),
+        ({"settings.toml": "value"}),
+    ],
+)
+def test_settings_settings_filepath_types_fails(value):
+    with pytest.raises(TypeError) as exc_info:
+        Settings(value)
+    assert str(exc_info.value) == "settings_filepath must be a Path object"
+
+
+@pytest.mark.parametrize(
+    ("value"),
+    [
+        ("settings.toml"),
+        (523),
+        (["settings.toml"]),
+    ],
+)
+def test_settings_default_settings_types_fails(value, settings_filepath):
+    with pytest.raises(TypeError) as exc_info:
+        Settings(settings_filepath, value)
+    assert str(exc_info.value) == "default_settings must be a dictionary or None"
+
+
+def test_settings_sets_default_settings_if_not_present(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
     assert settings.get("foo") is None
 
@@ -57,7 +87,7 @@ def test_settings_sets_default_settings_if_not_present(settings_filepath: str):
         assert new_settings.get(k) == v
 
 
-def test_settings_get_and_set_methods_success(settings_filepath: str):
+def test_settings_get_and_set_methods_success(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     settings.set("string", "string_value")
@@ -93,7 +123,7 @@ def test_settings_get_and_set_methods_success(settings_filepath: str):
     assert settings.get("emoji") == "😊"
 
 
-def test_settings_overrides_existing_settings(settings_filepath: str):
+def test_settings_overrides_existing_settings(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     # Set an initial value
@@ -105,14 +135,15 @@ def test_settings_overrides_existing_settings(settings_filepath: str):
     assert settings.get("name") == "NewName"
 
 
-def test_settings_handles_non_existent_keys(settings_filepath: str):
+def test_settings_handles_non_existent_keys(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     assert settings.get("non_existent_key") is None
 
 
-def test_settings_handles_empty_settings_file(settings_filepath: str):
+def test_settings_handles_empty_settings_file(settings_filepath: Path):
     # Create an empty settings file
+    settings_filepath.parent.mkdir(parents=True, exist_ok=True)
     with Path.open(settings_filepath, "w") as f:
         f.write("")
     settings = Settings(settings_filepath, default_settings)
@@ -121,7 +152,16 @@ def test_settings_handles_empty_settings_file(settings_filepath: str):
         assert settings.get(k) == v
 
 
-def test_settings_saves_settings_to_file(settings_filepath: str):
+def test_settings_handles_creating_directories_for_new_files(settings_filepath: Path):
+    parent_dir = settings_filepath.parent
+
+    assert not parent_dir.exists(), "Parent directory should not exist before test"
+
+    settings = Settings(settings_filepath, default_settings)
+    assert parent_dir.exists(), "Parent directory should be created by Settings class"
+
+
+def test_settings_saves_settings_to_file(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     # Set some values
@@ -134,7 +174,7 @@ def test_settings_saves_settings_to_file(settings_filepath: str):
     assert new_settings.get("mood") == "TestMood"
 
 
-def test_settings_no_default_settings(settings_filepath: str):
+def test_settings_no_default_settings(settings_filepath: Path):
     # Test with no default settings
     settings = Settings(settings_filepath)
 
@@ -151,7 +191,7 @@ def test_settings_no_default_settings(settings_filepath: str):
     assert new_settings.get("name") == "NoDefaultName"
 
 
-def test_settings_with_getitem_and_setitem(settings_filepath: str):
+def test_settings_with_getitem_and_setitem(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     # Test __getitem__
@@ -167,7 +207,7 @@ def test_settings_with_getitem_and_setitem(settings_filepath: str):
     assert settings["new_key"] == "new_value"
 
 
-def test_settings_updates_defaults_with_nested_dict(settings_filepath: str):
+def test_settings_updates_defaults_with_nested_dict(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
     assert settings.get("dictionary.subdictionary.key3") is None
     assert settings["dictionary.subdictionary.key3"] is None
@@ -180,7 +220,7 @@ def test_settings_updates_defaults_with_nested_dict(settings_filepath: str):
     assert new_settings["dictionary"]["subdictionary"]["key3"] == "subvalue3"
 
 
-def test_settings_initializes_defaults_with_nested_dict(settings_filepath: str):
+def test_settings_initializes_defaults_with_nested_dict(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings2)
     assert settings.get("settings.name") == "MyName"
     assert settings.get("settings.mood") == "MyMood"
@@ -197,7 +237,7 @@ def test_settings_initializes_defaults_with_nested_dict(settings_filepath: str):
     assert settings.get("settings") == {"gui": {"theme": {"ios": "dark"}}, "mood": "MyMood", "name": "MyName"}
 
 
-def test_settings_sets_default_settings_of_nested_dictionaries_if_not_present(settings_filepath: str):
+def test_settings_sets_default_settings_of_nested_dictionaries_if_not_present(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings2)
     assert settings.get("settings.gui.theme.ios") == "dark"
     assert settings.get("settings.gui.theme.android") is None
@@ -214,14 +254,7 @@ def test_settings_sets_default_settings_of_nested_dictionaries_if_not_present(se
     assert new_settings.get("settings.gui.theme.android") == "light"
 
 
-def test_settings_home_directory():
-    settings = Settings(Path("settings.toml"))
-    home_dir = settings.home_directory()
-    assert home_dir.is_dir()  # Check if the home directory exists
-    assert home_dir == Path.home()  # Ensure it matches the actual home directory
-
-
-def test_settings_dynamic_reload_true(settings_filepath: str):
+def test_settings_dynamic_reload_true(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
 
     assert settings.get("settings.name") == "MyName"
@@ -234,7 +267,7 @@ def test_settings_dynamic_reload_true(settings_filepath: str):
     assert settings.get("settings.name") == "NewName"
 
 
-def test_settings_dynamic_reload_false(settings_filepath: str):
+def test_settings_dynamic_reload_false(settings_filepath: Path):
     settings = Settings(settings_filepath, default_settings)
     settings.dynamic_reload = False
 
@@ -244,5 +277,9 @@ def test_settings_dynamic_reload_false(settings_filepath: str):
     settings2 = Settings(settings_filepath, default_settings)
     settings2.set("settings.name", "NewName")
 
-    # Verify that the change is reflected in the original settings object
-    assert settings.get("settings.name") == "MyName"
+
+# Verify that the change is reflected in the original settings object
+def test_settings_repr_returns_expected_string(settings_filepath: Path):
+    settings = Settings(settings_filepath, default_settings)
+    expected = f"Settings Stored at: {settings_filepath}"
+    assert repr(settings) == expected

mooch_settings-0.0.1.dev1/src/mooch/settings/__init__.py

@@ -1,4 +0,0 @@
-
-from mooch.settings.settings import Settings
-
-__all__ = ["Settings"]