python-simpleconf 0.8.2__tar.gz → 0.9.0__tar.gz

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-simpleconf
-Version: 0.8.2
+Version: 0.9.0
 Summary: Simple configuration management with python.
 License: MIT
 License-File: LICENSE
@@ -19,11 +19,16 @@ Provides-Extra: all
 Provides-Extra: async
 Provides-Extra: env
 Provides-Extra: ini
+Provides-Extra: jinja2
+Provides-Extra: liquid
+Provides-Extra: liquidpy
 Provides-Extra: toml
 Provides-Extra: yaml
 Requires-Dist: aiofiles (>=23.0.0) ; extra == "async"
 Requires-Dist: diot (>=0.3.2,<0.4.0)
 Requires-Dist: iniconfig (>=2.0,<3.0) ; extra == "ini" or extra == "all"
+Requires-Dist: jinja2 (>=3.0,<4.0) ; extra == "jinja2"
+Requires-Dist: liquidpy (>=0.8,<0.9) ; extra == "liquid" or extra == "liquidpy"
 Requires-Dist: panpath (>=0.4.8,<0.5.0)
 Requires-Dist: python-dotenv (>=1.1,<2.0) ; extra == "env" or extra == "all"
 Requires-Dist: pyyaml (>=6,<7) ; extra == "yaml" or extra == "all"
@@ -64,6 +69,7 @@ pip install python-simpleconf[all]
 - Profile support
 - Simple APIs
 - Async loading support
+- Templated configuration files support (jinja2 and liquid)
 
 ## Usage
 
@@ -311,3 +317,37 @@ Values are casted by `ast.literal_eval()`.
 
 `@toml:a = 1` -> `{"a": 1}`
 
+### Templated configuration files
+
+`jinja2` and `liquid` templating engines are supported. The templating engine is determined by the file extension, which can be either the primary or secondary suffix. For example, `config.toml.j2` and `config.j2.toml` are both treated as TOML files with Jinja2 templating.
+
+`config.toml.j2`
+
+```toml
+a = {{ 1 + 2 }}
+```
+
+```python
+from simpleconf import Config
+
+conf = Config.load('config.toml.j2')
+# conf.a == 3
+```
+
+`config.liq.toml`
+
+```toml
+{% for i in range(1, 3) %}
+[section{{i}}]
+a = {{i}}
+{% endfor %}
+```
+
+```python
+from simpleconf import Config
+
+conf = Config.load('config.liq.toml')
+# conf.section1.a == 1
+# conf.section2.a == 2
+```
+

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/README.md

@@ -29,6 +29,7 @@ pip install python-simpleconf[all]
 - Profile support
 - Simple APIs
 - Async loading support
+- Templated configuration files support (jinja2 and liquid)
 
 ## Usage
 
@@ -275,3 +276,37 @@ Values are casted by `ast.literal_eval()`.
 #### TOML caster
 
 `@toml:a = 1` -> `{"a": 1}`
+
+### Templated configuration files
+
+`jinja2` and `liquid` templating engines are supported. The templating engine is determined by the file extension, which can be either the primary or secondary suffix. For example, `config.toml.j2` and `config.j2.toml` are both treated as TOML files with Jinja2 templating.
+
+`config.toml.j2`
+
+```toml
+a = {{ 1 + 2 }}
+```
+
+```python
+from simpleconf import Config
+
+conf = Config.load('config.toml.j2')
+# conf.a == 3
+```
+
+`config.liq.toml`
+
+```toml
+{% for i in range(1, 3) %}
+[section{{i}}]
+a = {{i}}
+{% endfor %}
+```
+
+```python
+from simpleconf import Config
+
+conf = Config.load('config.liq.toml')
+# conf.section1.a == 1
+# conf.section2.a == 2
+```

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-simpleconf"
-version = "0.8.2"
+version = "0.9.0"
 description = "Simple configuration management with python."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"
