django-dataclassconf 0.1.0__py3-none-any.whl

django_dataclassconf/__init__.py

@@ -0,0 +1,9 @@
+__version__ = '0.1.0'
+
+from .conf import BaseConfig, config_loader
+
+__all__ = [
+    "BaseConfig", 
+    "config_loader", 
+    "__version__",
+]

django_dataclassconf/conf.py

@@ -0,0 +1,92 @@
+"""Implements an Observer pattern for when settings have changed"""
+from django.test.signals import setting_changed
+from django.conf import settings
+
+from abc import ABC, abstractmethod
+from dataclasses import asdict
+from dacite import from_dict
+import typing
+
+
+class BaseConfig(ABC):
+    """Base class that updates a dataclass to use them as config classes"""
+    @property
+    @abstractmethod
+    def _prefix(self) -> str: ...
+
+    def update(self, config_data: typing.Dict[str, typing.Any]):
+        previous_data = asdict(self)
+        new_data = {**previous_data, **config_data}
+        validated_instance = from_dict(data_class = self.__class__, data = new_data)
+        vars(self).update(vars(validated_instance))
+
+
+class PackageConfigLoader:
+    """Loads config into multiple dataclasses"""
+    def __init__(self):
+        self._dataclass_configs: typing.List[BaseConfig] = []
+
+    @property
+    def prefixes(self) -> typing.List[str]:
+        """Provides the list of prefixes available in config loader, excludes empty prefixes"""
+        return [
+            config._prefix 
+            for config in self._dataclass_configs 
+            if config._prefix
+        ]
+    
+    def subscribe(self, config: BaseConfig):
+        if config not in self._dataclass_configs:
+            self._dataclass_configs.append(config)
+            self.refresh_config(config, self._settings_as_dict())
+
+    def refresh_config(
+        self, config: BaseConfig, 
+        config_data: typing.Dict[str, typing.Any]
+    ):
+        """Refreshes a single specific configuration instance from raw settings"""
+        prefix = config._prefix
+        if not prefix:
+            config.update(config_data)
+            return
+        
+        prefix_ = f'{prefix}_'
+        flat_config = { 
+            k.removeprefix(prefix_): v 
+            for k, v in config_data.items() 
+            if k.startswith(prefix_) 
+        }
+
+        config_dict = config_data.get(prefix, {})
+        if isinstance(config_dict, config.__class__):
+            config_dict = asdict(config_dict)
+
+        elif not isinstance(config_dict, dict):
+            config_dict = {}
+
+        config.update({**config_dict, **flat_config})
+
+    def refresh_all(self, setting: str):
+        config_data = None
+        for config in self._dataclass_configs:
+            prefix = config._prefix
+            prefix_ = f'{prefix}_'
+
+            if not prefix or setting == prefix or setting.startswith(prefix_):
+                if config_data is None:
+                    config_data = self._settings_as_dict()
+                self.refresh_config(config, config_data)
+
+    def _settings_as_dict(self) -> typing.Dict[str, typing.Any]:
+        return {
+            k: getattr(settings, k)
+            for k in dir(settings)
+            if k.isupper()
+        }
+
+
+config_loader = PackageConfigLoader()
+
+def refresh_settings(sender, setting, value, enter, **kwargs):
+    config_loader.refresh_all(setting)
+setting_changed.connect(refresh_settings)

