python-simpleconf 0.6.2__tar.gz → 0.7.1__tar.gz

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-simpleconf
-Version: 0.6.2
+Version: 0.7.1
 Summary: Simple configuration management with python.
 License: MIT
 Author: pwwang
@@ -18,9 +18,9 @@ Provides-Extra: env
 Provides-Extra: ini
 Provides-Extra: toml
 Provides-Extra: yaml
-Requires-Dist: diot (>=0.3.1,<0.4.0)
+Requires-Dist: diot (>=0.3.2,<0.4.0)
 Requires-Dist: iniconfig (>=2.0,<3.0) ; extra == "ini" or extra == "all"
-Requires-Dist: python-dotenv (>=1.0,<2.0) ; extra == "env" or extra == "all"
+Requires-Dist: python-dotenv (>=1.1,<2.0) ; extra == "env" or extra == "all"
 Requires-Dist: pyyaml (>=6,<7) ; extra == "yaml" or extra == "all"
 Requires-Dist: rtoml (>=0.12,<0.13) ; (sys_platform == "linux") and (extra == "toml" or extra == "all")
 Requires-Dist: tomli (>=2.0,<3.0) ; (sys_platform != "linux") and (extra == "toml" or extra == "all")
@@ -99,6 +99,8 @@ conf = Config.load({'a': 1, 'b': {'c': 2}})
 - `XXX.osenv`: System environment variables with prefix `XXX_` (case-sensitive) is used.
   - `XXX_A=1` will be loaded as `conf.A = 1`.
 - python dictionary.
+- Strings format of the above formats are also supported.
+  - `"{'a': 1}"` will be loaded as `conf.a = 1`.
 
 ### Profile support
 

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/README.md

@@ -69,6 +69,8 @@ conf = Config.load({'a': 1, 'b': {'c': 2}})
 - `XXX.osenv`: System environment variables with prefix `XXX_` (case-sensitive) is used.
   - `XXX_A=1` will be loaded as `conf.A = 1`.
 - python dictionary.
+- Strings format of the above formats are also supported.
+  - `"{'a': 1}"` will be loaded as `conf.a = 1`.
 
 ### Profile support
 

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = [ "poetry>=0.12",]
+requires = [ "poetry>=2",]
 build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-simpleconf"
-version = "0.6.2"
+version = "0.7.1"
 description = "Simple configuration management with python."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"
@@ -17,8 +17,8 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.9"
-diot = "^0.3.1"
-python-dotenv = { version="^1.0", optional = true}
+diot = "^0.3.2"
+python-dotenv = { version="^1.1", optional = true}
 pyyaml = { version="^6", optional = true}
 # Use rtoml only when the wheel is available (linux)
 rtoml = {version = "^0.12", optional = true, platform = "linux"}
@@ -32,7 +32,7 @@ yaml = [ "pyyaml"]
 toml = [ "rtoml", "tomli"]
 all = [ "iniconfig", "python-dotenv", "pyyaml", "rtoml", "tomli"]
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^8"
 pytest-cov = "^6"
 

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/__init__.py

@@ -1,3 +1,3 @@
 from .config import Config, ProfileConfig
 
-__version__ = "0.6.2"
+__version__ = "0.7.1"

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/caster.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
 import json
-from typing import Any, Callable, Sequence, TYPE_CHECKING
+from typing import Any, Callable, Dict, Sequence, TypeVar
 from ast import literal_eval
 
 
-if TYPE_CHECKING:
-    from diot import Diot
+T = TypeVar("T", bound=Dict[str, Any])
 
 
 def type_caster(prefix: str, cast_fun: Callable) -> Any:
@@ -77,7 +76,7 @@ def cast_value(value: Any, casters: Sequence[Callable]) -> Any:
     return value
 
 
-def cast(conf: Diot, casters: Sequence[Callable]) -> Diot:
+def cast(conf: T, casters: Sequence[Callable]) -> T:
     """Cast the configuration"""
     for key, value in conf.items():
         if isinstance(value, dict):

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/config.py

@@ -87,6 +87,8 @@ class ProfileConfig:
         *configs: Any,
         loader: LoaderType | Sequence[LoaderType] = None,
         ignore_nonexist: bool = False,
+        base: str = "default",
+        allow_missing_base: bool = False,
     ) -> Diot:
         """Load the configuration from the files, or other configurations
 
@@ -98,6 +100,10 @@ class ProfileConfig:
                 same length as configs.
             ignore_nonexist: Whether to ignore non-existent files
                 Otherwise, will raise errors
+            base: The default profile to use after loading
+            allow_missing_base: Whether to allow missing base profile
+                If False, will raise errors when the base profile is not found
+                in the loaded profiles.
         """
         if not isinstance(loader, Sequence) or isinstance(loader, str):
             loader = [loader] * len(configs)
