rewire 0.1.0__tar.gz

rewire-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 rewirepy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rewire-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: rewire
+Version: 0.1.0
+Summary: A Streamlined Type-Based Dependency Injection Framework
+Author-email: Ivan Vozhakov <gou177@bk.ru>
+License: MIT License
+        
+        Copyright (c) 2024 rewirepy
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/rewirepy/example-fastapi
+Keywords: dependency injection,configuration managment
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: anyio>=4.0.0
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: loguru<=1.0.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: trio; extra == "dev"
+Requires-Dist: pytest-anyio; extra == "dev"
+Requires-Dist: graphviz; extra == "dev"
+
+
+# Rewire: A Streamlined Type-Based Dependency Injection Framework for Focused Development
+
+Rewire is a user-friendly framework dedicated to type-based dependency injection, allowing developers to focus on writing code rather than dealing with boilerplate.
+
+## Key Features and Benefits
+
+### Dependency Injection
+
+Employ Rewire's advanced type-based dependency injection system to automatically manage the instantiation, configuration, and resolution of components in your application. This lets you concentrate on
+developing functionality without being bogged down by dependency management.
+
+### Configuration Injection (YAML & Python Functions)
+
+Easily load configurations from a YAML file using Rewire's versatile configuration injection mechanism, which supports Python function extensions. Set up complex applications with ease and consistency
+while maintaining flexibility.
+
+### Automatic File Import
+
+Automatically import required files based on defined configurations within your Rewire-powered application. Keep your project organized by trusting Rewire to handle file imports, promoting code
+reusability and minimizing potential errors.
+
+### Lifecycle Manager
+
+Easily manage the lifecycles of components with Rewire's robust start/stop manager. Control the initialization and disposal of resources efficiently, ensuring optimal resource usage.
+
+### Extensibility & Hackability
+
+Rewire is designed to be both extensible and hackable, enabling developers to tailor the framework to their specific needs. Customize components, add new features, or integrate Rewire with other
+libraries as desired, making it a powerful choice for any project.

rewire-0.1.0/README.md

@@ -0,0 +1,30 @@
+
+# Rewire: A Streamlined Type-Based Dependency Injection Framework for Focused Development
+
+Rewire is a user-friendly framework dedicated to type-based dependency injection, allowing developers to focus on writing code rather than dealing with boilerplate.
+
+## Key Features and Benefits
+
+### Dependency Injection
+
+Employ Rewire's advanced type-based dependency injection system to automatically manage the instantiation, configuration, and resolution of components in your application. This lets you concentrate on
+developing functionality without being bogged down by dependency management.
+
+### Configuration Injection (YAML & Python Functions)
+
+Easily load configurations from a YAML file using Rewire's versatile configuration injection mechanism, which supports Python function extensions. Set up complex applications with ease and consistency
+while maintaining flexibility.
+
+### Automatic File Import
+
+Automatically import required files based on defined configurations within your Rewire-powered application. Keep your project organized by trusting Rewire to handle file imports, promoting code
+reusability and minimizing potential errors.
+
+### Lifecycle Manager
+
+Easily manage the lifecycles of components with Rewire's robust start/stop manager. Control the initialization and disposal of resources efficiently, ensuring optimal resource usage.
+
+### Extensibility & Hackability
+
+Rewire is designed to be both extensible and hackable, enabling developers to tailor the framework to their specific needs. Customize components, add new features, or integrate Rewire with other
+libraries as desired, making it a powerful choice for any project.

