aspyx 1.4.0__tar.gz → 1.5.0__tar.gz

aspyx-1.5.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-1.5.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: aspyx
+Version: 1.5.0
+Summary: A DI and AOP library for Python
+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: python-dotenv~=1.1.0
+Requires-Dist: pyyaml~=6.0.2
+Description-Content-Type: text/markdown
+
+aspyx

aspyx-1.5.0/README.md

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

aspyx-1.5.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "aspyx"
+version = "1.5.0"
+description = "A DI and AOP library for Python"
+authors = [{ name = "Andreas Ernst", email = "andreas.ernst7@gmail.com" }]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+dependencies = [
+    "python-dotenv~=1.1.0",
+    "pyyaml~=6.0.2"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+source = "src"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aspyx"]

aspyx-1.5.0/src/aspyx/__init__.py

@@ -0,0 +1 @@
+#

{aspyx-1.4.0 → aspyx-1.5.0}/src/aspyx/di/__init__.py

@@ -1,7 +1,7 @@
 """
 This module provides dependency injection and aop capabilities for Python applications.
 """
-from .di import conditional, requires_class, requires_feature, DIException, AbstractCallableProcessor, LifecycleCallable, Lifecycle, Providers, Environment, ClassInstanceProvider, injectable, factory, environment, inject, order, create, on_init, on_running, on_destroy, inject_environment, Factory, PostProcessor
+from .di import InstanceProvider, conditional, requires_class, requires_feature, DIException, AbstractCallableProcessor, LifecycleCallable, Lifecycle, Providers, Environment, ClassInstanceProvider, injectable, factory, module, inject, order, create, on_init, on_running, on_destroy, inject_environment, Factory, PostProcessor
 
 # import something from the subpackages, so that the decorators are executed
 
@@ -17,11 +17,11 @@ __all__ = [
     "Environment",
     "injectable",
     "factory",
-    "environment",
+    "module",
     "inject",
     "create",
     "order",
-
+    "InstanceProvider",
     "on_init",
     "on_running",
     "on_destroy",

aspyx-1.5.0/src/aspyx/di/aop/__init__.py

@@ -0,0 +1,28 @@
+"""
+The AOP module gives you the possibility to define aspects that will participate in method execution flows.
+
+**Example**: all method executions of methods named "foo" will include a `before` aspect, that will be executed before the original method
+
+```python
+@advice
+class Advice:
+   @before(methods().named("foo"))
+   def before_call(self, invocation: Invocation):
+      ...
+
+```
+
+Note, that this requires that both the advice and the targeted methods need to be managed by an environment.
+"""
+from .aop import before, after, classes, around, error, advice, methods, Invocation, AspectTarget
+__all__ = [
+    "before",
+    "after",
+    "around",
+    "error",
+    "advice",
+    "classes",
+    "methods",
+    "Invocation",
+    "AspectTarget"
+]

{aspyx-1.4.0 → aspyx-1.5.0}/src/aspyx/di/aop/aop.py

@@ -25,6 +25,7 @@ class AspectType(Enum):
     AspectType defines the types of aspect-oriented advice that can be applied to methods.
 
     The available types are:
+
     - BEFORE: Advice to be executed before the method invocation.
     - AROUND: Advice that intercepts the method invocation.
     - AFTER: Advice to be executed after the method invocation, regardless of its outcome.
@@ -98,7 +99,7 @@ class AspectTarget(ABC):
 
      # fluent
 
-    def function(self, func):
+    def function(self, func) -> AspectTarget:
         self._function = func
         return self
 
@@ -107,39 +108,65 @@ class AspectTarget(ABC):
 
         return self
 
-    def that_are_async(self):
+    def that_are_async(self) -> AspectTarget:
         """
         matches methods that are async
-        :return: self
+
+        Returns:
+            AspectTarget: self
         """
         self._async = True
         return self
 
-    def of_type(self, type: Type):
+    def of_type(self, type: Type) -> AspectTarget:
         """
         matches methods belonging to a class or classes that are subclasses of the specified type
-        :return: self
+
+        Args:
+            type (Type): the type to match against
+
+        Returns:
+            AspectTarget: self
         """
         self.types.append(type)
         return self
 
-    def decorated_with(self, decorator):
+    def decorated_with(self, decorator: Callable) -> AspectTarget:
         """
         matches methods or classes that are decorated with the specified decorator
-        :param decorator:  the decorator callable
-        :return:
+
+        Args:
+            decorator (Callable): the decorator callable
+
+        Returns:
+            AspectTarget: self
         """
         self.decorators.append(decorator)
         return self
 
-    def matches(self, pattern: str):
+    def matches(self, pattern: str) -> AspectTarget:
         """
         Matches the target against a pattern.
+
+        Args:
+            pattern (str): the pattern
+
+        Returns:
+            AspectTarget: self
         """
         self.patterns.append(re.compile(pattern))
         return self
 
-    def named(self, name: str):
+    def named(self, name: str) -> AspectTarget:
+        """
+        Matches the target against a name.
+
+        Args:
+            name (str): the name
+
+        Returns:
+            AspectTarget: self
+        """
         self.names.append(name)
         return self
 
@@ -234,15 +261,21 @@ class MethodAspectTarget(AspectTarget):
 
         return True
 
-def methods():
+def methods() -> AspectTarget:
     """
     Create a new AspectTarget instance to define method aspect targets.
+
+    Returns:
+         AspectTarget: the method target
     """
     return MethodAspectTarget()
 
-def classes():
+def classes() -> AspectTarget:
     """
     Create a new AspectTarget instance to define class aspect targets.
+
+    Returns:
+        AspectTarget: the method target
     """
     return ClassAspectTarget()
 
@@ -405,7 +438,7 @@ class Invocation:
 
     def proceed(self, *args, **kwargs):
         """
-        Proceed to the next join point in the around chain up to the original method.
+        Proceed to the next aspect in the around chain up to the original method.
         """
         if len(args) > 0 or len(kwargs) > 0:  # as soon as we have args, we replace the current ones
             self.args = args
@@ -417,7 +450,7 @@ class Invocation:
 
     async def proceed_async(self, *args, **kwargs):
         """
-        Proceed to the next join point in the around chain up to the original method.
+        Proceed to the next aspect in the around chain up to the original method.
         """
         if len(args) > 0 or len(kwargs) > 0:  # as soon as we have args, we replace the current ones
             self.args = args
@@ -428,6 +461,9 @@ class Invocation:
         return await self.current_aspect.next.call_async(self)
 
 class Advices:
+    """
+    Internal utility class that collects all advice s
+    """
     # static data
 
     targets: list[AspectTarget] = []
@@ -443,7 +479,13 @@ class Advices:
 
     @classmethod
     def collect(cls, clazz, member, type: AspectType, environment: Environment):
-        aspects = [FunctionAspect(environment.get(target._clazz), target._function, None) for target in Advices.targets if target._type == type and target._clazz is not clazz and environment.providers.get(target._clazz) is not None and target._matches(clazz, member)]
+        aspects = [
+            FunctionAspect(environment.get(target._clazz), target._function, None) for target in Advices.targets
+            if target._type == type
+               and target._clazz is not clazz
+               and environment.providers.get(target._clazz) is not None
+               and target._matches(clazz, member)
+        ]
 
         # sort according to order
 
@@ -518,8 +560,8 @@ def sanity_check(clazz: Type, name: str):
 
 def advice(cls):
     """
-    Classes decorated with @advice are treated as advice classes.
-    They can contain methods decorated with @before, @after, @around, or @error to define aspects.
+    Classes decorated with `@advice` are treated as advice classes.
+    They can contain methods decorated with `@before`, `@after`, `@around`, or `@error` to define aspects.
     """
     Providers.register(ClassInstanceProvider(cls, True))
 
@@ -528,7 +570,7 @@ def advice(cls):
     for name, member in TypeDescriptor.for_type(cls).methods.items():
         decorator = next((decorator for decorator in member.decorators if decorator.decorator in [before, after, around, error]), None)
         if decorator is not None:
-            target = decorator.args[0] # ? ...?? TODO, can be multiple
+            target = decorator.args[0] # multiple targets are already merged in a single! check _register
             target._clazz = cls
             sanity_check(cls, name)
             Advices.targets.append(target) #??
@@ -550,7 +592,7 @@ def _register(decorator, targets: list[AspectTarget], func, aspect_type: AspectT
 
 def before(*targets: AspectTarget):
     """
-    Methods decorated with @before will be executed before the target method is invoked.
+    Methods decorated with `@before` will be executed before the target method is invoked.
     """
     def decorator(func):
         _register(before, targets, func, AspectType.BEFORE)
@@ -561,7 +603,7 @@ def before(*targets: AspectTarget):
 
 def error(*targets: AspectTarget):
     """
-    Methods decorated with @error will be executed if the target method raises an exception."""
+    Methods decorated with `@error` will be executed if the target method raises an exception."""
     def decorator(func):
         _register(error, targets, func, AspectType.ERROR)
 
@@ -571,7 +613,7 @@ def error(*targets: AspectTarget):
 
 def after(*targets: AspectTarget):
     """
-    Methods decorated with @after will be executed after the target method is invoked.
+    Methods decorated with `@after` will be executed after the target method is invoked.
     """
     def decorator(func):
         _register(after, targets, func, AspectType.AFTER)
@@ -582,7 +624,7 @@ def after(*targets: AspectTarget):
 
 def around(*targets: AspectTarget):
     """
-    Methods decorated with @around will be executed around the target method.
+    Methods decorated with `@around` will be executed around the target method.
     Every around method must accept a single parameter of type Invocation and needs to call proceed
     on this parameter to proceed to the next around method.
     """

{aspyx-1.4.0 → aspyx-1.5.0}/src/aspyx/di/configuration/__init__.py

@@ -1,7 +1,7 @@
 """
-Configuration value handling
+This module contains functionality to read configuration values from different sources and to retrieve or inject them.
 """
-from .configuration import ConfigurationManager, ConfigurationSource, value
+from .configuration import ConfigurationManager, ConfigurationSource, inject_value
 from .env_configuration_source import EnvConfigurationSource
 from .yaml_configuration_source import YamlConfigurationSource
 
@@ -10,5 +10,5 @@ __all__ = [
     "ConfigurationSource",
     "EnvConfigurationSource",
     "YamlConfigurationSource",
-    "value"
+    "inject_value"
 ]

{aspyx-1.4.0 → aspyx-1.5.0}/src/aspyx/di/configuration/configuration.py

@@ -66,10 +66,12 @@ class ConfigurationManager:
     def get(self, path: str, type: Type[T], default : Optional[T]=None) -> T:
         """
         Retrieve a configuration value by path and type, with optional coercion.
-        Arguments:
+
+        Args:
             path (str): The path to the configuration value, e.g. "database.host".
             type (Type[T]): The expected type.
             default (Optional[T]): The default value to return if the path is not found.
+
         Returns:
             T: The configuration value coerced to the specified type, or the default value if not found.
         """
@@ -119,17 +121,17 @@ class ConfigurationSource(ABC):
 
 # decorator
 
-def value(key: str, default=None):
+def inject_value(key: str, default=None):
     """
     Decorator to inject a configuration value into a method.
 
-    Arguments:
+    Args:
         key (str): The configuration key to inject.
         default: The default value to use if the key is not found.
 
     """
     def decorator(func):
-        Decorators.add(func, value, key, default)
+        Decorators.add(func, inject_value, key, default)
 
         return func
 
@@ -139,7 +141,7 @@ def value(key: str, default=None):
 @order(9)
 class ConfigurationLifecycleCallable(LifecycleCallable):
     def __init__(self,  manager: ConfigurationManager):
-        super().__init__(value, Lifecycle.ON_INJECT)
+        super().__init__(inject_value, Lifecycle.ON_INJECT)
 
         self.manager = manager