@@ -132,7 +138,12 @@ class ProfileConfig:
                 pool.setdefault(profile, Diot())
                 pool[profile].update_recursively(value)
 
-        ProfileConfig.use_profile(out, "default")
+        if base and base not in pool and not allow_missing_base:
+            raise ValueError(f"Base profile '{base}' not found")
+
+        if base and base in pool:
+            ProfileConfig.use_profile(out, base, base=base)
+
         return out
 
     @staticmethod
@@ -140,6 +151,8 @@ class ProfileConfig:
         conf: Any,
         loader: str | Loader | None = None,
         ignore_nonexist: bool = False,
+        base: str = "default",
+        allow_missing_base: bool = False,
     ) -> Diot:
         """Load the configuration from the file
 
@@ -148,6 +161,7 @@ class ProfileConfig:
             loader: The loader to use. Will detect from conf by default
             ignore_nonexist: Whether to ignore non-existent files
                 Otherwise, will raise errors
+            base: The default profile to use after loading
 
         Returns:
             A Diot object with the loaded configuration
@@ -175,7 +189,12 @@ class ProfileConfig:
             pool.setdefault(profile, Diot())
             pool[profile].update_recursively(value)
 
-        ProfileConfig.use_profile(out, "default")
+        if base and base not in pool and not allow_missing_base:
+            raise ValueError(f"Base profile '{base}' not found")
+
+        if base and base in pool:
+            ProfileConfig.use_profile(out, base, base=base)
+
         return out
 
     @staticmethod
@@ -184,24 +203,35 @@ class ProfileConfig:
         profile: str,
         base: str = "default",
         copy: bool = False,
+        allow_missing_base: bool = False,
     ) -> Diot:
         """Switch the configuration to the given profile, based on the
-        default profile.
+        base profile.
 
         Args:
             conf: The configuration object by the `load` function
             profile: The profile to use
-            default: The default profile
+            base: The base profile.
+                If it does not exist, no base profile will be used.
+            copy: Whether to return a new configuration object
+                If False, the given configuration object will be updated
+                in-place.
+            allow_missing_base: Whether to allow missing base profile
+                If False, will raise errors when the base profile is not found
+                in the loaded profiles.
 
         Returns:
             The configuration object with the switched profile if copy is True
             Otherwise None (updated in-place)
         """
         pool = conf[POOL_KEY]
+        if base and base not in pool and not allow_missing_base:
+            raise ValueError(f"Base profile '{base}' not found")
+
         if copy:
             out = Diot({POOL_KEY: pool, META_KEY: conf[META_KEY].copy()})
-            if base is not None:
-                out.update_recursively(pool[base])
+            if base is not None and base != profile:
+                out.update_recursively(pool.get(base, {}))
             out[META_KEY]["current_profile"] = profile
             out[META_KEY]["base_profile"] = base
             out.update_recursively(pool[profile])
@@ -213,8 +243,8 @@ class ProfileConfig:
                 continue
             del conf[key]
 
-        if base is not None:
-            conf.update_recursively(pool[base])
+        if base is not None and base != profile:
+            conf.update_recursively(pool.get(base, {}))
         conf.update_recursively(pool[profile])
         conf[META_KEY]["current_profile"] = profile
         conf[META_KEY]["base_profile"] = base

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/loaders/__init__.py

@@ -3,20 +3,18 @@ from __future__ import annotations
 from abc import ABC, abstractmethod
 from os import PathLike
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, List
+from typing import Any, Callable, List, Dict
 
+from diot import Diot
 from ..caster import cast
 
-if TYPE_CHECKING:
-    from diot import Diot
-
 
 class Loader(ABC):
 
     CASTERS: List[Callable[[str, bool], Any]] | None = None
 
     @abstractmethod
-    def loading(self, conf: Any, ignore_nonexist: bool) -> "Diot":
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Load the configuration from the path or configurations"""
 
     def _exists(self, conf: PathLike, ignore_exist: bool) -> bool:
@@ -26,7 +24,7 @@ class Loader(ABC):
             raise FileNotFoundError(f"{conf} does not exist")
         return path.exists()
 
-    def load(self, conf: Any, ignore_nonexist: bool = False) -> "Diot":
+    def load(self, conf: Any, ignore_nonexist: bool = False) -> Diot:
         """Load the configuration from the path or configurations and cast
         values
 
@@ -38,7 +36,8 @@ class Loader(ABC):
         """
         loaded = self.loading(conf, ignore_nonexist)
         if self.__class__.CASTERS:
-            return cast(loaded, self.__class__.CASTERS)
-        return loaded
+            loaded = cast(loaded, self.__class__.CASTERS)
+
+        return Diot(loaded)
 
     load_with_profiles = load

