python-simpleconf 0.7.0__tar.gz → 0.7.2__tar.gz

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-simpleconf
-Version: 0.7.0
+Version: 0.7.2
 Summary: Simple configuration management with python.
 License: MIT
 Author: pwwang
@@ -14,16 +14,18 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: all
+Provides-Extra: cloud
 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")
+Requires-Dist: yunpath (>=0.0.4,<0.0.5) ; extra == "cloud"
 Project-URL: Homepage, https://github.com/pwwang/simpleconf
 Project-URL: Repository, https://github.com/pwwang/simpleconf
 Description-Content-Type: text/markdown

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/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.7.0"
+version = "0.7.2"
 description = "Simple configuration management with python."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"
@@ -17,13 +17,14 @@ 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"}
 tomli = {version = "^2.0", optional = true, markers = 'sys_platform != "linux"'}
 iniconfig = {version = "^2.0", optional = true}
+yunpath = {version = "^0.0.4", optional = true}
 
 [tool.poetry.extras]
 ini = [ "iniconfig" ]
@@ -31,8 +32,9 @@ env = [ "python-dotenv"]
 yaml = [ "pyyaml"]
 toml = [ "rtoml", "tomli"]
 all = [ "iniconfig", "python-dotenv", "pyyaml", "rtoml", "tomli"]
+cloud = [ "yunpath"]
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^8"
 pytest-cov = "^6"
 

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/__init__.py

@@ -1,3 +1,3 @@
 from .config import Config, ProfileConfig
 
-__version__ = "0.7.0"
+__version__ = "0.7.2"

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/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:
+            out = 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:
+            out = 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.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/__init__.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from os import PathLike
-from pathlib import Path
 from typing import Any, Callable, List, Dict
+from pathlib import Path
 
 from diot import Diot
 from ..caster import cast
@@ -13,13 +12,25 @@ class Loader(ABC):
 
     CASTERS: List[Callable[[str, bool], Any]] | None = None
 
+    @staticmethod
+    def _convert_path(conf: str | Path) -> Path:
+        """Convert the conf to Path if it is a string"""
+        try:
+            from yunpath import AnyPath
+        except ImportError:
+            AnyPath = Path
+
+        if isinstance(conf, str):
+            return AnyPath(conf)
+        return conf
+
     @abstractmethod
     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:
+    def _exists(self, conf: str | Path, ignore_exist: bool) -> bool:
         """Check if the configuration file exists"""
-        path = Path(conf)
+        path = self.__class__._convert_path(conf)
         if not ignore_exist and not path.exists():
             raise FileNotFoundError(f"{conf} does not exist")
         return path.exists()
@@ -34,10 +45,19 @@ class Loader(ABC):
         Returns:
             The Diot object
         """
-        loaded = self.loading(conf, ignore_nonexist)
+        path = self.__class__._convert_path(conf)
+        loaded = self.loading(path, ignore_nonexist)
         if self.__class__.CASTERS:
             loaded = cast(loaded, self.__class__.CASTERS)
 
         return Diot(loaded)
 
     load_with_profiles = load
+
+
+class NoConvertingPathMixin(ABC):
+    """String loader base class"""
+
+    @staticmethod
+    def _convert_path(conf: str) -> str:
+        return conf

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/dict.py

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

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/env.py

@@ -16,7 +16,7 @@ from ..caster import (
     json_caster,
     toml_caster,
 )
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 
 dotenv = require_package("dotenv")
 
@@ -67,7 +67,7 @@ class EnvLoader(Loader):
         return cast(out, self.__class__.CASTERS)
 
 
-class EnvsLoader(EnvLoader):
+class EnvsLoader(NoConvertingPathMixin, EnvLoader):
     """Env string loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool = False) -> Dict[str, Any]:

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/ini.py

@@ -17,7 +17,7 @@ from ..caster import (
     json_caster,
     toml_caster,
 )
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 
 iniconfig = require_package("iniconfig")
 
@@ -85,7 +85,7 @@ class IniLoader(Loader):
         return out
 
 
-class InisLoader(IniLoader):
+class InisLoader(NoConvertingPathMixin, IniLoader):
     """Ini-like string loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/json.py

@@ -1,7 +1,7 @@
 import json
 from typing import Any, Dict
 
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 
 
 class JsonLoader(Loader):
@@ -20,7 +20,7 @@ class JsonLoader(Loader):
             return json.load(f)
 
 
-class JsonsLoader(JsonLoader):
+class JsonsLoader(NoConvertingPathMixin, JsonLoader):
     """Json string loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/osenv.py

@@ -4,7 +4,7 @@ import warnings
 
 from diot import Diot
 
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 from ..caster import (
     cast,
     int_caster,
@@ -18,7 +18,7 @@ from ..caster import (
 )
 
 
-class OsenvLoader(Loader):
+class OsenvLoader(NoConvertingPathMixin, Loader):
     """Environment variable loader"""
 
     CASTERS = [

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/toml.py

@@ -5,7 +5,7 @@ from ..caster import (
     none_caster,
     null_caster,
 )
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 
 toml = require_package("rtoml", "tomllib", "tomli")
 
@@ -35,7 +35,7 @@ class TomlLoader(Loader):
             return toml.load(f)
 
 
-class TomlsLoader(TomlLoader):
+class TomlsLoader(NoConvertingPathMixin, TomlLoader):
     """Toml string loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:

{python_simpleconf-0.7.0 → python_simpleconf-0.7.2}/simpleconf/loaders/yaml.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict
 
-from . import Loader
+from . import Loader, NoConvertingPathMixin
 from ..utils import require_package
 
 yaml = require_package("yaml")
@@ -22,7 +22,7 @@ class YamlLoader(Loader):
             return yaml.load(f, Loader=yaml.FullLoader)
 
 
-class YamlsLoader(YamlLoader):
+class YamlsLoader(NoConvertingPathMixin, YamlLoader):
     """Yaml string loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]: