aspyx 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

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 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,7 +17,7 @@ __all__ = [
     "Environment",
     "injectable",
     "factory",
-    "environment",
+    "module",
     "inject",
     "create",
     "order",

aspyx/di/aop/__init__.py

@@ -1,7 +1,20 @@
 """
-AOP module
+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
+from .aop import before, after, classes, around, error, advice, methods, Invocation, AspectTarget
 __all__ = [
     "before",
     "after",
@@ -11,4 +24,5 @@ __all__ = [
     "classes",
     "methods",
     "Invocation",
+    "AspectTarget"
 ]

aspyx/di/aop/aop.py

@@ -12,10 +12,8 @@ from dataclasses import dataclass
 from enum import auto, Enum
 from typing import Optional, Dict, Type, Callable
 
-from aspyx.di.di import order
 from aspyx.reflection import Decorators, TypeDescriptor
-from aspyx.di import injectable, Providers, ClassInstanceProvider, Environment, PostProcessor
-
+from aspyx.di import injectable, order, Providers, ClassInstanceProvider, Environment, PostProcessor
 
 class AOPException(Exception):
     """
@@ -27,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.
@@ -100,7 +99,7 @@ class AspectTarget(ABC):
 
      # fluent
 
-    def function(self, func):
+    def function(self, func) -> AspectTarget:
         self._function = func
         return self
 
@@ -109,30 +108,72 @@ class AspectTarget(ABC):
 
         return self
 
-    def that_are_async(self):
+    def that_are_async(self) -> AspectTarget:
+        """
+        matches methods that are async
+
+        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
+
+        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
+
+        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
 
 class ClassAspectTarget(AspectTarget):
+    """
+    An AspectTarget matching classes
+    """
     # properties
 
     __slots__ = [
@@ -172,6 +213,10 @@ class ClassAspectTarget(AspectTarget):
     # fluent
 
 class MethodAspectTarget(AspectTarget):
+    """
+       An AspectTarget matching methods
+       """
+
     # properties
 
     __slots__ = [ ]
@@ -185,9 +230,6 @@ class MethodAspectTarget(AspectTarget):
 
         # async
 
-        name = method_descriptor.method.__name__
-        is_async = method_descriptor.is_async()
-
         if self._async is not method_descriptor.is_async():
             return False
 
@@ -219,27 +261,33 @@ 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()
 
 
-class JoinPoint:
+class Aspect:
     __slots__ = [
         "next",
     ]
 
     # constructor
 
-    def __init__(self, next: 'JoinPoint'):
+    def __init__(self, next: 'Aspect'):
         self.next = next
 
     # public
@@ -250,55 +298,58 @@ class JoinPoint:
     async def call_async(self, invocation: 'Invocation'):
         pass
 
-class FunctionJoinPoint(JoinPoint):
+class FunctionAspect(Aspect):
     __slots__ = [
         "instance",
         "func",
+        "order",
     ]
 
-    def __init__(self, instance, func, next: Optional['JoinPoint']):
-        super().__init__(next)
+    def __init__(self, instance, func, next_aspect: Optional['Aspect']):
+        super().__init__(next_aspect)
 
         self.instance = instance
         self.func = func
 
+        self.order = next((decorator.args[0] for decorator in Decorators.get(func) if decorator.decorator is order), 0)
+
     def call(self, invocation: 'Invocation'):
-        invocation.current_join_point = self
+        invocation.current_aspect = self
 
         return self.func(self.instance, invocation)
 
     async def call_async(self, invocation: 'Invocation'):
-        invocation.current_join_point = self
+        invocation.current_aspect = self
 
         return await self.func(self.instance, invocation)
 
-class MethodJoinPoint(FunctionJoinPoint):
+class MethodAspect(FunctionAspect):
     __slots__ = []
 
     def __init__(self, instance, func):
         super().__init__(instance, func, None)
 
     def call(self, invocation: 'Invocation'):
-        invocation.current_join_point = self
+        invocation.current_aspect = self
 
         return self.func(*invocation.args, **invocation.kwargs)
 
     async def call_async(self, invocation: 'Invocation'):
-        invocation.current_join_point = self
+        invocation.current_aspect = self
 
         return await self.func(*invocation.args, **invocation.kwargs)
 
 @dataclass
-class JoinPoints:
-    before: list[JoinPoint]
-    around: list[JoinPoint]
-    error: list[JoinPoint]
-    after: list[JoinPoint]
+class Aspects:
+    before: list[Aspect]
+    around: list[Aspect]
+    error: list[Aspect]
+    after: list[Aspect]
 
 class Invocation:
     """
     Invocation stores the relevant data of a single method invocation.
-    It holds the arguments, keyword arguments, result, error, and the join points that define the aspect behavior.
+    It holds the arguments, keyword arguments, result, error, and the aspects that define the aspect behavior.
     """
     # properties
 
@@ -308,20 +359,20 @@ class Invocation:
         "kwargs",
         "result",
         "exception",
-        "join_points",
-        "current_join_point",
+        "aspects",
+        "current_aspect",
     ]
 
     # constructor
 
-    def __init__(self, func, join_points: JoinPoints):
+    def __init__(self, func, aspects: Aspects):
         self.func = func
         self.args : list[object] = []
         self.kwargs = None
         self.result = None
         self.exception = None
-        self.join_points = join_points
-        self.current_join_point = None
+        self.aspects = aspects
+        self.current_aspect = None
 
     def call(self, *args, **kwargs):
         # remember args
@@ -331,23 +382,23 @@ class Invocation:
 
         # run all before
 
-        for join_point in self.join_points.before:
-            join_point.call(self)
+        for aspect in self.aspects.before:
+            aspect.call(self)
 
         # run around's with the method being the last aspect!
 
         try:
-            self.result = self.join_points.around[0].call(self) # will follow the proceed chain
+            self.result = self.aspects.around[0].call(self) # will follow the proceed chain
 
         except Exception as e:
             self.exception = e
-            for join_point in self.join_points.error:
-                join_point.call(self)
+            for aspect in self.aspects.error:
+                aspect.call(self)
 
         # run all before
 
-        for join_point in self.join_points.after:
-            join_point.call(self)
+        for aspect in self.aspects.after:
+            aspect.call(self)
 
         if self.exception is not None:
             raise self.exception # rethrow the error
@@ -362,23 +413,23 @@ class Invocation:
 
         # run all before
 
-        for join_point in self.join_points.before:
-            join_point.call(self)
+        for aspect in self.aspects.before:
+            aspect.call(self)
 
         # run around's with the method being the last aspect!
 
         try:
-            self.result = await self.join_points.around[0].call_async(self) # will follow the proceed chain
+            self.result = await self.aspects.around[0].call_async(self) # will follow the proceed chain
 
         except Exception as e:
             self.exception = e
-            for join_point in self.join_points.error:
-                join_point.call(self)
+            for aspect in self.aspects.error:
+                aspect.call(self)
 
         # run all before
 
-        for join_point in self.join_points.after:
-            join_point.call(self)
+        for aspect in self.aspects.after:
+            aspect.call(self)
 
         if self.exception is not None:
             raise self.exception # rethrow the error
@@ -387,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
@@ -395,11 +446,11 @@ class Invocation:
 
         # next one please...
 
-        return self.current_join_point.next.call(self)
+        return self.current_aspect.next.call(self)
 
     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
@@ -407,29 +458,38 @@ class Invocation:
 
         # next one please...
 
-        return await self.current_join_point.next.call_async(self)
+        return await self.current_aspect.next.call_async(self)
 
-@injectable()
-class Advice:
+class Advices:
+    """
+    Internal utility class that collects all advice s
+    """
     # static data
 
     targets: list[AspectTarget] = []
 
-    __slots__ = [
-        "cache",
-        "lock"
-    ]
+    __slots__ = []
 
     # constructor
 
     def __init__(self):
-        self.cache : Dict[Type, Dict[Callable,JoinPoints]] = {}
-        self.lock = threading.RLock()
+        pass
 
     # methods
 
-    def collect(self, clazz, member, type: AspectType, environment: Environment):
-        aspects = [FunctionJoinPoint(environment.get(target._clazz), target._function, None) for target in Advice.targets if target._type == type and target._matches(clazz, member)]
+    @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)
+        ]
+
+        # sort according to order
+
+        aspects = sorted(aspects, key=lambda aspect: aspect.order)
 
         # link
 
@@ -440,31 +500,23 @@ class Advice:
 
         return aspects
 
-    def join_points4(self, instance, environment: Environment) -> Dict[Callable,JoinPoints]:
+    @classmethod
+    def aspects_for(cls, instance, environment: Environment) -> Dict[Callable,Aspects]:
         clazz = type(instance)
 
-        result = self.cache.get(clazz, None)
-        if result is None:
-            with self.lock:
-                result = self.cache.get(clazz, None)
-
-                if result is None:
-                    result = {}
-                    self.cache[clazz] = result
-
-                    for _, member in inspect.getmembers(clazz, predicate=inspect.isfunction):
-                        join_points = self.compute_join_points(clazz, member, environment)
-                        if join_points is not None:
-                            result[member] = join_points
-
+        result = {}
 
+        for _, member in inspect.getmembers(clazz, predicate=inspect.isfunction):
+            aspects = cls.compute_aspects(clazz, member, environment)
+            if aspects is not None:
+                result[member] = aspects
 
         # add around methods
 
         value = {}
 
         for key, cjp in result.items():
-            jp = JoinPoints(
+            jp = Aspects(
                 before=cjp.before,
                 around=cjp.around,
                 error=cjp.error,
@@ -472,7 +524,7 @@ class Advice:
 
             # add method to around
 
-            jp.around.append(MethodJoinPoint(instance, key))
+            jp.around.append(MethodAspect(instance, key))
             if len(jp.around) > 1:
                 jp.around[len(jp.around) - 2].next = jp.around[len(jp.around) - 1]
 
@@ -482,14 +534,15 @@ class Advice:
 
         return value
 
-    def compute_join_points(self, clazz, member, environment: Environment) -> Optional[JoinPoints]:
-        befores = self.collect(clazz, member, AspectType.BEFORE, environment)
-        arounds = self.collect(clazz, member, AspectType.AROUND, environment)
-        afters = self.collect(clazz, member, AspectType.AFTER, environment)
-        errors = self.collect(clazz, member, AspectType.ERROR, environment)
+    @classmethod
+    def compute_aspects(cls, clazz, member, environment: Environment) -> Optional[Aspects]:
+        befores = cls.collect(clazz, member, AspectType.BEFORE, environment)
+        arounds = cls.collect(clazz, member, AspectType.AROUND, environment)
+        afters = cls.collect(clazz, member, AspectType.AFTER, environment)
+        errors = cls.collect(clazz, member, AspectType.ERROR, environment)
 
         if len(befores) > 0 or len(arounds) > 0 or len(afters) > 0  or len(errors) > 0:
-            return JoinPoints(
+            return Aspects(
                 before=befores,
                 around=arounds,
                 error=errors,
@@ -507,8 +560,8 @@ def sanity_check(clazz: Type, name: str):
 
 def advice(cls):
     """
-    Classes decorated with @advice are treated as aspect 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))
 
