engin 0.0.dev1__py3-none-any.whl → 0.0.2__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
@@ -8,14 +9,15 @@ from engin._lifecycle import Lifecycle
 __all__ = [
     "Assembler",
     "AssemblyError",
+    "Block",
     "Engin",
     "Entrypoint",
     "Invoke",
     "Lifecycle",
-    "Block",
     "Option",
     "Provide",
     "Supply",
+    "ext",
     "invoke",
     "provide",
 ]

engin/_assembler.py

@@ -49,7 +49,7 @@ class Assembler:
         if not providers:
             if type_id.multi:
                 LOG.warning(f"no provider for '{type_id}' defaulting to empty list")
-                providers = [(Supply([], type_hint=list[type_id.type]))]
+                providers = [(Supply([], type_hint=list[type_id.type]))]  # type: ignore[name-defined]
             else:
                 raise LookupError(f"No Provider registered for dependency '{type_id}'")
 
@@ -112,15 +112,20 @@ 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]
         if type_id.multi:
             out = []
             for provider in self._multiproviders[type_id]:
                 assembled_dependency = await self.assemble(provider)
                 out.extend(await assembled_dependency())
-            return out
+            self._dependencies[type_id] = out
+            return out  # type: ignore[return-value]
         else:
             assembled_dependency = await self.assemble(self._providers[type_id])
-            return await assembled_dependency()
+            value = await assembled_dependency()
+            self._dependencies[type_id] = value
+            return value  # type: ignore[return-value]
 
     def has(self, type_: type[T]) -> bool:
         return type_id_of(type_) in self._providers

engin/_engin.py

@@ -21,7 +21,7 @@ class Engin:
     _LIB_OPTIONS: ClassVar[list[Option]] = [Provide(Lifecycle)]
 
     def __init__(self, *options: Option) -> None:
-        self._providers: dict[TypeId, Provide] = {}
+        self._providers: dict[TypeId, Provide] = {TypeId.from_type(Engin): Provide(self._self)}
         self._invokables: list[Invoke] = []
         self._stop_event = Event()
 
@@ -35,13 +35,9 @@ class Engin:
     async def run(self):
         await self.start()
 
-        # lifecycle startup
-
         # wait till stop signal recieved
         await self._stop_event.wait()
 
