aspyx-service 0.10.4__tar.gz → 0.10.5__tar.gz

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aspyx_service
-Version: 0.10.4
+Version: 0.10.5
 Summary: Aspyx Service framework
 Author-email: Andreas Ernst <andreas.ernst7@gmail.com>
 License: MIT License
@@ -26,8 +26,7 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Requires-Python: >=3.9
-Requires-Dist: aspyx>=1.5.3
-Requires-Dist: cachetools~=5.5.2
+Requires-Dist: aspyx>=1.6.0
 Requires-Dist: fastapi~=0.115.13
 Requires-Dist: httpx~=0.28.1
 Requires-Dist: msgpack~=1.1.1
@@ -110,18 +109,20 @@ class TestComponent(Component):
 After booting the DI infrastructure with a main module we could already call a service:
 
 **Example**:
+
 ```python
 @module(imports=[ServiceModule])
 class Module:
     def __init__(self):
         pass
-    
+
     @create()
     def create_registry(self) -> ConsulComponentRegistry:
-        return ConsulComponentRegistry(Server.port, Consul(host="localhost", port=8500)) # a consul based registry!
+        return ConsulComponentRegistry(Server.port, Consul(host="localhost", port=8500))  # a consul based registry!
+
 
 environment = Environment(Module)
-service_manager = environment.get(ServiceManager)
+service_manager = environment.read(ServiceManager)
 
 service = service_manager.get_service(TestService)
 
@@ -202,6 +203,14 @@ The library offers:
 As well as the DI and AOP core, all mechanisms are heavily optimized.
 A simple benchmark resulted in message roundtrips in significanlty under a ms per call.
 
+## Installation
+
+Just install from PyPI with 
+
+`pip install aspyx-service`
+
+The library is tested with all Python version >= 3.9
+
 Let's see some details
 
 ## Service and Component declaration 
@@ -484,18 +493,26 @@ class ChannelAdvice:
 
 ## FastAPI server
 
-In order to expose components via HTTP, the corresponding infrastructure in form of a FastAPI server needs to be setup. 
+The required - `FastAPI` - infrastructure to expose those services requires:
 
+- a `FastAPI` instance
+- an injectable `FastAPIServer`
+- and a final `boot` call with the root module, which will return an `Environment`
 
 ```python
-@module()
-class Module():
+fast_api = FastAPI() # so you can run it with uvivorn from command-line
+
+@module(imports=[ServiceModule])
+class Module:
     def __init__(self):
         pass
+
+    @create()
+    def create_server(self,  service_manager: ServiceManager, component_registry: ComponentRegistry) -> FastAPIServer:
+        return FastAPIServer(fastapi, service_manager, component_registry)
     
- server = FastAPIServer(host="0.0.0.0", port=8000)
 
- environment = server.boot(Module) # will start the http server
+environment = FastAPIServer.boot(Moudle, host="0.0.0.0", port=8000)
 ```
 
 This setup will also expose all service interfaces decorated with the corresponding http decorators!

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/README.md

@@ -73,18 +73,20 @@ class TestComponent(Component):
 After booting the DI infrastructure with a main module we could already call a service:
 
 **Example**:
+
 ```python
 @module(imports=[ServiceModule])
 class Module:
     def __init__(self):
         pass
-    
+
     @create()
     def create_registry(self) -> ConsulComponentRegistry:
-        return ConsulComponentRegistry(Server.port, Consul(host="localhost", port=8500)) # a consul based registry!
+        return ConsulComponentRegistry(Server.port, Consul(host="localhost", port=8500))  # a consul based registry!
+
 
 environment = Environment(Module)
-service_manager = environment.get(ServiceManager)
+service_manager = environment.read(ServiceManager)
 
 service = service_manager.get_service(TestService)
 
@@ -165,6 +167,14 @@ The library offers:
 As well as the DI and AOP core, all mechanisms are heavily optimized.
 A simple benchmark resulted in message roundtrips in significanlty under a ms per call.
 
+## Installation
+
+Just install from PyPI with 
+
+`pip install aspyx-service`
+
+The library is tested with all Python version >= 3.9
+
 Let's see some details
 
 ## Service and Component declaration 
@@ -447,18 +457,26 @@ class ChannelAdvice:
 
 ## FastAPI server
 
-In order to expose components via HTTP, the corresponding infrastructure in form of a FastAPI server needs to be setup. 
+The required - `FastAPI` - infrastructure to expose those services requires:
 
