byoconfig 0.0.1__py3-none-any.whl

byo_config/__init__.py

@@ -0,0 +1,4 @@
+from byo_config.sources.file import FileVariableSource
+from .config import Config
+
+__all__ = ['FileVariableSource', 'Config']

byo_config/config.py

@@ -0,0 +1,112 @@
+import logging
+import inspect
+from typing import Optional, Type
+
+from byo_config.sources import (
+    BaseVariableSource,
+    FileVariableSource,
+    EnvVariableSource,
+    FileTypes,
+)
+from byo_config.error import BYOConfigError
+
+__all__ = ['Config']
+
+logger = logging.getLogger(__name__)
+
+
+class Config(FileVariableSource, EnvVariableSource):
+    """
+    A versatile config object that can parse many file types, load environment variables,
+    and load dictionary keys as class attributes.
+      - Multiple config objects from different unique sources can be collated easily with a precedence value.
+      - Config instances with higher precedence have their values overwrite the values of lower precedence
+        instances when merging objects.
+    """
+
+    def __init__(
+            self,
+            source_file_path: Optional[str] = None,
+            forced_file_type: Optional[FileTypes] = None,
+            env_prefix: Optional[str] = None,
+            var_source_name: Optional[str] = "Config",
+            precedence: Optional[int] = 1,
+            **kwargs
+    ):
+        """
+        Initialize a Config object.
+
+        Args:
+            source_file_path (str):
+                The path to the source file.
+
+            forced_file_type (FileTypes):
+                The file type of the source file, if you don't want to use the file's extension.
+
+            var_source_name (str):
+                The name of the variable source.
+
+            env_prefix (str):
+                The configuration keys will be loaded from the environment variables with this prefix.
+                Use the "*" wildcard if you want to load all environment variables as configuration keys.
+
+            precedence (int):
+                The precedence of the variable source.
+
+            **kwargs:
+                Arbitrary keyword arguments, to be loaded as class attributes.
+        """
+        try:
+            self.precedence = precedence
+            self.var_source_name = var_source_name
+            super().__init__(
+                source_file=source_file_path,
+                forced_file_type=forced_file_type
+            )
+            super().load_env(env_prefix)
+
+            self.set_data(kwargs)
+            logger.debug(f"Config object {self.var_source_name} created with precedence {self.precedence}")
+
+        except BYOConfigError as e:
+            raise e
+
+        except FileNotFoundError as e:
+            raise e
+
+        except ValueError as e:
+            raise e
+
+        except Exception as e:
+            raise e
+
+    def include(self, plugin_class: Type[BaseVariableSource], **kwargs):
+        """
+        Include a plugin class in the config object.
+
+        Args:
+            plugin_class (Type[BaseVariableSource]):
+                The plugin class to include in the config object.
+
+            **kwargs:
+                Arbitrary keyword arguments to pass to the plugin class.
+        """
+        try:
+            # get signature of plugin class
+            sig = inspect.signature(plugin_class)
+            # Compare kwargs to signature
+            for k, v in kwargs.items():
+                if k not in sig.parameters:
+                    raise BYOConfigError(
+                        f"Invalid parameter '{k}' for plugin class '{plugin_class.__name__}'",
+                        self
+                    )
+            plugin = plugin_class(**kwargs)  # type: ignore
+            self.set_data(plugin.get_data())
+            logger.debug(f"Initialized plugin '{plugin_class.__name__}' with data: {plugin.get_data()}")
+
+        except BYOConfigError as e:
+            raise e
+
+        except Exception as e:
+            raise e

byo_config/error.py

@@ -0,0 +1,19 @@
+
+__all__ = ['BYOConfigError']
+
+
+class BYOConfigError(ValueError):
+    """Subclass of ValueError with the following additional properties:
+    args:
+        msg:           The unformatted error message
+        instance_name: The name of which VariableSource instance raised the error
+    """
+    def __init__(self, msg, instance):
+        errmsg = f"{msg} in VariableSource instance '{instance.var_source_name}'"
+        super().__init__(self, errmsg)
+        self.msg = msg
+        self.instance = instance.var_source_name
+
+    def __reduce__(self):
+        return self.__class__, (self.msg, self.instance)
+

byoconfig-0.0.1.dist-info/METADATA

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: byoconfig
+Version: 0.0.1
+Summary: A configuration class that supports plugins, multiple file formats, heirarchical configuration, and more.
+Author-email: Cam Ratchford <camratchford@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: MacOS X
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: PyYAML ==6.0.2
+Requires-Dist: toml ==0.10.2
+Provides-Extra: development
+Requires-Dist: mkdocs ; extra == 'development'
+Requires-Dist: mkdocs-material ; extra == 'development'
+Requires-Dist: ruff ; extra == 'development'
+Requires-Dist: pytest ; extra == 'development'
+Requires-Dist: build ; extra == 'development'
+Requires-Dist: twine ; extra == 'development'
+

byoconfig-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+byo_config/__init__.py,sha256=fOEImax01vH8EZ92kMMerj5k_0UzKRyFM9oQ9CPwNQw,128
+byo_config/config.py,sha256=AB8U-E6jiGTUxVa52xeaitAdFI_x0c-b64mCLcGOFjA,3770
+byo_config/error.py,sha256=tgYMbn9E9yrj_f1r18J7ZqKcVS9sLgSUWYGzpklS4nk,627
+byoconfig-0.0.1.dist-info/METADATA,sha256=UurTDjhSsApYkHXxmeGaS0JiZFnEBXdM0YfnqPeAixs,1088
+byoconfig-0.0.1.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+byoconfig-0.0.1.dist-info/top_level.txt,sha256=qRw1-WIuppmhfRyphfkE3qtGuBHZH-6wbiLNwkUWXpg,11
+byoconfig-0.0.1.dist-info/RECORD,,

byoconfig-0.0.1.dist-info/WHEEL

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

byoconfig-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+byo_config