rewire-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rewire"
+version = "0.1.0"
+description = "A Streamlined Type-Based Dependency Injection Framework"
+readme = "README.md"
+authors = [{ name = "Ivan Vozhakov", email = "gou177@bk.ru" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+keywords = ["dependency injection", "configuration managment"]
+dependencies = [
+    "pydantic >= 2.0.0",
+    "anyio >= 4.0.0",
+    "PyYAML >= 6.0.1",
+    "loguru <= 1.0.0",
+]
+requires-python = ">=3.12"
+
+[project.optional-dependencies]
+dev = ["black", "pytest", "trio", "pytest-anyio", "graphviz"]
+
+[project.urls]
+Homepage = "https://github.com/rewirepy/example-fastapi"

rewire-0.1.0/rewire/__init__.py

@@ -0,0 +1 @@
+from . import context, dependencies, plugins, config, log, lifecycle

rewire-0.1.0/rewire/classproperty.py

@@ -0,0 +1,10 @@
+from typing import Callable
+
+
+class classproperty[T](property):
+    def __init__(self, cb: Callable[..., T]) -> None:
+        self.cb = cb
+        super().__init__()
+
+    def __get__(self, _, owner) -> T:
+        return self.cb.__func__(owner)  # type: ignore

rewire-0.1.0/rewire/config.py

@@ -0,0 +1,417 @@
+from contextvars import ContextVar
+from functools import lru_cache
+import json
+from os import getenv
+import os
+from pathlib import Path
+from typing import (
+    Annotated,
+    Any,
+    Callable,
+    ClassVar,
+    Dict,
+    Literal,
+    Optional,
+    Self,
+    Type,
+    cast,
+    overload,
+)
+from loguru import logger
+from pydantic import BaseModel, Field, TypeAdapter
+import yaml
+from rewire.classproperty import classproperty
+from rewire.context import use_context_value
+import inspect
+from rewire.dependencies import Dependency, TypeRef
+from rewire.space import Module
+
+from rewire.store import SimpleStore
+
+CONFIG_FILE = getenv("CONFIG_FILE", "./config.yaml")
+
+UNSET = object()
+
+
+cwdContext = ContextVar("rewire.config.cwdConfig", default="./")
+fileContext = ContextVar("rewire.config.fileContext", default=CONFIG_FILE)
+rootContext = ContextVar("rewire.config.rootContext")
+
+
+class ConfigLoader(yaml.SafeLoader):
+    pass
+
+
+class EnvRequired(Exception):
+    pass
+
+
+class PyCode(BaseModel):
+    code: str
+    cwd: str = Field(default_factory=cwdContext.get)
+    file: str = Field(default_factory=fileContext.get)
+
+    def execute(self):
+        return eval(
+            self.code,
+            {"this": rootContext.get(), "self": rootContext.get()},
+            self.functions(),
+        )
+
+    def functions(self):
+        return {"include": self.include, "getenv": getenv}
+
+    def include(self, file: str):
+        with (
+            use_context_value(cwdContext, self.cwd),
+            use_context_value(fileContext, self.file),
+        ):
+            return load_yaml(file)
+
+
+class PyExecCode(PyCode):
+    def execute(self):
+        container = SimpleStore[Callable]()
+
+        exec(
+            "def __pyexec():\n"
+            + "\n".join(f" {x}" for x in self.code.splitlines())
+            + "\n__container.set(__pyexec)",
+            {
+                "this": rootContext.get(),
+                "self": rootContext.get(),
+                "__container": container,
+            },
+            self.functions(),
+        )
+        fn = container.get()
+        assert fn
+        return fn()
+
+
+class EvalDict(dict):
+    __pydantic_validator__ = None
+
+    def __getitem__(self, __k):
+        if __k not in self:
+            raise AttributeError(__k)
+        value = super().__getitem__(__k)
+
+        if isinstance(value, PyCode):
+            return value.execute()
+
+        if isinstance(value, dict):
+            return type(self)(value)
+
+        return value
+
+    def __getattribute__(self, __name: str) -> Any:
+        try:
+            return super().__getattribute__(__name)
+        except AttributeError:
+            return self.__getitem__(__name)  # type: ignore
+
+
+def load_yaml_env(loader, node: yaml.ScalarNode):
+    value = getenv(*node.value.split(":", 1))
+    if value is None:
+        raise EnvRequired(f'env variable {node.value.split(":", 1)[0]!r} required')
+    return value
+
+
+def load_yaml_include(loader, node: yaml.ScalarNode):
+    return load_yaml(node.value)
+
+
+def load_yaml_py(load, node: yaml.ScalarNode):
+    return PyCode(code=node.value)
+
+
+def load_yaml_pyexec(load, node: yaml.ScalarNode):
+    return PyExecCode(code=node.value)
+
+
+def load_yaml_yaml(load, node: yaml.ScalarNode):
+    return prepare_yaml(yaml.load(node.value, ConfigLoader))
+
+
+ConfigLoader.add_constructor("!env", load_yaml_env)
+ConfigLoader.add_constructor("!include", load_yaml_include)
+ConfigLoader.add_constructor("!py", load_yaml_py)
+ConfigLoader.add_constructor("!pyexec", load_yaml_pyexec)
+ConfigLoader.add_constructor("!yaml", load_yaml_yaml)
+
+
+@overload
+def merge[K, T, KO, TO](
+    source: dict[K, T], overlay: dict[KO, TO]
+) -> dict[K | KO, T | TO]:
+    ...
+
+
+@overload
+def merge[T](source: Any, overlay: T) -> T:
+    ...
+
+
+def merge(source: dict | list | Any, overlay: dict | list | Any):
+    if isinstance(source, dict | list):
+        source = source.copy()
+    if isinstance(source, dict) and isinstance(overlay, dict):
+        for key, value in overlay.items():
+            source[key] = merge(source.get(key, None), value)
+        return source
+    return overlay
+
+
+def render_py(value, root=UNSET):
+    if root is UNSET:
+        root = value
+    if isinstance(value, dict):
+        new_value = {k: render_py(v, root=root) for k, v in value.items()}
+        value.update(new_value)
+        return EvalDict(value)
+    if isinstance(value, list):
+        new_value = [render_py(v, root=root) for v in value]
+        value.clear()
+        value.extend(new_value)
+        return value
+    if isinstance(value, PyCode):
+        return render_py(value.execute(), root=root)
+    return value
+
+
+def load_yaml(file_: str | Path):
+    cwd = cwdContext.get().removesuffix("/") + "/"
+    file_ = os.path.join(cwd, file_)
+    with (
+        open(file_) as f,
+        use_context_value(fileContext, file_),
+        use_context_value(cwdContext, os.path.dirname(file_)),
+    ):
+        value = yaml.load(f, ConfigLoader)
+        return prepare_yaml(value)
+
+
+def prepare_yaml(value):
+    with use_context_value(rootContext, None):
+        return EvalDict({"d": value}).d
+
+
+def set_by_key(key, value, data):
+    if key:
+        for k in key.split(".")[:-1]:
+            data = data.setdefault(k, {})
+        data[key.split(".")[-1]] = value
+    else:
+        data.update(value)
+
+
+def get_by_key(key, data):
+    if key is None:
+        return data
+    if "." in key:
+        key, next_key = key.split(".", 1)
+        return get_by_key(next_key, data.get(key, {}))
+    return data.get(key, {})
+
+
+def merge_env(data: Dict):  # /NOSONAR
+    remap_config = getenv("CONFIG_REWIRE_ENV_REMAP", {})
+    if isinstance(remap_config, str):
+        remap_config = json.loads(remap_config)
+        assert isinstance(remap_config, dict)
+
+    for key, value in os.environ.items():
+        remapped = key in remap_config
+        if remapped:
+            key = remap_config[key]
+
+        if not key.startswith("CONFIG_") and not remapped:
+            continue
+
+        if not remapped:
+            key = key.removeprefix("CONFIG_")
+            key = key.replace("_", ".").replace("..", "_")
+
+        if key.endswith("_.JSON") or remapped and key.endswith(":json"):
+            key = key.removesuffix("_.JSON").removesuffix(":json")
+            value = json.loads(value)
+        elif key.endswith("_.YAML") or remapped and key.endswith(":yaml"):
+            key = key.removesuffix("_.YAML").removesuffix(":yaml")
+            value = yaml.load(value, ConfigLoader)
+            value = prepare_yaml(value)
+
+        set_by_key(key, value, data)
+    return data
+
+
+@lru_cache()
+def parse_file(file: str | Path, silent: bool = False):
+    try:
+        raw_config = TypeAdapter(Dict[str, Any]).validate_python(load_yaml(file) or {})
+    except FileNotFoundError as e:
+        if not silent:
+            logger.error(e)
+        raw_config = {}
+
+    raw_config = merge_env(raw_config)
+
+    with use_context_value(rootContext, raw_config):
+        raw_config = EvalDict({"d": raw_config}).d
+
+    with use_context_value(rootContext, raw_config):
+        return render_py(raw_config)
+
+
+def extract_config_by_path(path: str, model: BaseModel):
+    config = model
+
+    for part in path.split("."):
+        config = getattr(config, part, {})
+
+    return config
+
+
+def gen_config_model[TBM: BaseModel](path: str, model: Type[TBM], name: str = "Config"):
+    Model = model  # /NOSONAR
+
+    field, _, next_ = path.partition(".")
+    if next_:
+        Model = gen_config_model(next_, model, f"{field.capitalize()}{name}")
+
+    store: SimpleStore[TBM] = SimpleStore()
+    no_required_args = True
+
+    for param in inspect.signature(Model).parameters.values():  # type: ignore
+        if param.default is inspect._empty:
+            no_required_args = False
+
+    exec(
+        f"field = Field(default_factory=Model) if noRequiredArgs else Field(...)\n"
+        f"class {name}(BaseModel):\n"
+        f"    {field}: Model = field\n"
+        f"store.set({name})\n",
+        {
+            "store": store,
+            "Model": Model,
+            "BaseModel": BaseModel,
+            "Field": Field,
+            "noRequiredArgs": no_required_args,
+        },
+    )
+
+    value = store.get()
+    if not value:
+        raise RuntimeError("evaluation failed")
+
+    return value
+
+
+class ConfigModule(Module):
+    config: dict = {}
+    config_file: str = CONFIG_FILE
+
+    def init(self):
+        self.config = cast(dict, parse_file(self.config_file))  # type: ignore
+
+    def patch(self, override: dict):
+        self.config = merge(self.config, override)
+
+
+class EnvironmentModule(Module):
+    env: Literal["production", "dev"] = "production"
+
+    def init(self):
+        config = ConfigModule.get(None)
+        if (
+            config is not None
+            and config.config.get("rewire", {}).get("env", getenv("ENV", None)) == "dev"
+        ):
+            self.env = "dev"
+
+    @classmethod
+    def current_env(cls):
+        self = EnvironmentModule.get(None)
+        return "dev" if self is None else self.env
+
+
+@overload
+def config[TBM: BaseModel](
+    model: Type[TBM], *, path: Optional[str] = ".", fallback: Any = None
+) -> TBM:
+    ...
+
+
+@overload
+def config[TBM: BaseModel](
+    *, path: Optional[str] = ".", fallback: Any = None
+) -> Callable[[Type[TBM]], TBM]:
+    ...
+
+
+def config(model: Any = UNSET, *, path: Optional[str] = ".", fallback: Any = None):
+    """fills base model from file fields"""
+
+    def wrapper[TBM: BaseModel](config: Type[TBM]) -> TBM:
+        config_path = update_path(config.__module__, path or ".")
+
+        data = gen_config_model(config_path, config)
+        try:
+            raw_config = ConfigModule.get().config
+
+            return cast(
+                config,
+                extract_config_by_path(config_path, data.model_validate(raw_config)),
+            )
+        except LookupError:
+            if fallback is None:
+                raise
+            return config.model_validate(fallback)
+
+    if model is not UNSET:
+        return wrapper(model)
+
+    return wrapper
+
+
+def update_path(config_path: str, post_path: str):
+    level = 0
+
+    while post_path.startswith("."):
+        level -= 1
+        post_path = post_path[1:]
+
+    if level == 0:
+        return post_path
+
+    for _ in range(1, -level):
+        config_path = ".".join(config_path.split(".")[:-1])
+
+    if post_path:
+        config_path = f"{config_path}.{post_path}".strip(".")
+    return config_path
+
+
+class ConfigDependency(BaseModel):
+    _dependency: ClassVar[Dependency[Self] | None] = None
+    __location__: ClassVar[str] = "."
+    __fallback__: ClassVar[dict | None] = None
+
+    @classproperty
+    @classmethod
+    def dependency(cls) -> Dependency[Self]:
+        if cls._dependency is None:
+
+            async def resolve():
+                return config(cls, path=cls.__location__, fallback=cls.__fallback__)
+
+            cls._dependency = Dependency(
+                cb=resolve, type=cls, label=f"Config ({cls.__module__}.{cls.__name__})"
+            )
+        return cls._dependency
+
+    @classproperty
+    @classmethod
+    def Value(cls) -> Type[Self]:
+        return Annotated[cls, TypeRef(type=cls)]

rewire-0.1.0/rewire/context.py

@@ -0,0 +1,79 @@
+from contextlib import contextmanager
+from contextvars import ContextVar
+from typing import Type, overload
+from uuid import uuid4
+from pydantic import BaseModel, PrivateAttr
+
+UNSET = object()
+
+
+class Context[T](BaseModel):
+    _ctx: ContextVar[T] | None = PrivateAttr(None)
+    name: str | None = None
+
+    @property
+    def ctx(self):
+        if self._ctx is not None:
+            return self._ctx
+        self._ctx = ContextVar(self.name or str(uuid4()))
+        return self._ctx
+
+    @contextmanager
+    def use(self: "ContextVar[T] | Context[T]", value: T):
+        if isinstance(self, Context):
+            self = self.ctx
+
+        token = self.set(value)
+        try:
+            yield value
+        finally:
+            self.reset(token)
+
+    @overload
+    def get[D](self, default: D) -> T | D:
+        ...
+
+    @overload
+    def get(self) -> T:
+        ...
+
+    def get(self, default=UNSET):
+        if default is UNSET:
+            return self.ctx.get()
+        return self.ctx.get(default)
+
+
+def use_context_value[T](self: ContextVar[T] | Context[T], value: T):
+    return Context.use(self, value)
+
+
+class BoundCtx[T](Context[T]):
+    _value: T = PrivateAttr()
+
+    def use(self, value: T | None = None):
+        return super().use(value or self._value)
+
+
+class CTX(property):
+    _context: Context | None = None
+
+    @overload
+    def __get__[T](self, __instance: None, __owner: Type[T]) -> Context[T]:
+        ...
+
+    @overload
+    def __get__[T](self, __instance: T, __owner: Type[T]) -> BoundCtx[T]:
+        ...
+
+    def __get__[T](
+        self, __instance: T | None, __owner: Type[T]
+    ) -> Context[T] | BoundCtx[T]:
+        if self._context is None:
+            self._context = Context()
+        if __instance is not None:
+            ctx = BoundCtx()
+            ctx._ctx = self._context.ctx
+            ctx._value = __instance
+            ctx.name = self._context.name
+            return ctx
+        return self._context