+- a `FastAPI` instance
+- an injectable `FastAPIServer`
+- and a final `boot` call with the root module, which will return an `Environment`
 
 ```python
-@module()
-class Module():
+fast_api = FastAPI() # so you can run it with uvivorn from command-line
+
+@module(imports=[ServiceModule])
+class Module:
     def __init__(self):
         pass
+
+    @create()
+    def create_server(self,  service_manager: ServiceManager, component_registry: ComponentRegistry) -> FastAPIServer:
+        return FastAPIServer(fastapi, service_manager, component_registry)
     
- server = FastAPIServer(host="0.0.0.0", port=8000)
 
- environment = server.boot(Module) # will start the http server
+environment = FastAPIServer.boot(Moudle, host="0.0.0.0", port=8000)
 ```
 
 This setup will also expose all service interfaces decorated with the corresponding http decorators!

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/performance-test/client.py

@@ -7,11 +7,12 @@ from dataclasses import dataclass
 
 from pydantic import BaseModel
 
-from aspyx.di import module
-
 from aspyx_service import ServiceModule, delete, post, put, get, rest, Body
 from aspyx_service.service import  component, Component, Service, service
 
+from aspyx.di import module
+
+
 class Pydantic(BaseModel):
     i: int
     f: float
@@ -151,4 +152,4 @@ class TestComponent(Component): # pylint: disable=abstract-method
 @module(imports=[ServiceModule])
 class ClientModule:
     def __init__(self):
-        pass
+        pass

aspyx_service-0.10.5/performance-test/main.py

@@ -0,0 +1,34 @@
+"""
+the server hosting the test services
+"""
+import logging
+import os
+
+from fastapi import FastAPI
+
+from aspyx_service import FastAPIServer, RequestContext
+from server import  ServerModule
+from aspyx.util import Logger
+
+
+Logger.configure(default_level=logging.DEBUG, levels={
+    "httpx": logging.ERROR,
+    "aspyx.di": logging.ERROR,
+    "aspyx.di.aop": logging.ERROR,
+    "aspyx.service": logging.ERROR
+})
+
+PORT = int(os.getenv("FAST_API_PORT", "8000"))
+
+app = FastAPI()
+
+app.add_middleware(RequestContext)
+#app.add_middleware(TokenContextMiddleware)
+
+ServerModule.fastapi = app
+
+FastAPIServer.boot(ServerModule, host="0.0.0.0", port=PORT, start_thread= False)
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run("main:app", host="0.0.0.0", port=PORT, reload=True, log_level="warning", access_log=False)

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/performance-test/performance-test.py

@@ -10,18 +10,20 @@ from typing import Callable, TypeVar, Type, Awaitable, Any, Dict, cast
 
 from consul import Consul
 
+from aspyx_service import ConsulComponentRegistry, SessionManager
+
 from aspyx.di import module, Environment, create
 from aspyx.di.aop import advice, around, methods, Invocation
 from aspyx.util import Logger
 
-from aspyx_service import ConsulComponentRegistry
+
 from aspyx_service.service import ServiceManager, ComponentRegistry, Channel
 