@@ -26,6 +26,8 @@ rtoml = {version = "^0.12", optional = true, platform = "linux"}
 tomli = {version = "^2.0", optional = true, markers = 'sys_platform != "linux"'}
 iniconfig = {version = "^2.0", optional = true}
 aiofiles = {version = ">=23.0.0", optional = true}
+jinja2 = {version = "^3.0", optional = true}
+liquidpy = {version = "^0.8", optional = true}
 
 [tool.poetry.extras]
 ini = [ "iniconfig" ]
@@ -33,6 +35,9 @@ env = [ "python-dotenv"]
 yaml = [ "pyyaml"]
 toml = [ "rtoml", "tomli"]
 async = [ "aiofiles"]
+jinja2 = [ "jinja2"]
+liquid = [ "liquidpy"]
+liquidpy = [ "liquidpy"]
 all = [ "iniconfig", "python-dotenv", "pyyaml", "rtoml", "tomli"]
 
 [tool.poetry.group.dev.dependencies]

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/__init__.py

@@ -1,3 +1,3 @@
 from .config import Config, ProfileConfig
 
-__version__ = "0.8.2"
+__version__ = "0.9.0"

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/__init__.py

@@ -132,3 +132,29 @@ class NoConvertingPathMixin(ABC):
     async def a_loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Asynchronously load the configuration from a toml file"""
         return self.loading(conf, ignore_nonexist)  # type: ignore[attr-defined]
+
+
+class LoaderModifierMixin(ABC):
+    """Loader mixin class with content modifier"""
+
+    def _modifier(self, content: str | bytes) -> str | bytes:
+        """Modify the content of the configuration file before loading"""
+        return content
+
+
+class J2ModifierMixin(LoaderModifierMixin):
+    """Loader mixin class with Jinja2 content modifier"""
+
+    def _modifier(self, content: str | bytes) -> str | bytes:
+        """Modify the content of the configuration file before loading"""
+        from jinja2 import Template
+        return Template(content).render()
+
+
+class LiqModifierMixin(LoaderModifierMixin):
+    """Loader mixin class with Liquid content modifier"""
+
+    def _modifier(self, content: str | bytes) -> str | bytes:
+        """Modify the content of the configuration file before loading"""
+        from liquid import Liquid
+        return Liquid(content, from_file=False, mode="wild").render()

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/env.py

@@ -16,12 +16,18 @@ from ..caster import (
     json_caster,
     toml_caster,
 )
-from . import Loader, NoConvertingPathMixin
+from . import (
+    Loader,
+    NoConvertingPathMixin,
+    LoaderModifierMixin,
+    J2ModifierMixin,
+    LiqModifierMixin,
+)
 
 dotenv = require_package("dotenv")
 
 
-class EnvLoader(Loader):
+class EnvLoader(Loader, LoaderModifierMixin):
     """Env file loader"""
 
     CASTERS = [
@@ -46,6 +52,7 @@ class EnvLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = conf.read_text()  # so that cloud paths work
+        content = self._modifier(content)
         return dotenv.dotenv_values(stream=io.StringIO(content))
 
     async def a_loading(self, conf, ignore_nonexist):
@@ -56,6 +63,7 @@ class EnvLoader(Loader):
                 content = await content
             if isinstance(content, bytes):
                 content = content.decode()
+            content = self._modifier(content)
             return dotenv.dotenv_values(stream=io.StringIO(content))
 
         if not await self._a_exists(conf, ignore_nonexist):
@@ -63,6 +71,7 @@ class EnvLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = await conf.a_read_text()  # so that cloud paths work
+        content = self._modifier(content)
         return dotenv.dotenv_values(stream=io.StringIO(content))
 
     @classmethod
@@ -89,3 +98,11 @@ class EnvsLoader(NoConvertingPathMixin, EnvLoader):  # type: ignore[misc]
     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))
+
+
+class EnvJ2Loader(EnvLoader, J2ModifierMixin):
+    """Env file loader with Jinja2 support"""
+
+
+class EnvLiqLoader(EnvLoader, LiqModifierMixin):
+    """Env file loader with Liquid support"""

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/ini.py

@@ -17,12 +17,18 @@ from ..caster import (
     json_caster,
     toml_caster,
 )
-from . import Loader, NoConvertingPathMixin
+from . import (
+    Loader,
+    NoConvertingPathMixin,
+    LoaderModifierMixin,
+    J2ModifierMixin,
+    LiqModifierMixin,
+)
 
 iniconfig = require_package("iniconfig")
 
 
-class IniLoader(Loader):
+class IniLoader(Loader, LoaderModifierMixin):
     """Ini-like file loader"""
 
     CASTERS = [
@@ -47,7 +53,7 @@ class IniLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = conf.read_text()
-
+        content = self._modifier(content)
         return iniconfig.IniConfig(conf, content).sections
 
     async def a_loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
@@ -58,6 +64,7 @@ class IniLoader(Loader):
                 content = await content
             if isinstance(content, bytes):
                 content = content.decode()
+            content = self._modifier(content)
             return iniconfig.IniConfig("<config>", content).sections
 
         if not await self._a_exists(conf, ignore_nonexist):
@@ -65,7 +72,7 @@ class IniLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = await conf.a_read_text()
-
+        content = self._modifier(content)
         return iniconfig.IniConfig(conf, content).sections
 
     @classmethod
@@ -112,3 +119,11 @@ class InisLoader(NoConvertingPathMixin, IniLoader):  # type: ignore[misc]
     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
+
+
+class IniJ2Loader(IniLoader, J2ModifierMixin):
+    """Ini-like file loader with Jinja2 support"""
+
+
+class IniLiqLoader(IniLoader, LiqModifierMixin):
+    """Ini-like file loader with Liquid support"""

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/json.py

@@ -1,10 +1,16 @@
 import json
 from typing import Any, Awaitable, Dict
 
-from . import Loader, NoConvertingPathMixin
+from . import (
+    Loader,
+    NoConvertingPathMixin,
+    LoaderModifierMixin,
+    J2ModifierMixin,
+    LiqModifierMixin,
+)
 
 
-class JsonLoader(Loader):
+class JsonLoader(Loader, LoaderModifierMixin):
     """Json file loader"""
 
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
@@ -18,6 +24,7 @@ class JsonLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = conf.read_text()
+        content = self._modifier(content)
         return json.loads(content)
 
     async def a_loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
@@ -28,6 +35,7 @@ class JsonLoader(Loader):
                 content = await content
             if isinstance(content, bytes):
                 content = content.decode()
+            content = self._modifier(content)
             return json.loads(content)
 
         if not await self._a_exists(conf, ignore_nonexist):
@@ -35,6 +43,7 @@ class JsonLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = await conf.a_read_text()
+        content = self._modifier(content)
         return json.loads(content)
 
 
@@ -44,3 +53,11 @@ class JsonsLoader(NoConvertingPathMixin, JsonLoader):  # type: ignore[misc]
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Load the configuration from a json file"""
         return json.loads(conf)