-        # lifecycle shutdown
-
     async def start(self) -> None:
         LOG.info("starting engin")
         assembled_invocations: list[AssembledDependency] = [
@@ -87,3 +83,6 @@ class Engin:
             LOG.debug(f"ENTRYPOINT  {type_id!s:<35}")
         elif isinstance(opt, Invoke):
             LOG.debug(f"INVOKE      {opt.name:<35}")
+
+    def _self(self) -> "Engin":
+        return self

engin/{extensions → ext}/asgi.py

@@ -1,6 +1,6 @@
 import traceback
 import typing
-from typing import Protocol, TypeAlias
+from typing import ClassVar, Protocol, TypeAlias
 
 from engin import Engin, Option
 
@@ -18,13 +18,16 @@ class ASGIType(Protocol):
 
 
 class ASGIEngin(Engin, ASGIType):
+    _asgi_type: ClassVar[type[ASGIType]] = ASGIType  # type: ignore[type-abstract]
     _asgi_app: ASGIType
 
     def __init__(self, *options: Option) -> None:
         super().__init__(*options)
 
-        if not self._assembler.has(ASGIType):
-            raise LookupError("A provider for `ASGIType` was expected, none found")
+        if not self._assembler.has(self._asgi_type):
+            raise LookupError(
+                f"A provider for `{self._asgi_type.__name__}` was expected, none found"
+            )
 
     async def __call__(self, scope: _Scope, receive: _Receive, send: _Send) -> None:
         if scope["type"] == "lifespan":
@@ -44,7 +47,7 @@ class ASGIEngin(Engin, ASGIType):
 
     async def _startup(self) -> None:
         await self.start()
-        self._asgi_app = await self._assembler.get(ASGIType)
+        self._asgi_app = await self._assembler.get(self._asgi_type)
 
 
 class _Rereceive:

engin/ext/fastapi.py

@@ -0,0 +1,42 @@
+import typing
+from typing import ClassVar, TypeVar
+
+from engin import Engin, Invoke, Option
+from engin.ext.asgi import ASGIEngin
+
+try:
+    from fastapi import FastAPI
+    from fastapi.params import Depends
+    from starlette.requests import HTTPConnection
+except ImportError:
+    raise ImportError("fastapi must be installed to use the corresponding extension")
+
+
+if typing.TYPE_CHECKING:
+    from fastapi import FastAPI
+    from fastapi.params import Depends
+
+__all__ = ["FastAPIEngin", "Inject"]
+
+
+def _attach_engin(
+    app: FastAPI,
+    engin: Engin,
+) -> None:
+    app.state.engin = engin
+
+
+class FastAPIEngin(ASGIEngin):
+    _LIB_OPTIONS: ClassVar[list[Option]] = [*ASGIEngin._LIB_OPTIONS, Invoke(_attach_engin)]  # type: ignore[arg-type]
+    _asgi_type = FastAPI
+
+
+T = TypeVar("T")
+
+
+def Inject(interface: type[T]) -> Depends:
+    async def inner(conn: HTTPConnection) -> T:
+        engin: Engin = conn.app.state.engin
+        return await engin.assembler.get(interface)
+
+    return Depends(inner)

engin-0.0.2.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: engin
+Version: 0.0.2
+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.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+engin/__init__.py,sha256=AIE9wnwvfXwS1mwp6Sa9xtatBYyYzhWa36GKfAkEx_M,508
+engin/_assembler.py,sha256=Py159y4HvI54QuDcmbjL2kfXtbucYDE2KFBOgoC4qCM,5243
+engin/_block.py,sha256=XrGMFEeps_rvOGsYTlsefUkJGAY6jqdp71G8jE9FbwU,1109
+engin/_dependency.py,sha256=cL1qQFKDt7Rgg7mx8IXVkCZlUigg5cvhPFF9g2LNrgg,4749
+engin/_engin.py,sha256=KHjtncm0bG_N4sAFt7haxUBMeuLp0zP8Bxpftp7Zgy8,3109
+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.2.dist-info/METADATA,sha256=CxEA114Eb2DF_voKUqPITeZiU1KWfSZaqvzIVNXaUAw,1491
+engin-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+engin-0.0.2.dist-info/licenses/LICENSE,sha256=XHh5LPUPKZWTBqBv2xxN2RU7D59nHoiJGb5RIt8f45w,1070
+engin-0.0.2.dist-info/RECORD,,

{engin-0.0.dev1.dist-info → engin-0.0.2.dist-info}/WHEEL

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

engin-0.0.dev1.dist-info/METADATA

@@ -1,6 +0,0 @@
-Metadata-Version: 2.3
-Name: engin
-Version: 0.0.dev1
-Summary: An async-first modular application framework
-License-File: LICENSE
-Requires-Python: >=3.10

engin-0.0.dev1.dist-info/RECORD

@@ -1,15 +0,0 @@
-engin/__init__.py,sha256=T2tv-pdULMTp-p0PhB_XYmr9CEWOmMzcu0jebZx7-2Q,475
-engin/_assembler.py,sha256=HPnrTGk6XbO-iG3BZfD65zzOxWC4C1yWOZf7Vv3MMKk,4944
-engin/_block.py,sha256=XrGMFEeps_rvOGsYTlsefUkJGAY6jqdp71G8jE9FbwU,1109
-engin/_dependency.py,sha256=cL1qQFKDt7Rgg7mx8IXVkCZlUigg5cvhPFF9g2LNrgg,4749
-engin/_engin.py,sha256=Sg7sxESuwzTXx-4xgFv869YkpBRxE9d-kjIOTOTtcxU,3071
-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/extensions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-engin/extensions/asgi.py,sha256=EHQhevGJt3UJZp_7Y7AIuYVm-bYUO-seuzE3kMuOJWM,1775
-engin-0.0.dev1.dist-info/METADATA,sha256=263kjboSCI7Th0GHl7bbpF5cCHAKsB51_56v5xcJThk,152
-engin-0.0.dev1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-engin-0.0.dev1.dist-info/licenses/LICENSE,sha256=XHh5LPUPKZWTBqBv2xxN2RU7D59nHoiJGb5RIt8f45w,1070
-engin-0.0.dev1.dist-info/RECORD,,