Rename to invocation_context_managers (#150)

This commit renames context_managers to invocation_context_managers to better reflect that the lifetime of the context manager is bound to an invocation (attempt)

Author: igalshilman

python/restate/context_managers.py

@@ -57,7 +57,9 @@ def value(self) -> T:
         """Return the value yielded by the wrapped context manager."""
         val = self._value_var.get()
         if val is None:
-            raise LookupError("Context manager value accessed outside of context manager scope (has not been entered yet)")
+            raise LookupError(
+                "Context manager value accessed outside of context manager scope (has not been entered yet)"
+            )
         return val
 
     def __call__(self, *args: P.args, **kwargs: P.kwargs) -> AsyncContextManager[None]:

python/restate/object.py

@@ -87,7 +87,9 @@ def __init__(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ):
         self.service_tag = ServiceTag("object", name, description, metadata)
         self.handlers = {}
@@ -98,7 +100,7 @@ def __init__(
         self.enable_lazy_state = enable_lazy_state
         self.ingress_private = ingress_private
         self.invocation_retry_policy = invocation_retry_policy
-        self.context_managers = context_managers
+        self.context_managers = invocation_context_managers
 
     @property
     def name(self):
@@ -124,7 +126,9 @@ def handler(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> typing.Callable[[T], T]:
         """
         Decorator for defining a handler function.
@@ -188,8 +192,8 @@ def wrapped(*args, **kwargs):
 
             signature = inspect.signature(fn, eval_str=True)
             combined_context_managers = (
-                (self.context_managers or []) + (context_managers or [])
-                if self.context_managers or context_managers
+                (self.context_managers or []) + (invocation_context_managers or [])
+                if self.context_managers or invocation_context_managers
                 else None
             )
             handler = make_handler(

python/restate/service.py

@@ -68,6 +68,7 @@ class Service:
             NOTE: You can set this field only if you register this service against restate-server >= 1.4,
             otherwise the service discovery will fail.
         invocation_retry_policy (InvocationRetryPolicy, optional): Retry policy applied for all invocations to this service.
+        invocation_context_managers (List[Callable[[], AsyncContextManager[None]]], optional): List of context manager factories that will be applied to each invocation of this service.
     """
 
     def __init__(
@@ -81,7 +82,9 @@ def __init__(
         idempotency_retention: typing.Optional[timedelta] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> None:
         self.service_tag = ServiceTag("service", name, description, metadata)
         self.handlers: typing.Dict[str, Handler] = {}
@@ -91,7 +94,7 @@ def __init__(
         self.idempotency_retention = idempotency_retention
         self.ingress_private = ingress_private
         self.invocation_retry_policy = invocation_retry_policy
-        self.context_managers = context_managers
+        self.context_managers = invocation_context_managers
 
     @property
     def name(self):
@@ -114,7 +117,9 @@ def handler(
         idempotency_retention: typing.Optional[timedelta] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> typing.Callable[[T], T]:
         """
         Decorator for defining a handler function.
@@ -152,6 +157,7 @@ def handler(
                 NOTE: You can set this field only if you register this service against restate-server >= 1.4,
                 otherwise the service discovery will fail.
             invocation_retry_policy (InvocationRetryPolicy, optional): Retry policy applied for all invocations to this handler.
+            invocation_context_managers: List of context manager factories that will be applied to each invocation of this handler.
 
         Returns:
             Callable: The decorated function.
@@ -176,8 +182,8 @@ def wrapped(*args, **kwargs):
 
             # combine context managers or leave None if both are None
             combined_context_managers = (
-                (self.context_managers or []) + (context_managers or [])
-                if self.context_managers or context_managers
+                (self.context_managers or []) + (invocation_context_managers or [])
+                if self.context_managers or invocation_context_managers
                 else None
             )
 

python/restate/workflow.py

@@ -76,6 +76,7 @@ class Workflow:
             NOTE: You can set this field only if you register this service against restate-server >= 1.4,
             otherwise the service discovery will fail.
         invocation_retry_policy (InvocationRetryPolicy, optional): Retry policy applied for all invocations to this workflow.
+        invocation_context_managers (List[Callable[[], AsyncContextManager[None]]], optional): List of context manager factories that will be applied to each invocation of this workflow.
     """
 
     handlers: typing.Dict[str, Handler[typing.Any, typing.Any]]
@@ -92,7 +93,9 @@ def __init__(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ):
         self.service_tag = ServiceTag("workflow", name, description, metadata)
         self.handlers = {}
@@ -103,7 +106,7 @@ def __init__(
         self.enable_lazy_state = enable_lazy_state
         self.ingress_private = ingress_private
         self.invocation_retry_policy = invocation_retry_policy
-        self.context_managers = context_managers
+        self.context_managers = invocation_context_managers
 
     @property
     def name(self):
@@ -127,7 +130,9 @@ def main(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> typing.Callable[[T], T]:
         """
         Mark this handler as a workflow entry point.
@@ -185,7 +190,7 @@ def main(
             enable_lazy_state=enable_lazy_state,
             ingress_private=ingress_private,
             invocation_retry_policy=invocation_retry_policy,
-            context_managers=context_managers,
+            invocation_context_managers=invocation_context_managers,
         )
 
     def handler(
@@ -203,7 +208,9 @@ def handler(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional[InvocationRetryPolicy] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> typing.Callable[[T], T]:
         """
         Decorator for defining a handler function.
@@ -244,6 +251,7 @@ def handler(
                 NOTE: You can set this field only if you register this service against restate-server >= 1.4,
                 otherwise the service discovery will fail.
             invocation_retry_policy (InvocationRetryPolicy, optional): Retry policy applied for all invocations to this handler.
+            invocation_context_managers (List[Callable[[], AsyncContextManager[None]]], optional): List of context manager factories that will be applied to each invocation of this handler.
         """
         return self._add_handler(
             name,
@@ -261,7 +269,7 @@ def handler(
             enable_lazy_state,
             ingress_private,
             invocation_retry_policy,
-            context_managers,
+            invocation_context_managers,
         )
 
     # pylint: disable=R0914
@@ -282,7 +290,9 @@ def _add_handler(
         enable_lazy_state: typing.Optional[bool] = None,
         ingress_private: typing.Optional[bool] = None,
         invocation_retry_policy: typing.Optional["InvocationRetryPolicy"] = None,
-        context_managers: typing.Optional[typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]] = None,
+        invocation_context_managers: typing.Optional[
+            typing.List[typing.Callable[[], typing.AsyncContextManager[None]]]
+        ] = None,
     ) -> typing.Callable[[T], T]:
         """
         Decorator for defining a handler function.
@@ -350,8 +360,8 @@ def wrapped(*args, **kwargs):
             signature = inspect.signature(fn, eval_str=True)
             description = inspect.getdoc(fn)
             combined_context_managers = (
-                (self.context_managers or []) + (context_managers or [])
-                if self.context_managers or context_managers
+                (self.context_managers or []) + (invocation_context_managers or [])
+                if self.context_managers or invocation_context_managers
                 else None
             )
             handler = make_handler(

tests/ext.py

@@ -55,7 +55,7 @@ async def my_resource_manager():
     yield "hello"
 
 
-@greeter.handler(context_managers=[my_resource_manager])
+@greeter.handler(invocation_context_managers=[my_resource_manager])
 async def greet_with_cm(ctx: Context, name: str) -> str:
     return my_resource_manager.value