engin 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

engin/__init__.py

@@ -1,3 +1,4 @@
+from engin import ext
 from engin._assembler import Assembler
 from engin._block import Block, invoke, provide
 from engin._dependency import Entrypoint, Invoke, Provide, Supply
@@ -16,6 +17,7 @@ __all__ = [
     "Option",
     "Provide",
     "Supply",
+    "ext",
     "invoke",
     "provide",
 ]

engin/_assembler.py

@@ -4,7 +4,7 @@ from collections import defaultdict
 from collections.abc import Collection, Iterable
 from dataclasses import dataclass
 from inspect import BoundArguments, Signature
-from typing import Any, Generic, TypeVar
+from typing import Any, Generic, TypeVar, cast
 
 from engin._dependency import Dependency, Provide, Supply
 from engin._exceptions import AssemblyError
@@ -113,7 +113,7 @@ class Assembler:
     async def get(self, type_: type[T]) -> T:
         type_id = type_id_of(type_)
         if type_id in self._dependencies:
-            return self._dependencies[type_id]
+            return cast(T, self._dependencies[type_id])
         if type_id.multi:
             out = []
             for provider in self._multiproviders[type_id]:

engin/_block.py

@@ -1,5 +1,6 @@
 import inspect
 from collections.abc import Iterable, Iterator
+from typing import ClassVar
 
 from engin._dependency import Func, Invoke, Provide
 
@@ -15,11 +16,10 @@ def invoke(func: Func) -> Func:
 
 
 class Block(Iterable[Provide | Invoke]):
-    _name: str
-    _options: list[Provide | Invoke]
+    options: ClassVar[list[Provide | Invoke]] = []
 
     def __init__(self, /, block_name: str | None = None) -> None:
-        self._options: list[Provide | Invoke] = []
+        self._options: list[Provide | Invoke] = self.options[:]
         self._name = block_name or f"{type(self).__name__}"
         for _, method in inspect.getmembers(self):
             if opt := getattr(method, "_opt", None):

engin/_dependency.py

