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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-simpleconf
-Version: 0.6.1
+Version: 0.7.0
 Summary: Simple configuration management with python.
 License: MIT
 Author: pwwang
@@ -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.1 → python_simpleconf-0.7.0}/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.1 → python_simpleconf-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-simpleconf"
-version = "0.6.1"
+version = "0.7.0"
 description = "Simple configuration management with python."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"

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

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

{python_simpleconf-0.6.1 → python_simpleconf-0.7.0}/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.1 → python_simpleconf-0.7.0}/simpleconf/config.py

@@ -1,38 +1,51 @@
 from __future__ import annotations
 
 from contextlib import contextmanager
-from typing import TYPE_CHECKING, Any, List, Generator
+from typing import Any, List, Generator, Union, Sequence
 
 from diot import Diot
 
 from .utils import config_to_ext, get_loader, POOL_KEY, META_KEY
+from .loaders import Loader
 
-if TYPE_CHECKING:
-    from .loaders import Loader
+LoaderType = Union[str, Loader, None]
 
 
 class Config:
     """The configuration class"""
 
     @staticmethod
-    def load(*configs, ignore_nonexist: bool = False) -> Diot:
+    def load(
+        *configs: Any,
+        loader: LoaderType | Sequence[LoaderType] = None,
+        ignore_nonexist: bool = False,
+    ) -> Diot:
         """Load the configuration from the files, or other configurations
 
         Args:
             *configs: The configuration files or other configurations to load
                 Latter ones will override the former ones for items with the
                 same keys recursively.
+            loader: The loader to use. If a list is given, it must have the
+                same length as configs.
             ignore_nonexist: Whether to ignore non-existent files
                 Otherwise, will raise errors
 
         Returns:
             A Diot object with the loaded configurations
         """
+        if not isinstance(loader, Sequence) or isinstance(loader, str):
+            loader = [loader] * len(configs)
+
+        if len(loader) != len(configs):
+            raise ValueError(
+                f"Length of loader ({len(loader)}) does not match "
+                f"length of configs ({len(configs)})"
+            )
+
         out = Diot()
-        for conf in configs:
-            ext = config_to_ext(conf)
-            loader = get_loader(ext)
-            loaded = loader.load(conf, ignore_nonexist)
+        for i, conf in enumerate(configs):
+            loaded = Config.load_one(conf, loader[i], ignore_nonexist)
             out.update_recursively(loaded)
 
         return out
@@ -55,6 +68,9 @@ class Config:
             A Diot object with the loaded configuration
         """
         if loader is None:
+            if hasattr(config, "read"):
+                raise ValueError("'loader' must be specified for stream")
+
             ext = config_to_ext(config)
             loader = get_loader(ext)
         else:
@@ -67,26 +83,50 @@ class ProfileConfig:
     """The configuration class with profile support"""
 
     @staticmethod
-    def load(*configs: Any, ignore_nonexist: bool = False) -> Diot:
+    def load(
+        *configs: Any,
+        loader: LoaderType | Sequence[LoaderType] = None,
+        ignore_nonexist: bool = False,
+    ) -> Diot:
         """Load the configuration from the files, or other configurations
 
         Args:
             *configs: The configuration files or other configurations to load
                 Latter ones will override the former ones for items with the
                 same profile and keys recursively.