python_simpleconf-0.7.1/simpleconf/loaders/dict.py

@@ -0,0 +1,19 @@
+from typing import Any, Dict
+
+from . import Loader
+
+
+class DictLoader(Loader):
+    """Dict loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a dict"""
+        return conf
+
+
+class DictsLoader(DictLoader):
+    """Dict string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a dict"""
+        return eval(conf)

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/loaders/env.py

@@ -1,10 +1,10 @@
 import warnings
 import io
 from pathlib import Path
-from typing import Any
-from simpleconf.utils import require_package
+from typing import Any, Dict
 from diot import Diot
 
+from ..utils import require_package
 from ..caster import (
     cast,
     int_caster,
@@ -35,16 +35,16 @@ class EnvLoader(Loader):
         toml_caster,
     ]
 
-    def loading(self, conf: Any, ignore_nonexist: bool = False) -> Diot:
+    def loading(self, conf: Any, ignore_nonexist: bool = False) -> Dict[str, Any]:
         """Load the configuration from a .env file"""
         if hasattr(conf, "read"):
             content = conf.read()
-            return Diot(dotenv.dotenv_values(stream=io.StringIO(content)))
+            return dotenv.dotenv_values(stream=io.StringIO(content))
 
         if not self._exists(conf, ignore_nonexist):
-            return Diot()
+            return {}
 
-        return Diot(dotenv.main.DotEnv(conf).dict())
+        return dotenv.main.DotEnv(conf).dict()
 
     def load_with_profiles(  # type: ignore[override]
         self,
@@ -65,3 +65,11 @@ class EnvLoader(Loader):
             out.setdefault(profile, Diot())[key] = v
 
         return cast(out, self.__class__.CASTERS)
+
+
+class EnvsLoader(EnvLoader):
+    """Env string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool = False) -> Dict[str, Any]:
+        """Load the configuration from a .env file"""
+        return dotenv.dotenv_values(stream=io.StringIO(conf))

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/loaders/ini.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
 import warnings
-from typing import Any
+from typing import Any, Dict
 from pathlib import Path
-from simpleconf.utils import require_package
 from diot import Diot
 
+from ..utils import require_package
 from ..caster import (
     cast,
     int_caster,
@@ -36,14 +36,14 @@ class IniLoader(Loader):
         toml_caster,
     ]
 
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Load the configuration from an ini-like file"""
         if hasattr(conf, "read"):
             content = conf.read()
             return iniconfig.IniConfig("<config>", content).sections
 
         if not self._exists(conf, ignore_nonexist):
-            return Diot(default={})
+            return {"default": {}}
 
         return iniconfig.IniConfig(conf).sections
 
@@ -83,3 +83,11 @@ class IniLoader(Loader):
         for k, v in sections.items():
             out[k.lower()] = cast(v, self.__class__.CASTERS)
         return out
+
+
+class InisLoader(IniLoader):
+    """Ini-like string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from an ini-like file"""
+        return iniconfig.IniConfig("<config>", conf).sections

python_simpleconf-0.7.1/simpleconf/loaders/json.py

@@ -0,0 +1,28 @@
+import json
+from typing import Any, Dict
+
+from . import Loader
+
+
+class JsonLoader(Loader):
+    """Json file loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a json file"""
+        if hasattr(conf, "read"):
+            content = conf.read()
+            return json.loads(content)
+
+        if not self._exists(conf, ignore_nonexist):
+            return {}
+
+        with open(conf) as f:
+            return json.load(f)
+
+
+class JsonsLoader(JsonLoader):
+    """Json string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a json file"""
+        return json.loads(conf)

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/loaders/osenv.py

@@ -1,5 +1,5 @@
 from os import environ
-from typing import Any
+from typing import Any, Dict
 import warnings
 
 from diot import Diot
@@ -32,11 +32,11 @@ class OsenvLoader(Loader):
         toml_caster,
     ]
 
-    def loading(self, conf: Any, ignore_nonexist: bool = False) -> Diot:
+    def loading(self, conf: Any, ignore_nonexist: bool = False) -> Dict[str, Any]:
         """Load the configuration from environment variables"""
         prefix = f"{conf[:-6]}_" if len(conf) > 6 else ""
         len_prefix = len(prefix)
-        out = Diot()
+        out = {}
         for k, v in environ.items():
             if k.startswith(prefix):
                 out[k[len_prefix:]] = v

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/loaders/toml.py

@@ -1,7 +1,6 @@
-from typing import Any
-from simpleconf.utils import require_package
-from diot import Diot
+from typing import Any, Dict
 
