comprehensiveconfig 1.0.0__tar.gz

comprehensiveconfig-1.0.0/LICENSE.txt

@@ -0,0 +1,65 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+0. Additional Definitions.
+
+As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+
+    a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+    b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+
+    a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+    b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+
+    a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+    b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+    c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+    d) Do one of the following:
+        0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+        1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+    e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+
+    a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+    b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

comprehensiveconfig-1.0.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: comprehensiveconfig
+Version: 1.0.0
+Summary: A library to create ergonomic, auto-validated configuration models with great support for static type annotations.
+License: LGPL-3.0-only
+Project-URL: Homepage, https://summersweet.software
+Project-URL: Repository, https://github.com/summersweet-software/comprehensiveconfig
+Project-URL: Issues, https://github.com/summersweet-software/comprehensiveconfig/issues
+Keywords: config,configuration,validation,validator,ergonomic,models,model,pydantic-like,toml,toml-writer,json,json-writer,type-annotated,type-annotations
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+# Comprehensive Configuration
+A simple configuration library that lets you create a pydantic-like model for your configuration.
+
+# Features
+- [x] Supports static type checking
+- [x] toml writer
+- [x] json writer
+- [x] Number Fields
+- [x] Text Fields (with regex filtering)
+- [x] List fields
+- [x] Table fields
+- [x] TableSpec (Model) fields
+- [x] Sections
+- [x] Include doc comments in Section
+- [x] auto loading
+- [x] initialize default config (with auto loader)
+- [ ] yaml writer
+- [x] section list (via a Table field)
+- [x] Field type unions (overwriting normal union syntax)
+- [x] per attribute doc comments (inline and noninline)
+- [x] enum support (Via `spec.ConfigEnum` and python's `enum.Enum`)
+- [x] fully supported string escapes
+
+
+# Example (Python)
+
+```python
+# example.py
+from comprehensiveconfig import ConfigSpec
+from comprehensiveconfig.spec import Section, Integer, Float, Text, List
+from comprehensiveconfig.toml import TomlWriter
+
+class MyConfigSpec(ConfigSpec,
+                   default_file="myconfig.toml",
+                   writer=TomlWriter,
+                   create_file=True):
+    class MySection(Section, name="My_Section"):
+        some_field = Integer(10)
+        other_field = Text("Some Default Text")
+
+        class SubSection(Section):
+            '''An example Sub Section'''
+            x = Integer(10)
+
+    class Credentials(Section):
+        '''Example credentials section'''
+        email = Text("example@email.com", regex=r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$")
+        password = Text("MyPassword")
+
+    some_field = Float(6.9)
+    list_of_stuff = List(["12", "13", "14"], inner_type=Text())
+
+
+# Accessing values from globally loaded config (if one exists, otherwise it accesses the actual Field class)
+print(MyConfigSpec.some_field)
+print(MyConfigSpec.MySection.other_field)
+
+# Another way to open configuration
+second_config = MyConfigSpec.load("another_config.toml", TomlWriter)
+```
+
+# Example (toml output)
+
+```toml
+some_field = 6.9
+list_of_stuff = ["12", "13", "14"]
+
+[My_Section]
+some_field = 10
+other_field = "Some Default Text"
+
+[My_Section.SubSection]
+# An example Sub Section
+x = 10
+
+[Credentials]
+# Example credentials section
+email = "example@email.com"
+password = "MyPassword"
+```

comprehensiveconfig-1.0.0/comprehensiveconfig/__init__.py

@@ -0,0 +1,153 @@
+from abc import ABCMeta
+import os
+from typing import Any, Self, Type, Union
+
+from . import configio
+from . import spec
+from .json import JsonWriter
+from .toml import TomlWriter
+
+
+class _ConfigSpecMeta(type):
+    """handles getting of attributes"""
+
+    _WRITER: Type[configio.ConfigurationWriter] | None
+    _DEFAULT_FILE: str | None
+    _AUTO_LOAD: bool
+    _CREATE_FILE: bool
+    _INST: Union["ConfigSpec", None]
+
+    def __new__(
+        cls,
+        name,
+        bases,
+        attrs,
+        default_file: str | None = None,  # automatically load a specific file
+        writer=None,
+        create_file: bool = False,  # create the default file if not exists
+        auto_load: bool = True,
+        **kwargs,
+    ):
+        cls._DEFAULT_FILE = default_file
+        cls._WRITER = writer
+        cls._INST = None
+        cls._CREATE_FILE = create_file
+        cls._AUTO_LOAD = auto_load
+        return super().__new__(cls, name, bases, attrs)
+
+    def __get__(self, instance, owner):
+        if self._INST is None:
+            return self
+        return self._INST
+
+    def __getattribute__(self, name):
+        """get attributes from active instance if available"""
+        inst = object.__getattribute__(self, "_INST")
+        if inst is not None and name in inst._ALL_FIELDS.keys():
+            return inst.__getattribute__(name)
+
+        return super().__getattribute__(name)
+
+    def __setattribute__(self, name, value):
+        """set attributes from active instance if available"""
+        inst = object.__getattribute__(self, "_INST")
+        if inst is not None and name in inst._ALL_FIELDS.keys():
+            return inst.__setattribute__(name, value)
+
+        return super().__setattr__(name, value)
+
+
+class _ConfigSpecABCMeta(spec.ConfigurationFieldABCMeta, _ConfigSpecMeta):
+    """A combination of ABCMeta and config spec meta"""
+
+
+class ConfigSpec(spec.Section, metaclass=_ConfigSpecABCMeta):
+
+    @classmethod
+    def __init_subclass__(
+        cls,
+        **kwargs,
+    ):
+        super().__init_subclass__(**kwargs)
+        if not cls._AUTO_LOAD:
+            return
+
+        if cls._WRITER is None or cls._DEFAULT_FILE is None:
+            raise ValueError("config writer is not specified")
+
+        exists = os.path.exists(cls._DEFAULT_FILE)
+        if exists and not os.path.isfile(cls._DEFAULT_FILE):
+            raise Exception(f"configuration file: {cls._DEFAULT_FILE} is not a file")
+
+        if exists:
+            cls._INST = cls(cls._WRITER.load(cls._DEFAULT_FILE))
+        if not exists and cls._CREATE_FILE:
+            default = cls()
+            cls._WRITER.dump(cls._DEFAULT_FILE, default)
+            cls._INST = default
+        if not exists and not cls._CREATE_FILE:
+            raise FileNotFoundError(cls._DEFAULT_FILE)
+
+    def __init__(self, value: dict[str, Any] | None = None, /):
+        if value is None and not self._has_default:
+            raise Exception("Configuration does not have a full default value")
+
+        super().__init__(value or self._default_value)
+
+    @classmethod
+    def load(cls, file=None, writer=None, /) -> Self:
+        file = file or cls._DEFAULT_FILE
+        writer = writer or cls._WRITER
+
+        if writer is None:
+            raise ValueError("no writer specified")
+        if file is None:
+            raise Exception("No file specified")
+
+        return cls(writer.load(file))
+
+    def save(self, file=None, writer=None, /):
+        file = file or self._DEFAULT_FILE
+        writer = writer or self._WRITER
+
+        if writer is None:
+            raise ValueError("no writer specified")
+        if file is None:
+            raise Exception("No file specified")
+
+        writer.dump(file, self)
+
+    def reset(self):
+        """This does not work on auto loaded config"""
+        if not self._has_default:
+            raise Exception("Configuration does not have a full default value")
+        self._value = {
+            self._FIELD_NAME_MAP[name]: self._ALL_FIELDS[self._FIELD_NAME_MAP[name]](
+                val
+            )
+            for name, val in self._default_value.items()
+        }
+
+    @classmethod
+    def reset_global(cls):
+        """reset config on auto loaded config"""
+        if cls._INST is None:
+            return
+
+        if not cls._has_default:
+            raise Exception("Configuration does not have a full default value")
+        cls._INST._value = {
+            cls._FIELD_NAME_MAP[name]: cls._ALL_FIELDS[cls._FIELD_NAME_MAP[name]](val)
+            for name, val in cls._default_value.items()
+        }
+
+
+__all__ = [
+    "ConfigSpec",
+    "_ConfigSpecMeta",
+    "_ConfigSpecABCMeta",
+    "spec",
+    "configio",
+    "JsonWriter",
+    "TomlWriter",
+]

comprehensiveconfig-1.0.0/comprehensiveconfig/configio.py

@@ -0,0 +1,42 @@
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Any
+
+from . import spec
+
+
+class ConfigurationWriter(ABC):
+    """simple writer/reader base class that jus
+    expects a similar interface to python's builtin json module"""
+
+    @classmethod
+    @abstractmethod
+    def dumps(cls, node: spec.AnyConfigField) -> str:
+        """dump Configuration tree/node as a string"""
+        pass
+
+    @classmethod
+    @abstractmethod
+    def dump(cls, file, node: spec.AnyConfigField):
+        if isinstance(file, (str, Path)):
+            with open(file, "w") as f:
+                f.write(cls.dumps(node))
+            return
+
+        file.write(cls.dumps(node))
+
+    @classmethod
+    @abstractmethod
+    def loads(cls, file) -> dict[str, Any]:
+        """load a file by name"""
+        pass
+
+    @classmethod
+    @abstractmethod
+    def load(cls, file) -> dict[str, Any]:
+        """load a file by name"""
+        if isinstance(file, (str, Path)):
+            with open(file, "r") as f:
+                return cls.loads(f.read())
+
+        return cls.loads(file.read())

comprehensiveconfig-1.0.0/comprehensiveconfig/json.py

@@ -0,0 +1,50 @@
+import json
+from . import configio
+from . import spec
+
+
+class JsonWriter(configio.ConfigurationWriter):
+    @classmethod
+    def dump_section(cls, node: spec.Section):
+        return {
+            node._FIELD_VAR_MAP[name]: (
+                cls.dump_value(node.get_field(name), value)
+            )
+            for name, value in node._value.items()
+        }
+    
+    @classmethod
+    def dump_value(cls, node: spec.AnyConfigField, value):
+        match node:
+            case type() | spec.Section():
+                return cls.dump_section(value)
+            case spec.Table(_, type() | spec.Section() | spec.ConfigUnion()):
+                return {cls.dump_value(key, key): cls.dump_value(val, val) for key, val in value.items()}
+            case spec.ConfigEnum(_, True):
+                return value.name
+            case spec.ConfigEnum(_, False):
+                return value.value
+            case _:
+                return value
+
+    @classmethod
+    def dumps(cls, node) -> str:
+        match node:
+            case spec.Section():
+                return json.dumps(cls.dump_section(node), indent=4)
+            case _:
+                raise ValueError(node)
+
+    @classmethod
+    def dump(cls, file, node):
+        super().dump(file, node)
+
+    @classmethod
+    def load(cls, file):
+        if isinstance(file, str):
+            with open(file, "r") as f:
+                return json.load(f)
+        return json.load(file)
+
+    # just alias the name
+    loads = json.loads