django_dataclassconf-0.1.0.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: django_dataclassconf
+Version: 0.1.0
+Summary: A simple Django package setting loader that utilizes dataclasses for type hinting and type checking
+Author-email: Felix Leo Flores <floresfelixleo.fleurs96@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/Jxst-Felix/django-dataclassconf
+Project-URL: Issues, https://github.com/Jxst-Felix/django-dataclassconf/issues
+Keywords: django,settings,configuration,dataclasses,type-hints
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.0,>=4.2
+Requires-Dist: dacite>=1.8.0
+Dynamic: license-file
+
+<!-- Add badges here later when I have github actions, pypi link, and all -->
+
+# Django DataclassConf
+
+A simple Django package setting loader that utilizes dataclasses for type hinting and type checking.
+
+Bring modern Python typing, robust validation, and full IDE autocomplete to your Django configurations.
+
+`django-dataclassconf` allows you to bind your Django settings cleanly to structured standard Python `dataclasses`. Powered by [`dacite`](https://github.com/konradhalas/dacite), it automatically catches dynamic setting updates while ensuring your configuration layer stays type-safe and isolated.
+
+## But Why?
+
+* **Fail-Fast Validation:** Catch bad configuration types or missing values instantly during server startup or container deployment rather than hitting silent runtime crashes mid-request.
+
+* **Full IDE Autocomplete:** Say goodbye to blind `getattr(settings, "MY_SETTING")` calls. Enjoy full hovering type definitions and autocompletion in VS Code, PyCharm, and MyPy.
+
+* **Dual Format Normalization:** Merges flat environment styles (`PREFIX_TIMEOUT = 30`) and structured dictionary blocks (`PREFIX = {"TIMEOUT": 30}`) into a single unified object seamlessly.
+
+* **Test-Safe Isolation:** Fully supports Django's test suite cycles. When settings are overridden dynamically in unit tests, your dataclasses mutate cleanly in-place and revert automatically.
+
+## Usage
+
+### 1. Define Your Configuration Dataclass
+
+Create a file named `config.py` (or any name you prefer tbh) within your application or package.
+Inherit from `BaseConfig` and define your variables.
+
+```python
+from dataclasses import dataclass, field
+from django_dataclassconf.config import BaseConfig, config_loader
+
+@dataclass
+class MyPackageConfig(BaseConfig):
+    DOCUMENTS_ROOT_PATH: str = '/the/default/path/'
+    MAX_FILE_SIZE: int = 10000
+    INDEXER_CLASS: str = 'myapp.utils.DocumentIndexer'
+
+    @property
+    def _prefix(self) -> str:
+        """
+        Define the config's prefix here, return blank string if it doesn't 
+        have a prefix such as when we write a configuration dataclass that 
+        will hold the `DEBUG` setting
+        """
+        return 'MY_PACKAGE'
+
+package_config = MyPackageConfig()
+```
+
+### 2. Subscribe to the Configuration Loader
+
+For your dataclass to grab configuration data from Django's `settings.py` on startup and capture updates during tests, subscribe your instance into `config_loader` inside your app's initialization hook:
+
+```python
+# my_app/apps.py
+class MyAppConfig(AppConfig):
+    name = 'my_app'
+    
+    def ready(self):
+        from django_dataclassconf.config import config_loader
+        from .config import package_config
+
+        config_loader.subscribe(package_config)
+```
+
+### 3. Access Your Settings Anywhere
+
+Core Practice would be to import your configuration instance directly instead of using the global `django.conf.settings` object to harness the full type safety and IDE autocomplete.
+
+```python
+# my_app/views.py
+from django.http import HttpResponse
+from my_app.config import package_config
+
+def my_view(request):
+    ...
+    # Your IDE now natively autocompletes these fields
+    if file_size > package_config.MAX_FILE_SIZE:
+        return HttpResponse(
+            {'detail': 'File size has exceeded the maximum size limit!'}, 
+            status = 400
+        )
+```
+
+## Extras
+
+Your Configuration Dataclass can also be a nested dataclasses, you only need to inherit `BaseConfig` to the root configuration dataclass.
+
+```python
+from dataclasses import dataclass, field
+from django_dataclassconf.config import BaseConfig, config_loader
+
+@dataclass
+class DocumentPreview:
+    preview_page_count: int = 10
+    strip_cover_page: bool = False
+
+@dataclass
+class MyPackageConfig(BaseConfig):
+    DOCUMENTS_ROOT_PATH: str = '/the/default/path/'
+    PREVIEW: DocumentPreview = field(default_factory=DocumentPreview)
+
+    @property
+    def _prefix(self) -> str:
+        return 'MY_PACKAGE'
+
+configuration = MyPackageConfig()
+config_loader.subscribe(configuration)
+```
+
+And it will look like this in `settings.py`
+
+```python
+MY_PACKAGE = {
+    'DOCUMENTS_ROOT_PATH': '/custom/path/',
+    'PREVIEW': {
+        'preview_page_count': 12,
+        'strip_cover_page': True
+    },
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

django_dataclassconf-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+django_dataclassconf/__init__.py,sha256=a4YqKSapptC8fQBnf9muBvnjyqiBj-YBI2VA3uERSgQ,149
+django_dataclassconf/conf.py,sha256=rrAMcUmu7NZCcZusM9G3ina0eMRTbkTC7la_6JdVkiE,3079
+django_dataclassconf-0.1.0.dist-info/licenses/LICENSE,sha256=3J2rBqh6X_suoDNzlioYNHzH04qbE-xgJsZEgFsYuds,1083
+django_dataclassconf-0.1.0.dist-info/METADATA,sha256=w9kUHCPaHkHONpw48IwFvpjR53XBGC69xQighflqSz0,5596
+django_dataclassconf-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+django_dataclassconf-0.1.0.dist-info/top_level.txt,sha256=NA-D720DXTcA4lzsLB2aC4359J-Xw3xPh5Zt1A-r1Ww,21
+django_dataclassconf-0.1.0.dist-info/RECORD,,

django_dataclassconf-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_dataclassconf-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Felix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

django_dataclassconf-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+django_dataclassconf