contextmodel 0.1.0__py3-none-any.whl

contextmodel/__init__.py

@@ -0,0 +1,147 @@
+from collections.abc import Callable, Generator
+from contextlib import contextmanager
+from contextvars import ContextVar, Token
+from functools import cache, partial
+from typing import ClassVar
+
+
+class Context[M: ContextModel, **P]:
+    """
+    Context. Call it to create a new object.
+
+    >>> from dataclasses import dataclass
+
+    >>> @dataclass
+    ... class Foo(ContextModel):
+    ...     x: int | None = None
+
+    >>> @context_create(Foo, x=1)
+    ... def f() -> None:
+    ...     print(context_get(Foo))
+    >>> f()
+    Foo(x=1)
+
+    >>> with Foo.model_context.create(x=2):
+    ...     print(Foo.model_current.x)
+    2
+
+    >>> @Foo.model_context.create(x=3)
+    ... def f() -> None:
+    ...     print(Foo.model_current.x)
+    >>> f()
+    3
+
+    """
+
+    def __init__(self, model_class: Callable[P, M], variable: ContextVar[M]) -> None:
+        self.model_class = model_class
+        self.variable = variable
+
+    def get(self) -> M:
+        return self.variable.get()
+
+    def set(self, model: M) -> Generator[Token[M]]:
+        token = self.variable.set(model)
+        try:
+            yield token
+        finally:
+            token.var.reset(token)
+
+    @contextmanager
+    def create(self, *args: P.args, **kwargs: P.kwargs) -> Generator[Token[M]]:
+        return self.set(self.model_class(*args, **kwargs))
+
+
+def context_get[M: ContextModel](model_class: type[M]) -> M:
+    """
+    Get the current context model instance.
+
+    >>> from dataclasses import dataclass, field
+
+    >>> @dataclass
+    ... class Foo(ContextModel):
+    ...     x: int = 1
+
+    >>> with Foo.model_context.create(x=2):
+    ...     print(context_get(Foo))
+    Foo(x=2)
+    """
+    return context_of(model_class).get()
+
+
+def future_context_get[M: ContextModel](model_class: type[M]) -> Callable[[], M]:
+    """
+    Return a callback to return a value from context. Useful as "factories".
+
+    >>> from dataclasses import dataclass, field
+
+    >>> @dataclass
+    ... class Foo(ContextModel):
+    ...     x: int = 1
+
+    >>> @dataclass
+    ... class MyData:
+    ...     foo: Foo = field(default_factory=future_context_get(Foo))
+
+    >>> MyData(foo=Foo())
+    MyData(foo=Foo(x=1))
+
+    >>> with Foo.model_context.create(x=2):
+    ...     print(MyData())
+    MyData(foo=Foo(x=2))
+
+    """
+    return partial(context_get, model_class)
+
+
+@cache
+def context_of[M: ContextModel, **P](
+    model_class: Callable[P, M],
+) -> Context[M, P]:
+    auto_name = getattr(model_class, "__name__", format(model_class))
+    return Context(model_class=model_class, variable=ContextVar[M](auto_name))
+
+
+@contextmanager
+def context_create[**P, M: Context](
+    model_class: Callable[P, M],
+    /,
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> Generator[M]:
+    context = context_of(model_class)
+    return context.set(context.model_class(*args, **kwargs))
+
+
+@contextmanager
+def context_set[**P, M: Context](
+    model_class: Callable[P, M],
+    /,
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> Generator[M]:
+    context = context_of(model_class)
+    return context.set(context.model_class(*args, **kwargs))
+
+
+class _ContextGetter:
+    def __get__[M: ContextModel, **P](
+        self,
+        instance: M | None,
+        owner: Callable[P, M],
+    ) -> Context[M, P]:
+        return context_of(owner or type(instance))
+
+
+class _ModelGetter:
+    def __get__[M: ContextModel, **P](
+        self,
+        instance: M | None,
+        owner: Callable[P, M],
+    ) -> M:
+        return context_get(owner if instance is None else instance)  # type: ignore[invalid-argument-type]
+
+
+class ContextModel:
+    model_context: ClassVar[_ContextGetter] = _ContextGetter()
+    model_current: ClassVar[_ModelGetter] = _ModelGetter()

contextmodel-0.1.0.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: contextmodel
+Version: 0.1.0
+Summary: A nice interface to context variables
+License-File: LICENSE
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# contextmodel
+Alternative interface to context variables for practical scenarios.
+
+```pycon
+>>> from contextmodel import ContextModel, context_create, context_get
+>>> from dataclasses import dataclass
+
+>>> @dataclass
+... class Foo(ContextModel):
+...     x: int | None = None
+
+>>> @context_create(Foo, x=1)
+... def f() -> None:
+...     print(context_get(Foo))
+>>> f()
+Foo(x=1)
+
+>>> with Foo.model_context.create(x=2):
+...     print(Foo.model_current.x)
+2
+
+>>> @Foo.model_context.create(x=3)
+... def f() -> None:
+...     print(Foo.model_current.x)
+>>> f()
+3
+
+
+```
+
+Works with type hints:
+
+<img width="821" height="454" alt="image" src="https://github.com/user-attachments/assets/6c4f5b4b-48b5-4807-a6aa-bf9cd6b8e3e4" />

contextmodel-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+contextmodel/__init__.py,sha256=frW0xGdXry1O3B2sT-II9yh_ZAPUTKh_tbFpkJqKNLE,3679
+contextmodel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+contextmodel-0.1.0.dist-info/METADATA,sha256=W4x_m6qETawpngRKWkYi7zINIF3x5JtCma7XzUaGHpU,909
+contextmodel-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+contextmodel-0.1.0.dist-info/licenses/LICENSE,sha256=9iNQ2_-JNctKZJ2HyRpDx6JOHpRKSE_nGmZUEaCcbKE,1074
+contextmodel-0.1.0.dist-info/RECORD,,

contextmodel-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

contextmodel-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bartosz Sławecki
+
+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.