-Logger.configure(default_level=logging.DEBUG, levels={
-    "httpx": logging.ERROR,
-    "aspyx.di": logging.ERROR,
-    "aspyx.di.aop": logging.ERROR,
-    "aspyx.service": logging.ERROR
+Logger.configure(default_level=logging.INFO, levels={
+    "httpx": logging.CRITICAL,
+    "aspyx.di": logging.INFO,
+    "aspyx.di.aop": logging.INFO,
+    "aspyx.service": logging.INFO
 })
 
 from client import TestService, TestRestService, Pydantic, Data, TestAsyncRestService, TestAsyncService, ClientModule
@@ -46,6 +48,10 @@ class TestModule:
     def __init__(self):
         pass
 
+    @create()
+    def create_session_storage(self) -> SessionManager.Storage:
+        return SessionManager.InMemoryStorage(max_size=1000, ttl=3600)
+
     @create()
     def create_registry(self) -> ComponentRegistry:
         return ConsulComponentRegistry(port=8000, consul=Consul(host="localhost", port=8500))
@@ -207,7 +213,7 @@ async def main():
     # async
 
     await run_async_loops("async rest", loops, TestAsyncRestService, manager.get_service(TestAsyncRestService, preferred_channel="rest"),
-              lambda service: service.get("world"))
+                          lambda service: service.get("world"))
     await run_async_loops("async json", loops, TestAsyncService, manager.get_service(TestAsyncService, preferred_channel="dispatch-json"),
               lambda service: service.hello("world"))
     await run_async_loops("async msgpack", loops, TestAsyncService, manager.get_service(TestAsyncService, preferred_channel="dispatch-msgpack"),
@@ -276,4 +282,4 @@ async def main():
                              lambda service: service.hello("world"))
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    asyncio.run(main())

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/performance-test/server.py

@@ -5,15 +5,19 @@ import os
 from typing import Optional
 
 from consul import Consul
+from fastapi import FastAPI
 
+from aspyx_service import HealthCheckManager, ServiceModule, ConsulComponentRegistry, SessionManager, FastAPIServer
+
+from client import ClientModule, TestService, TestAsyncService, Data, Pydantic, TestRestService, TestAsyncRestService, TestComponent
+
+from aspyx_service.service import ChannelAddress, Server, \
+    component_services, AbstractComponent, implementation, health, ComponentRegistry, ServiceManager
 from aspyx.di import on_running, module, create
 from aspyx.di.aop import Invocation, advice, error
 from aspyx.exception import handle, ExceptionManager
-from aspyx_service import HealthCheckManager, ServiceModule, ConsulComponentRegistry
-from aspyx_service.service import ChannelAddress, Server, \
-    component_services, AbstractComponent, implementation, health, ComponentRegistry
 
-from client import ClientModule, TestService, TestAsyncService, Data, Pydantic, TestRestService, TestAsyncRestService, TestComponent
+
 
 
 # implementation classes
@@ -142,6 +146,8 @@ class TestComponentImpl(AbstractComponent, TestComponent):
 
 @module(imports=[ClientModule, ServiceModule])
 class ServerModule:
+    fastapi: Optional[FastAPI] = None
+
     def __init__(self):
         pass
 
@@ -149,6 +155,14 @@ class ServerModule:
     #def create_yaml_source(self) -> YamlConfigurationSource:
     #    return YamlConfigurationSource(f"{Path(__file__).parent}/config.yaml")
 
+    @create()
+    def create_server(self, service_manager: ServiceManager, component_registry: ComponentRegistry) -> FastAPIServer:
+        return FastAPIServer(self.fastapi, service_manager, component_registry)
+
+    @create()
+    def create_session_storage(self) -> SessionManager.Storage:
+        return SessionManager.InMemoryStorage(max_size=1000, ttl=3600)
+
     @create()
     def create_registry(self) -> ComponentRegistry:
-        return ConsulComponentRegistry(port=int(os.getenv("FAST_API_PORT", 8000)), consul=Consul(host="localhost", port=8500))
+        return ConsulComponentRegistry(port=int(os.getenv("FAST_API_PORT", "8000")), consul=Consul(host="localhost", port=8500))

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/pyproject.toml

@@ -2,19 +2,18 @@
 
 [project]
 name = "aspyx_service"
-version = "0.10.4"
+version = "0.10.5"
 description = "Aspyx Service framework"
 authors = [{ name = "Andreas Ernst", email = "andreas.ernst7@gmail.com" }]
 readme = "README.md"
 license = { file = "LICENSE" }
 requires-python = ">=3.9"
 dependencies = [
-    "aspyx>=1.5.3",
+    "aspyx>=1.6.0",
     "python-consul2~=0.1.5",
     "fastapi~=0.115.13",
     "httpx~=0.28.1",
     "msgpack~=1.1.1",
-    "cachetools~= 5.5.2",
     "uvicorn[standard]"
 ]
 

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/src/aspyx_service/__init__.py

@@ -7,12 +7,11 @@ from aspyx.di import module
 from .service import AuthorizationException, MissingTokenException, RemoteServiceException, ServiceCommunicationException, TokenException, TokenExpiredException, InvalidTokenException, component_services, ServiceException, Server, Channel, ComponentDescriptor, inject_service, ChannelAddress, ChannelInstances, ServiceManager, Component, Service, AbstractComponent, ComponentStatus, ComponentRegistry, implementation, health, component, service
 from .channels import HTTPXChannel, DispatchJSONChannel, TokenContext
 from .registries import ConsulComponentRegistry
-from .server import FastAPIServer, RequestContext
+from .server import FastAPIServer, RequestContext, ResponseContext, TokenContextMiddleware
 from .healthcheck import health_checks, health_check, HealthCheckManager, HealthStatus
 from .restchannel import RestChannel, post, get, put, delete, QueryParam, Body, rest
-from .session import Session, SessionManager
-from .authorization import AuthorizationManager, AbstractAuthorizationFactory, AuthorizationException
-
+from .session import Session, SessionManager, SessionContext
+from .authorization import AuthorizationManager, AbstractAuthorizationFactory
 
 @module()
 class ServiceModule:
@@ -53,12 +52,12 @@ __all__ = [
 
     "AuthorizationManager",
     "AbstractAuthorizationFactory",
-    "AuthorizationException",
 
     # session
 
     "Session",
     "SessionManager",
+    "SessionContext",
 
     # healthcheck
 
@@ -91,10 +90,12 @@ __all__ = [
     # registries
 
     "ConsulComponentRegistry",
-    "RequestContext",
 
     # server
 
     "FastAPIServer",
-    "RequestContext"
+    "RequestContext",
+    "ResponseContext",
+    "TokenContext",
+    "TokenContextMiddleware",
 ]

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/src/aspyx_service/authorization.py

@@ -9,13 +9,6 @@ from aspyx.di import injectable, inject, order
 from aspyx.di.aop import Invocation
 from aspyx.reflection import TypeDescriptor, Decorators
 
-
-class AuthorizationException(Exception):
-    """
-    Any authorization exception
-    """
-    pass
-
 def get_method_class(method):
     if inspect.ismethod(method) or inspect.isfunction(method):
         qualname = method.__qualname__
@@ -38,11 +31,10 @@ class AuthorizationManager:
         """
         Base class for authorization checks
         """
-        def check(self, invocation: Invocation):
+        def authorize(self, invocation: Invocation):
             """
-            execute the authorization check. Throws an exception in case of violations,
+            execute the authorization check. Throws an exception in case of violations
             """
-            pass
 
     class AuthorizationFactory(ABC):
         """
@@ -62,7 +54,6 @@ class AuthorizationManager:
             Returns:
                 an authorization check or None
             """
-            pass
 
     # constructor
 
@@ -111,9 +102,9 @@ class AuthorizationManager:
 
         return checks
 
-    def check(self, invocation: Invocation) -> Optional[Authorization]:
+    def authorize(self, invocation: Invocation):
         for check in self.get_checks(invocation.func):
-            check.check(invocation)
+            check.authorize(invocation)
 
 class AbstractAuthorizationFactory(AuthorizationManager.AuthorizationFactory):
     """

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/src/aspyx_service/channels.py

@@ -16,11 +16,11 @@ from pydantic import BaseModel
 from aspyx.di.configuration import inject_value
 from aspyx.reflection import DynamicProxy, TypeDescriptor
 from aspyx.threading import ThreadLocal, ContextLocal
+from aspyx.util import get_deserializer, TypeDeserializer, TypeSerializer, get_serializer
 from .service import ServiceManager, ServiceCommunicationException, TokenExpiredException, InvalidTokenException, \
     AuthorizationException, MissingTokenException
 
 from .service import ComponentDescriptor, ChannelInstances, ServiceException, channel, Channel, RemoteServiceException
-from .serialization import get_deserializer, TypeDeserializer, TypeSerializer, get_serializer
 
 class TokenContext:
     """
@@ -208,10 +208,11 @@ class HTTPXChannel(Channel):
                 if "invalid_token" in www_auth:
                     if 'expired' in www_auth:
                         raise TokenExpiredException() from e
-                    elif 'missing' in www_auth:
+
+                    if 'missing' in www_auth:
                         raise MissingTokenException() from e
-                    else:
-                        raise InvalidTokenException() from e
+
+                    raise InvalidTokenException() from e
 
             raise AuthorizationException(str(e)) from e
         except httpx.HTTPError as e:
@@ -451,10 +452,11 @@ class DispatchMSPackChannel(HTTPXChannel):
                 if "invalid_token" in www_auth:
                     if 'expired' in www_auth:
                         raise TokenExpiredException() from e
-                    elif 'missing' in www_auth:
+
+                    if 'missing' in www_auth:
                         raise MissingTokenException() from e
-                    else:
-                        raise InvalidTokenException() from e
+
+                    raise InvalidTokenException() from e
 
             raise RemoteServiceException(str(e)) from e
 

{aspyx_service-0.10.4 → aspyx_service-0.10.5}/src/aspyx_service/restchannel.py

@@ -6,19 +6,15 @@ import re
 from dataclasses import is_dataclass
 
 from typing import get_type_hints, TypeVar, Annotated, Callable, get_origin, get_args, Type
-
-
 from pydantic import BaseModel
 
-from .channels import HTTPXChannel
-
 from aspyx.reflection import DynamicProxy, Decorators
+
+from .channels import HTTPXChannel
 from .service import channel, ServiceCommunicationException
 
 T = TypeVar("T")
 
-
-
 class BodyMarker:
     pass