aspyx-service 0.9.0__tar.gz

aspyx_service-0.9.0/.gitignore

@@ -0,0 +1,194 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

aspyx_service-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andreas Ernst
+
+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.

aspyx_service-0.9.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: aspyx_service
+Version: 0.9.0
+Summary: Service framework on top of aspyx
+Author-email: Andreas Ernst <andreas.ernst7@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Andreas Ernst
+        
+        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.
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: aspyx>=1.4.1
+Requires-Dist: fastapi~=0.115.13
+Requires-Dist: httpx~=0.28.1
+Requires-Dist: msgpack~=1.1.1
+Requires-Dist: python-consul2~=0.1.5
+Description-Content-Type: text/markdown
+
+aspyx-service

aspyx_service-0.9.0/README.md

@@ -0,0 +1 @@
+aspyx-service

aspyx_service-0.9.0/pyproject.toml

@@ -0,0 +1,32 @@
+
+
+[project]
+name = "aspyx_service"
+version = "0.9.0"
+description = "Service framework on top of aspyx"
+authors = [{ name = "Andreas Ernst", email = "andreas.ernst7@gmail.com" }]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+dependencies = [
+    "aspyx>=1.4.1",
+    "python-consul2~=0.1.5",
+    "fastapi~=0.115.13",
+    "httpx~=0.28.1",
+    "msgpack~=1.1.1"
+]
+
+#"aspyx @ file://../aspyx",  # Local editable ref
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+source = "src"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aspyx_service"]
+
+[tool.hatch.metadata]
+allow-direct-references = true

aspyx_service-0.9.0/src/aspyx_service/__init__.py

@@ -0,0 +1,71 @@
+"""
+This module provides the core Aspyx service management framework allowing for service discovery and transparent remoting including multiple possible transport protocols.
+"""
+
+from aspyx.di import module
+
+from .service import ServiceException, Server, Channel, ComponentDescriptor, inject_service, ChannelAddress, ServiceAddress, ServiceManager, Component, Service, AbstractComponent, ComponentStatus, ComponentRegistry, implementation, health, component, service
+from .channels import HTTPXChannel, DispatchJSONChannel
+from .registries import ConsulComponentRegistry
+from .server import FastAPIServer
+from .healthcheck import health_checks, health_check, HealthCheckManager, HealthStatus
+from .restchannel import RestChannel, post, get, put, delete, QueryParam, Body, rest
+
+
+@module()
+class ServiceModule:
+    def __init__(self):
+        pass
+
+__all__ = [
+    # service
+
+    "ServiceManager",
+    "ServiceModule",
+    "ServiceException",
+    "Server",
+    "Component",
+    "Service",
+    "Channel",
+    "AbstractComponent",
+    "ComponentStatus",
+    "ComponentDescriptor",
+    "ComponentRegistry",
+    "ChannelAddress",
+    "ServiceAddress",
+    "health",
+    "component",
+    "service",
+    "implementation",
+    "inject_service",
+
+    # healthcheck
+
+    # serialization
+
+   # "deserialize",
+
+    # channel
+
+    "HTTPXChannel",
+    "DispatchJSONChannel",
+
+    # rest
+
+    "RestChannel",
+    "post",
+    "get",
+    "put",
+    "delete",
+    "rest",
+    "QueryParam",
+    "Body",
+
+    # registries
+
+    "ConsulComponentRegistry",
+
+    # server
+
+    "FastAPIServer"
+]

aspyx_service-0.9.0/src/aspyx_service/channels.py