+            loader: The loader to use. If a list is given, it must have the
+                same length as configs.
             ignore_nonexist: Whether to ignore non-existent files
                 Otherwise, will raise errors
         """
+        if not isinstance(loader, Sequence) or isinstance(loader, str):
+            loader = [loader] * len(configs)
+
+        if len(loader) != len(configs):
+            raise ValueError(
+                f"Length of loader ({len(loader)}) does not match "
+                f"length of configs ({len(configs)})"
+            )
+
         out = Diot({POOL_KEY: Diot()})
         pool = out[POOL_KEY]
         out[META_KEY] = {
             "current_profile": None,
             "base_profile": None,
         }
-        for conf in configs:
-            ext = config_to_ext(conf)
-            loader = get_loader(ext)
-            loaded = loader.load_with_profiles(conf, ignore_nonexist)
+        for i, conf in enumerate(configs):
+            lder = loader[i]
+
+            if lder is None and hasattr(conf, "read"):
+                raise ValueError("'loader' must be specified for stream")
+
+            if lder is None:
+                ext = config_to_ext(conf)
+                lder = get_loader(ext)
+            else:
+                lder = get_loader(lder)
+
+            loaded = lder.load_with_profiles(conf, ignore_nonexist)
             for profile, value in loaded.items():
                 profile = profile.lower()
                 pool.setdefault(profile, Diot())
@@ -121,6 +161,9 @@ class ProfileConfig:
         }
 
         if loader is None:
+            if hasattr(conf, "read"):
+                raise ValueError("'loader' must be specified for stream")
+
             ext = config_to_ext(conf)
             loader = get_loader(ext)
         else:

{python_simpleconf-0.6.1 → python_simpleconf-0.7.0}/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.0/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.1 → python_simpleconf-0.7.0}/simpleconf/loaders/env.py

@@ -1,9 +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,
@@ -34,11 +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 dotenv.dotenv_values(stream=io.StringIO(content))
+
         if not self._exists(conf, ignore_nonexist):
-            return Diot()
-        return Diot(dotenv.main.DotEnv(conf).dict())
+            return {}
+
+        return dotenv.main.DotEnv(conf).dict()
 
     def load_with_profiles(  # type: ignore[override]
         self,
@@ -59,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.1 → python_simpleconf-0.7.0}/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,26 +36,38 @@ 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
 
     def load(self, conf: Any, ignore_nonexist: bool = False) -> Diot:
         """Load and cast the configuration from an ini-like file"""
         sections = self.loading(conf, ignore_nonexist)
         keys = list(sections)
+
+        if hasattr(conf, "read"):
+            pathname = "<config>"
+        else:
+            pathname = Path(conf).name
+
         # only load the default section
         if len(keys) > 1:
             warnings.warn(
-                f"{Path(conf).name}: More than one section found, "
-                "only the default section will be loaded."
+                f"{pathname}: More than one section found, "
+                "only the default section will be loaded. "
+                "Use ProfileConfig.load() if you want to sections as profiles."
             )
 
         if len(keys) == 0 or keys[0].lower() != "default":
             raise ValueError(
-                f"{Path(conf).name}: Only the default section can be loaded."
+                f"{pathname}: Only the default section can be loaded."
             )
 
         return cast(Diot(sections[keys[0]]), self.__class__.CASTERS)
@@ -71,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.0/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.1 → python_simpleconf-0.7.0}/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.7.0/simpleconf/loaders/toml.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict
+
+from ..utils import require_package
+from ..caster import (
+    none_caster,
+    null_caster,
+)
+from . import Loader
+
+toml = require_package("rtoml", "tomllib", "tomli")
+
+
+class TomlLoader(Loader):
+    """Toml file loader"""
+
+    CASTERS = [
+        none_caster,
+        null_caster,
+    ]
+
+    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 toml.loads(content)
+
+        if not self._exists(conf, ignore_nonexist):
+            return {}
+
+        if toml.__name__ in ("tomli", "tomllib"):  # pragma: no cover
+            with open(conf, "rb") as f:
+                return toml.load(f)
+
+        with open(conf, "r") as f:  # rtoml
+            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.0/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.1 → python_simpleconf-0.7.0}/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.1/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.1/simpleconf/loaders/json.py

@@ -1,17 +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 not self._exists(conf, ignore_nonexist):
-            return Diot()
-        with open(conf) as f:
-            return Diot(json.load(f))

python_simpleconf-0.6.1/simpleconf/loaders/toml.py

@@ -1,32 +0,0 @@
-from typing import Any
-from simpleconf.utils import require_package
-from diot import Diot
-
-from ..caster import (
-    none_caster,
-    null_caster,
-)
-from . import Loader
-
-toml = require_package("rtoml", "tomllib", "tomli")
-
-
-class TomlLoader(Loader):
-    """Toml file loader"""
-
-    CASTERS = [
-        none_caster,
-        null_caster,
-    ]
-
-    def loading(self, conf: Any, ignore_nonexist: bool) -> Diot:
-        """Load the configuration from a toml file"""
-        if not self._exists(conf, ignore_nonexist):
-            return Diot()
-
-        if toml.__name__ in ("tomli", "tomllib"):  # pragma: no cover
-            with open(conf, "rb") as f:
-                return Diot(toml.load(f))
-
-        with open(conf, "r") as f:  # rtoml
-            return Diot(toml.load(f))

python_simpleconf-0.6.1/simpleconf/loaders/yaml.py

@@ -1,19 +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 not self._exists(conf, ignore_nonexist):
-            return Diot()
-
-        with open(conf) as f:
-            return Diot(yaml.load(f, Loader=yaml.FullLoader))