+
+
+class JsonJ2Loader(JsonLoader, J2ModifierMixin):
+    """Json file loader with Jinja2 support"""
+
+
+class JsonLiqLoader(JsonLoader, LiqModifierMixin):
+    """Json file loader with Liquid support"""

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/toml.py

@@ -5,12 +5,18 @@ from ..caster import (
     none_caster,
     null_caster,
 )
-from . import Loader, NoConvertingPathMixin
+from . import (
+    Loader,
+    NoConvertingPathMixin,
+    LoaderModifierMixin,
+    J2ModifierMixin,
+    LiqModifierMixin,
+)
 
 toml = require_package("rtoml", "tomllib", "tomli")
 
 
-class TomlLoader(Loader):
+class TomlLoader(Loader, LoaderModifierMixin):
     """Toml file loader"""
 
     CASTERS = [
@@ -22,6 +28,7 @@ class TomlLoader(Loader):
         """Load the configuration from a toml file"""
         if hasattr(conf, "read"):
             content = conf.read()
+            content = self._modifier(content)
             return toml.loads(content)
 
         if not self._exists(conf, ignore_nonexist):
@@ -30,9 +37,10 @@ class TomlLoader(Loader):
         conf = self.__class__._convert_path(conf)
         content = conf.read_bytes()
         try:
-            return toml.loads(content)
-        except TypeError:
+            return toml.loads(self._modifier(content))
+        except Exception:  # TypeError, TomlParsingError
             content = content.decode()
+            content = self._modifier(content)
             return toml.loads(content)
 
     async def a_loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
@@ -43,6 +51,7 @@ class TomlLoader(Loader):
                 content = await content
             if isinstance(content, bytes):
                 content = content.decode()
+            content = self._modifier(content)
             return toml.loads(content)
 
         if not await self._a_exists(conf, ignore_nonexist):
@@ -50,6 +59,7 @@ class TomlLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = await conf.a_read_bytes()
+        content = self._modifier(content)
         try:
             return toml.loads(content)
         except TypeError:
@@ -63,3 +73,11 @@ class TomlsLoader(NoConvertingPathMixin, TomlLoader):  # type: ignore[misc]
     def loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
         """Load the configuration from a toml file"""
         return toml.loads(conf)
+
+
+class TomlJ2Loader(TomlLoader, J2ModifierMixin):
+    """Toml file loader with Jinja2 support"""
+
+
+class TomlLiqLoader(TomlLoader, LiqModifierMixin):
+    """Toml file loader with Liquid support"""

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/loaders/yaml.py

@@ -1,18 +1,25 @@
 from typing import Any, Dict, Awaitable
 
-from . import Loader, NoConvertingPathMixin
+from . import (
+    Loader,
+    NoConvertingPathMixin,
+    LoaderModifierMixin,
+    J2ModifierMixin,
+    LiqModifierMixin,
+)
 from ..utils import require_package
 
 yaml = require_package("yaml")
 
 
-class YamlLoader(Loader):
+class YamlLoader(Loader, LoaderModifierMixin):
     """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()
+            content = self._modifier(content)
             return yaml.load(content, Loader=yaml.FullLoader)
 
         if not self._exists(conf, ignore_nonexist):
@@ -20,6 +27,7 @@ class YamlLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = conf.read_text()
+        content = self._modifier(content)
         return yaml.load(content, Loader=yaml.FullLoader)
 
     async def a_loading(self, conf: Any, ignore_nonexist: bool) -> Dict[str, Any]:
@@ -30,6 +38,7 @@ class YamlLoader(Loader):
                 content = await content
             if isinstance(content, bytes):
                 content = content.decode()
+            content = self._modifier(content)
             return yaml.load(content, Loader=yaml.FullLoader)
 
         if not await self._a_exists(conf, ignore_nonexist):
@@ -37,6 +46,7 @@ class YamlLoader(Loader):
 
         conf = self.__class__._convert_path(conf)
         content = await conf.a_read_text()
+        content = self._modifier(content)
         return yaml.load(content, Loader=yaml.FullLoader)
 
 
@@ -46,3 +56,11 @@ class YamlsLoader(NoConvertingPathMixin, YamlLoader):  # type: ignore[misc]
     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)
+
+
+class YamlJ2Loader(YamlLoader, J2ModifierMixin):
+    """Yaml file loader with Jinja2 support"""
+
+
+class YamlLiqLoader(YamlLoader, LiqModifierMixin):
+    """Yaml file loader with Liquid support"""

{python_simpleconf-0.8.2 → python_simpleconf-0.9.0}/simpleconf/utils.py

@@ -12,13 +12,28 @@ POOL_KEY = "_SIMPLECONF_POOL"
 META_KEY = "_SIMPLECONF_META"
 
 
-def config_to_ext(conf: Any) -> str:
+def config_to_ext(conf: Any, secondary: bool = True) -> str:
     """Find the extension(flag) of the configuration"""
     if isinstance(conf, dict):
         return "dict"
 
     conf = Path(conf)
     out = conf.suffix.lstrip(".").lower()
+    if out in ('j2', 'jinja2', 'jinja'):
+        # x.toml.j2
+        return config_to_ext(conf.stem) + '.j2'
+    if out in ('liq', 'liquid'):
+        # x.toml.liq
+        return config_to_ext(conf.stem) + '.liq'
+
+    if secondary:
+        secondary_suffix = conf.with_suffix("").suffix.lstrip(".").lower()
+        # x.j2.toml
+        if secondary_suffix in ('j2', 'jinja2', 'jinja'):
+            return config_to_ext(conf, secondary=False) + '.j2'
+        if secondary_suffix in ('liq', 'liquid'):
+            return config_to_ext(conf, secondary=False) + '.liq'
+
     if not out and conf.name.lower().endswith("rc"):
         out = "rc"
 
@@ -48,6 +63,14 @@ def get_loader(ext: str | Loader) -> Loader:
         from .loaders.env import EnvLoader
         return EnvLoader()
 
+    if ext == "env.j2":
+        from .loaders.env import EnvJ2Loader
+        return EnvJ2Loader()
+
+    if ext == "env.liq":
+        from .loaders.env import EnvLiqLoader
+        return EnvLiqLoader()
+
     if ext == "envs":
         from .loaders.env import EnvsLoader
         return EnvsLoader()
@@ -56,6 +79,14 @@ def get_loader(ext: str | Loader) -> Loader:
         from .loaders.ini import IniLoader
         return IniLoader()
 
+    if ext == "ini.j2":
+        from .loaders.ini import IniJ2Loader
+        return IniJ2Loader()
+
+    if ext == "ini.liq":
+        from .loaders.ini import IniLiqLoader
+        return IniLiqLoader()
+
     if ext == "inis":
         from .loaders.ini import InisLoader
         return InisLoader()
@@ -64,6 +95,14 @@ def get_loader(ext: str | Loader) -> Loader:
         from .loaders.json import JsonLoader
         return JsonLoader()
 
+    if ext == "json.j2":
+        from .loaders.json import JsonJ2Loader
+        return JsonJ2Loader()
+
+    if ext == "json.liq":
+        from .loaders.json import JsonLiqLoader
+        return JsonLiqLoader()
+
     if ext == "jsons":
         from .loaders.json import JsonsLoader
         return JsonsLoader()
@@ -76,6 +115,14 @@ def get_loader(ext: str | Loader) -> Loader:
         from .loaders.toml import TomlLoader
         return TomlLoader()
 
+    if ext == "toml.j2":
+        from .loaders.toml import TomlJ2Loader
+        return TomlJ2Loader()
+
+    if ext == "toml.liq":
+        from .loaders.toml import TomlLiqLoader
+        return TomlLiqLoader()
+
     if ext == "tomls":
         from .loaders.toml import TomlsLoader
         return TomlsLoader()
@@ -84,6 +131,14 @@ def get_loader(ext: str | Loader) -> Loader:
         from .loaders.yaml import YamlLoader
         return YamlLoader()
 
+    if ext == "yaml.j2":
+        from .loaders.yaml import YamlJ2Loader
+        return YamlJ2Loader()
+
+    if ext == "yaml.liq":
+        from .loaders.yaml import YamlLiqLoader
+        return YamlLiqLoader()
+
     if ext == "yamls":
         from .loaders.yaml import YamlsLoader
         return YamlsLoader()