@@ -0,0 +1,210 @@
+"""
+Service management and dependency injection framework.
+"""
+from __future__ import annotations
+
+from typing import Type, Optional, Any, Callable
+
+import msgpack
+from httpx import Client, AsyncClient
+from pydantic import BaseModel
+
+from aspyx.reflection import DynamicProxy, TypeDescriptor
+from .service import ServiceManager
+
+from .service import ComponentDescriptor, ServiceAddress, ServiceException, channel, Channel, RemoteServiceException
+from .serialization import get_deserializer
+
+
+class HTTPXChannel(Channel):
+    __slots__ = [
+        "client",
+        "async_client",
+        "service_names",
+        "deserializers"
+    ]
+
+    # constructor
+
+    def __init__(self, name):
+        super().__init__(name)
+
+        self.client: Optional[Client] = None
+        self.async_client: Optional[AsyncClient] = None
+        self.service_names: dict[Type, str] = {}
+        self.deserializers: dict[Callable, Callable] = {}
+
+    # protected
+
+    def get_deserializer(self, type: Type, method: Callable) -> Type:
+        deserializer = self.deserializers.get(method, None)
+        if deserializer is None:
+            return_type = TypeDescriptor.for_type(type).get_method(method.__name__).return_type
+
+            deserializer = get_deserializer(return_type)
+
+            self.deserializers[method] = deserializer
+
+        return deserializer
+
+    # override
+
+    def setup(self, component_descriptor: ComponentDescriptor, address: ServiceAddress):
+        super().setup(component_descriptor, address)
+
+        # remember service names
+
+        for service in component_descriptor.services:
+            self.service_names[service.type] = service.name
+
+        # make client
+
+        self.client = self.make_client()
+        self.async_client = self.make_async_client()
+
+    # public
+
+    def get_client(self) -> Client:
+        if self.client is None:
+            self.client = self.make_client()
+
+        return self.client
+
+    def get_async_client(self) -> Client:
+        if self.async_client is None:
+            self.async_client = self.make_async_client()
+
+        return self.async_client
+
+    def make_client(self):
+        return Client()  # base_url=url
+
+    def make_async_client(self):
+        return AsyncClient()  # base_url=url
+
+class Request(BaseModel):
+    method: str  # component:service:method
+    args: tuple[Any, ...]
+
+class Response(BaseModel):
+    result: Optional[Any]
+    exception: Optional[Any]
+
+@channel("dispatch-json")
+class DispatchJSONChannel(HTTPXChannel):
+    # constructor
+
+    def __init__(self):
+        super().__init__("dispatch-json")
+
+    # internal
+
+    # implement Channel
+
+    def set_address(self, address: Optional[ServiceAddress]):
+        ServiceManager.logger.info("channel %s got an address %s", self.name, address)
+
+        super().set_address(address)
+
+    def setup(self, component_descriptor: ComponentDescriptor, address: ServiceAddress):
+        super().setup(component_descriptor, address)
+
+    def invoke(self, invocation: DynamicProxy.Invocation):
+        service_name = self.service_names[invocation.type]  # map type to registered service name
+        request = Request(method=f"{self.component_descriptor.name}:{service_name}:{invocation.method.__name__}", args=invocation.args)
+
+        try:
+            if self.client is not None:
+                result = Response(**self.get_client().post(f"{self.get_url()}/invoke", json=request.dict(), timeout=30000.0).json())
+                if result.exception is not None:
+                    raise RemoteServiceException(f"server side exception {result.exception}")
+
+                return self.get_deserializer(invocation.type, invocation.method)(result.result)
+            else:
+                raise ServiceException(f"no url for channel {self.name} for component {self.component_descriptor.name} registered")
+        except Exception as e:
+            raise ServiceException(f"communication exception {e}") from e
+
+    async def invoke_async(self, invocation: DynamicProxy.Invocation):
+        service_name = self.service_names[invocation.type]  # map type to registered service name
+        request = Request(method=f"{self.component_descriptor.name}:{service_name}:{invocation.method.__name__}",
+                          args=invocation.args)
+
+        try:
+            if self.async_client is not None:
+                data =  await self.async_client.post(f"{self.get_url()}/invoke", json=request.dict(), timeout=30000.0)
+                result = Response(**data.json())
+                if result.exception is not None:
+                    raise RemoteServiceException(f"server side exception {result.exception}")
+
+                return self.get_deserializer(invocation.type, invocation.method)(result.result)
+            else:
+                raise ServiceException(
+                    f"no url for channel {self.name} for component {self.component_descriptor.name} registered")
+        except Exception as e:
+            raise ServiceException(f"communication exception {e}") from e
+
+@channel("dispatch-msgpack")
+class DispatchMSPackChannel(HTTPXChannel):
+    # constructor
+
+    def __init__(self):
+        super().__init__("dispatch-msgpack")
+
+    # override
+
+    def set_address(self, address: Optional[ServiceAddress]):
+        ServiceManager.logger.info("channel %s got an address %s", self.name, address)
+
+        super().set_address(address)
+
+    def invoke(self, invocation: DynamicProxy.Invocation):
+        service_name = self.service_names[invocation.type]  # map type to registered service name
+        request = Request(method=f"{self.component_descriptor.name}:{service_name}:{invocation.method.__name__}",
+                          args=invocation.args)
+
+        try:
+            packed = msgpack.packb(request.dict(), use_bin_type=True)
+
+            response = self.get_client().post(
+                f"{self.get_url()}/invoke",
+                content=packed,
+                headers={"Content-Type": "application/msgpack"},
+                timeout=30.0
+            )
+
+            result = msgpack.unpackb(response.content, raw=False)
+
+            if result.get("exception", None):
+                raise RemoteServiceException(f"server-side: {result['exception']}")
+
+            return self.get_deserializer(invocation.type, invocation.method)(result["result"])
+
+        except Exception as e:
+            raise ServiceException(f"msgpack exception: {e}") from e
+
+    async def invoke_async(self, invocation: DynamicProxy.Invocation):
+        service_name = self.service_names[invocation.type]  # map type to registered service name
+        request = Request(method=f"{self.component_descriptor.name}:{service_name}:{invocation.method.__name__}",
+                          args=invocation.args)
+
+        try:
+            packed = msgpack.packb(request.dict(), use_bin_type=True)
+
+            response = await self.get_async_client().post(
+                f"{self.get_url()}/invoke",
+                content=packed,
+                headers={"Content-Type": "application/msgpack"},
+                timeout=30.0
+            )
+
+            result = msgpack.unpackb(response.content, raw=False)
+
+            if result.get("exception", None):
+                raise RemoteServiceException(f"server-side: {result['exception']}")
+
+            return self.get_deserializer(invocation.type, invocation.method)(result["result"])
+
+        except Exception as e:
+            raise ServiceException(f"msgpack exception: {e}") from e
+