@@ -25,7 +25,7 @@ Func: TypeAlias = (
 _SELF = object()
 
 
-def _noop(*args, **kwargs) -> None: ...
+def _noop(*args: Any, **kwargs: Any) -> None: ...
 
 
 class Dependency(ABC, Generic[P, T]):

engin/_engin.py

@@ -32,15 +32,13 @@ class Engin:
     def assembler(self) -> Assembler:
         return self._assembler
 
-    async def run(self):
+    async def run(self) -> None:
         await self.start()
 
-        # lifecycle startup
-
         # wait till stop signal recieved
         await self._stop_event.wait()
 
-        # lifecycle shutdown
+        await self.stop()
 
     async def start(self) -> None:
         LOG.info("starting engin")
@@ -57,8 +55,10 @@ class Engin:
 
     async def stop(self) -> None:
         self._stop_event.set()
+        lifecycle = await self._assembler.get(Lifecycle)
+        await lifecycle.shutdown()
 
-    def _destruct_options(self, options: Iterable[Option]):
+    def _destruct_options(self, options: Iterable[Option]) -> None:
         for opt in options:
             if isinstance(opt, Block):
                 self._destruct_options(opt)

engin/_lifecycle.py

@@ -4,12 +4,12 @@ from contextlib import AbstractAsyncContextManager, AsyncExitStack
 
 class Lifecycle:
     def __init__(self) -> None:
-        self._on_startup: list[Callable] = []
-        self._on_shutdown: list[Callable] = []
+        self._on_startup: list[Callable[..., None]] = []
+        self._on_shutdown: list[Callable[..., None]] = []
         self._context_managers: list[AbstractAsyncContextManager] = []
         self._stack: AsyncExitStack = AsyncExitStack()
 
-    def register_context(self, cm: AbstractAsyncContextManager):
+    def register_context(self, cm: AbstractAsyncContextManager) -> None:
         self._context_managers.append(cm)
 
     async def startup(self) -> None:

engin/ext/asgi.py

@@ -1,16 +1,16 @@
 import traceback
-import typing
-from typing import ClassVar, Protocol, TypeAlias
+from collections.abc import Awaitable, Callable, MutableMapping
+from typing import Any, ClassVar, Protocol, TypeAlias
 
 from engin import Engin, Option
 
 __all__ = ["ASGIEngin", "ASGIType"]
 
 
-_Scope: TypeAlias = typing.MutableMapping[str, typing.Any]
-_Message: TypeAlias = typing.MutableMapping[str, typing.Any]
-_Receive: TypeAlias = typing.Callable[[], typing.Awaitable[_Message]]
-_Send: TypeAlias = typing.Callable[[_Message], typing.Awaitable[None]]
+_Scope: TypeAlias = MutableMapping[str, Any]
+_Message: TypeAlias = MutableMapping[str, Any]
+_Receive: TypeAlias = Callable[[], Awaitable[_Message]]
+_Send: TypeAlias = Callable[[_Message], Awaitable[None]]
 
 
 class ASGIType(Protocol):
@@ -54,5 +54,5 @@ class _Rereceive:
     def __init__(self, message: _Message) -> None:
         self._message = message
 
-    async def __call__(self, *args, **kwargs) -> _Message:
+    async def __call__(self, *args: Any, **kwargs: Any) -> _Message:
         return self._message

engin-0.0.3.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: engin
+Version: 0.0.3
+Summary: An async-first modular application framework
+License-File: LICENSE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Engin 🏎️
+
+Engin is a zero-dependency application framework for modern Python.
+
+## Features ✨
+
+- **Lightweight**: Engin has no dependencies.
+- **Async First**: Engin provides first-class support for applications. 
+- **Dependency Injection**: Engin promotes a modular decoupled architecture in your application.
+- **Lifecycle Management**: Engin provides an simple, portable approach for implememting
+  startup and shutdown tasks.
+- **Ecosystem Compatability**: seamlessly integrate with frameworks such as FastAPI without
+  having to migrate your dependencies.
+- **Code Reuse**: Engin's modular components work great as packages and distributions. Allowing
+  low boiler-plate code reuse within your Organisation.
+
+## Installation
+
+Engin is available on PyPI, install using your favourite dependency manager:
+
+- **pip**:`pip install engin`
+- **poetry**: `poetry add engin`
+- **uv**: `uv add engin`
+
+## Getting Started
+
+A minimal example:
+
+```python
+import asyncio
+
+from httpx import AsyncClient
+
+from engin import Engin, Invoke, Provide
+
+
+def httpx_client() -> AsyncClient:
+    return AsyncClient()
+
+
+async def main(http_client: AsyncClient) -> None:
+    print(await http_client.get("https://httpbin.org/get"))
+
+engin = Engin(Provide(httpx_client), Invoke(main))
+
+asyncio.run(engin.run())
+```
+

engin-0.0.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+engin/__init__.py,sha256=AIE9wnwvfXwS1mwp6Sa9xtatBYyYzhWa36GKfAkEx_M,508
+engin/_assembler.py,sha256=UY97tXdHgvRi_iph_kolXZ8YTrxRjHKoIc4tAhqYOcw,5258
+engin/_block.py,sha256=N_rSakTKM5mEW9qUfNio6WRaW6hByu8-HHBSy9UuN8Y,1149
+engin/_dependency.py,sha256=d1G3P6vYTFLJTFOh4DLu_EK5XW3rDX0ejBHGkE7JJbs,4759
+engin/_engin.py,sha256=feqRxk7fXx5VeTcRVJLPn49E5a7TqZ1ZnxUDFRxGznQ,3244
+engin/_exceptions.py,sha256=nkzTqxrW5nkcNgFDGoZ2TBtnHtO2RLk0qghM5LNAEmU,542
+engin/_lifecycle.py,sha256=zW9W7wU78JaGpOI1RqAyH6MiK0mwRZtFLBZDLB-NhX8,759
+engin/_type_utils.py,sha256=naEk-lknC3Fdsd4jiP4YZAxjX3KXZN0MhFde9EV-Fmo,1835
+engin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engin/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engin/ext/asgi.py,sha256=6vuC4zIhsvAdmwRn2I6uuUWPYfqobox1dv7skg2OWwE,1940
+engin/ext/fastapi.py,sha256=vf7eB5no6eVuZyYdJZdvDYZmjJAmoKbrKhskgiSWg5g,1005
+engin-0.0.3.dist-info/METADATA,sha256=ANtqVNefuIRfbjAJNXNWAMwMHzc4GbLRvOT_2zpYI3Y,1491
+engin-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+engin-0.0.3.dist-info/licenses/LICENSE,sha256=XHh5LPUPKZWTBqBv2xxN2RU7D59nHoiJGb5RIt8f45w,1070
+engin-0.0.3.dist-info/RECORD,,

{engin-0.0.1.dist-info → engin-0.0.3.dist-info}/WHEEL

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

engin-0.0.1.dist-info/METADATA

@@ -1,5 +0,0 @@
-Metadata-Version: 2.3
-Name: engin
-Version: 0.0.1
-Summary: An async-first modular application framework
-Requires-Python: >=3.10

engin-0.0.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-engin/__init__.py,sha256=tlqi9y7QWjIV95TxViPQBiQmVV4EIor8xLFkfTjg8IQ,475
-engin/_assembler.py,sha256=Py159y4HvI54QuDcmbjL2kfXtbucYDE2KFBOgoC4qCM,5243
-engin/_block.py,sha256=XrGMFEeps_rvOGsYTlsefUkJGAY6jqdp71G8jE9FbwU,1109
-engin/_dependency.py,sha256=cL1qQFKDt7Rgg7mx8IXVkCZlUigg5cvhPFF9g2LNrgg,4749
-engin/_engin.py,sha256=YWw1c1z8_Q2mVJizPHB74MWk40QX1OE9qclt9WHU39Y,3168
-engin/_exceptions.py,sha256=nkzTqxrW5nkcNgFDGoZ2TBtnHtO2RLk0qghM5LNAEmU,542
-engin/_lifecycle.py,sha256=0hk24fiwaBos5kaZrnG_Qm0VmUhWKnGtwYCjc007XDk,729
-engin/_type_utils.py,sha256=naEk-lknC3Fdsd4jiP4YZAxjX3KXZN0MhFde9EV-Fmo,1835
-engin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-engin/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-engin/ext/asgi.py,sha256=7viV6YgEwa0KatypDUrEYZT3YIQ3URQbzfVTGG7OuZE,1931
-engin/ext/fastapi.py,sha256=vf7eB5no6eVuZyYdJZdvDYZmjJAmoKbrKhskgiSWg5g,1005
-engin-0.0.1.dist-info/METADATA,sha256=-SaVsTSi5xCLs0HDU3sXAT7USe6JD6WBWPoidm5-zqs,127
-engin-0.0.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-engin-0.0.1.dist-info/licenses/LICENSE,sha256=XHh5LPUPKZWTBqBv2xxN2RU7D59nHoiJGb5RIt8f45w,1070
-engin-0.0.1.dist-info/RECORD,,