+from ..utils import require_package
 from ..caster import (
     none_caster,
     null_caster,
@@ -19,18 +18,26 @@ class TomlLoader(Loader):
         null_caster,
     ]
 
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Load the configuration from a toml file"""
         if hasattr(conf, "read"):
             content = conf.read()
-            return Diot(toml.loads(content))
+            return toml.loads(content)
 
         if not self._exists(conf, ignore_nonexist):
-            return Diot()
+            return {}
 
         if toml.__name__ in ("tomli", "tomllib"):  # pragma: no cover
             with open(conf, "rb") as f:
-                return Diot(toml.load(f))
+                return toml.load(f)
 
         with open(conf, "r") as f:  # rtoml
-            return Diot(toml.load(f))
+            return toml.load(f)
+
+
+class TomlsLoader(TomlLoader):
+    """Toml string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a toml file"""
+        return toml.loads(conf)

python_simpleconf-0.7.1/simpleconf/loaders/yaml.py

@@ -0,0 +1,30 @@
+from typing import Any, Dict
+
+from . import Loader
+from ..utils import require_package
+
+yaml = require_package("yaml")
+
+
+class YamlLoader(Loader):
+    """Yaml file loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a yaml file"""
+        if hasattr(conf, "read"):
+            content = conf.read()
+            return yaml.load(content, Loader=yaml.FullLoader)
+
+        if not self._exists(conf, ignore_nonexist):
+            return {}
+
+        with open(conf) as f:
+            return yaml.load(f, Loader=yaml.FullLoader)
+
+
+class YamlsLoader(YamlLoader):
+    """Yaml string loader"""
+
+    def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
+        """Load the configuration from a yaml file"""
+        return yaml.load(conf, Loader=yaml.FullLoader)

{python_simpleconf-0.6.2 → python_simpleconf-0.7.1}/simpleconf/utils.py

@@ -38,33 +38,56 @@ def get_loader(ext: str | Loader) -> Loader:
 
     if ext == "dict":
         from .loaders.dict import DictLoader
-
         return DictLoader()
+
+    if ext == "dicts":
+        from .loaders.dict import DictsLoader
+        return DictsLoader()
+
     if ext == "env":
         from .loaders.env import EnvLoader
-
         return EnvLoader()
+
+    if ext == "envs":
+        from .loaders.env import EnvsLoader
+        return EnvsLoader()
+
     if ext == "ini":
         from .loaders.ini import IniLoader
-
         return IniLoader()
+
+    if ext == "inis":
+        from .loaders.ini import InisLoader
+        return InisLoader()
+
     if ext == "json":
         from .loaders.json import JsonLoader
-
         return JsonLoader()
+
+    if ext == "jsons":
+        from .loaders.json import JsonsLoader
+        return JsonsLoader()
+
     if ext == "osenv":
         from .loaders.osenv import OsenvLoader
-
         return OsenvLoader()
+
     if ext == "toml":
         from .loaders.toml import TomlLoader
-
         return TomlLoader()
+
+    if ext == "tomls":
+        from .loaders.toml import TomlsLoader
+        return TomlsLoader()
+
     if ext == "yaml":
         from .loaders.yaml import YamlLoader
-
         return YamlLoader()
 
+    if ext == "yamls":
+        from .loaders.yaml import YamlsLoader
+        return YamlsLoader()
+
     raise FormatNotSupported(f"{ext} is not supported.")
 
 

python_simpleconf-0.6.2/simpleconf/loaders/dict.py

@@ -1,12 +0,0 @@
-from typing import Any
-from diot import Diot
-
-from . import Loader
-
-
-class DictLoader(Loader):
-    """Dict loader"""
-
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
-        """Load the configuration from a dict"""
-        return Diot(conf)

python_simpleconf-0.6.2/simpleconf/loaders/json.py

@@ -1,21 +0,0 @@
-import json
-from typing import Any
-
-from diot import Diot
-
-from . import Loader
-
-
-class JsonLoader(Loader):
-    """Json file loader"""
-
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
-        """Load the configuration from a json file"""
-        if hasattr(conf, "read"):
-            content = conf.read()
-            return Diot(json.loads(content))
-
-        if not self._exists(conf, ignore_nonexist):
-            return Diot()
-        with open(conf) as f:
-            return Diot(json.load(f))

python_simpleconf-0.6.2/simpleconf/loaders/yaml.py

@@ -1,23 +0,0 @@
-from typing import Any
-from simpleconf.utils import require_package
-from diot import Diot
-
-from . import Loader
-
-yaml = require_package("yaml")
-
-
-class YamlLoader(Loader):
-    """Yaml file loader"""
-
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
-        """Load the configuration from a yaml file"""
-        if hasattr(conf, "read"):
-            content = conf.read()
-            return Diot(yaml.load(content, Loader=yaml.FullLoader))
-
-        if not self._exists(conf, ignore_nonexist):
-            return Diot()
-
-        with open(conf) as f:
-            return Diot(yaml.load(f, Loader=yaml.FullLoader))