@@ -517,10 +570,10 @@ 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]
+            target = decorator.args[0] # multiple targets are already merged in a single! check _register
             target._clazz = cls
             sanity_check(cls, name)
-            Advice.targets.append(target)
+            Advices.targets.append(target) #??
 
     return cls
 
@@ -539,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)
@@ -550,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)
 
@@ -560,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)
@@ -571,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.
     """
@@ -582,28 +635,42 @@ def around(*targets: AspectTarget):
 
     return decorator
 
-@injectable()
+@injectable(scope="environment")
 @order(0)
 class AdviceProcessor(PostProcessor):
     # properties
 
     __slots__ = [
-        "advice",
+        "lock",
+        "cache"
     ]
 
     # constructor
 
-    def __init__(self, advice: Advice):
+    def __init__(self):
         super().__init__()
 
-        self.advice = advice
+        self.cache : Dict[Type, Dict[Callable,Aspects]] = {}
+        self.lock = threading.RLock()
+
+    # local
+
+    def aspects_for(self, instance, environment: Environment) -> Dict[Callable,Aspects]:
+        clazz = type(instance)
+        result = self.cache.get(clazz, None)
+        if result is None:
+            with self.lock:
+                result = Advices.aspects_for(instance, environment)
+                self.cache[clazz] = result # TOID der cache ist zu dick?????
+
+        return result
 
     # implement
 
     def process(self, instance: object, environment: Environment):
-        join_point_dict = self.advice.join_points4(instance, environment)
+        aspect_dict = self.aspects_for(instance, environment)
 
-        for member, join_points in join_point_dict.items():
+        for member, aspects in aspect_dict.items():
             Environment.logger.debug("add aspects for %s:%s", type(instance), member.__name__)
 
             def wrap(jp):
@@ -619,6 +686,6 @@ class AdviceProcessor(PostProcessor):
                 return async_wrapper
 
             if inspect.iscoroutinefunction(member):
-                setattr(instance, member.__name__, types.MethodType(wrap_async(join_points), instance))
+                setattr(instance, member.__name__, types.MethodType(wrap_async(aspects), instance))
             else:
-                setattr(instance, member.__name__, types.MethodType(wrap(join_points), instance))
+                setattr(instance, member.__name__, types.MethodType(wrap(aspects), instance))

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"
 ]