pydocket 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

docket/__init__.py

@@ -14,6 +14,7 @@ from .dependencies import (
     CurrentExecution,
     CurrentWorker,
     ExponentialRetry,
+    Perpetual,
     Retry,
     TaskKey,
     TaskLogger,
@@ -34,5 +35,6 @@ __all__ = [
     "Retry",
     "ExponentialRetry",
     "Logged",
+    "Perpetual",
     "__version__",
 ]

docket/dependencies.py

@@ -126,6 +126,34 @@ class ExponentialRetry(Retry):
         return retry
 
 
+class Perpetual(Dependency):
+    single = True
+
+    every: timedelta
+    args: tuple[Any, ...]
+    kwargs: dict[str, Any]
+    cancelled: bool
+
+    def __init__(self, every: timedelta = timedelta(0)) -> None:
+        self.every = every
+        self.cancelled = False
+
+    def __call__(
+        self, docket: Docket, worker: Worker, execution: Execution
+    ) -> "Perpetual":
+        perpetual = Perpetual(every=self.every)
+        perpetual.args = execution.args
+        perpetual.kwargs = execution.kwargs
+        return perpetual
+
+    def cancel(self) -> None:
+        self.cancelled = True
+
+    def perpetuate(self, *args: Any, **kwargs: Any) -> None:
+        self.args = args
+        self.kwargs = kwargs
+
+
 def get_dependency_parameters(
     function: Callable[..., Awaitable[Any]],
 ) -> dict[str, Dependency]:

docket/instrumentation.py

@@ -70,6 +70,12 @@ TASKS_RETRIED = meter.create_counter(
     unit="1",
 )
 
+TASKS_PERPETUATED = meter.create_counter(
+    "docket_tasks_perpetuated",
+    description="How many tasks that have been self-perpetuated",
+    unit="1",
+)
+
 TASK_DURATION = meter.create_histogram(
     "docket_task_duration",
     description="How long tasks take to complete",

docket/worker.py

@@ -7,6 +7,7 @@ from types import TracebackType
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Mapping,
     Protocol,
     Self,
@@ -35,6 +36,7 @@ from .instrumentation import (
     TASK_PUNCTUALITY,
     TASKS_COMPLETED,
     TASKS_FAILED,
+    TASKS_PERPETUATED,
     TASKS_RETRIED,
     TASKS_RUNNING,
     TASKS_STARTED,
@@ -63,6 +65,11 @@ class _stream_due_tasks(Protocol):
 class Worker:
     docket: Docket
     name: str
+    concurrency: int
+    redelivery_timeout: timedelta
+    reconnection_delay: timedelta
+    minimum_check_interval: timedelta
+    _strike_conditions: list[Callable[[Execution], bool]] = []
 
     def __init__(
         self,
@@ -80,6 +87,10 @@ class Worker:
         self.reconnection_delay = reconnection_delay
         self.minimum_check_interval = minimum_check_interval
 
+        self._strike_conditions = [
+            docket.strike_list.is_stricken,
+        ]
+
     async def __aenter__(self) -> Self:
         self._heartbeat_task = asyncio.create_task(self._heartbeat())
 
@@ -151,6 +162,35 @@ class Worker:
         """Run the worker indefinitely."""
         return await self._run(forever=True)  # pragma: no cover
 
+    async def run_at_most(self, iterations_by_key: Mapping[str, int]) -> None:
+        """
+        Run the worker until there are no more tasks to process, but limit specified
+        task keys to a maximum number of iterations.
+
+        This is particularly useful for testing self-perpetuating tasks that would
+        otherwise run indefinitely.
+
+        Args:
+            iterations_by_key: Maps task keys to their maximum allowed executions
+        """
+        execution_counts: dict[str, int] = {key: 0 for key in iterations_by_key}
+
+        def has_reached_max_iterations(execution: Execution) -> bool:
+            if execution.key not in iterations_by_key:
+                return False
+
+            if execution_counts[execution.key] >= iterations_by_key[execution.key]:
+                return True
+
+            execution_counts[execution.key] += 1
+            return False
+
+        self._strike_conditions.insert(0, has_reached_max_iterations)
+        try:
+            await self.run_until_finished()
+        finally:
+            self._strike_conditions.remove(has_reached_max_iterations)
+
     async def _run(self, forever: bool = False) -> None:
         logger.info("Starting worker %r with the following tasks:", self.name)
         for task_name, task in self.docket.tasks.items():
@@ -322,7 +362,7 @@ class Worker:
                     await process_completed_tasks()
 
     async def _execute(self, message: RedisMessage) -> None:
-        log_context: dict[str, str | float] = self._log_context()
+        log_context: Mapping[str, str | float] = self._log_context()
 
         function_name = message[b"function"].decode()
         function = self.docket.tasks.get(function_name)
@@ -334,13 +374,13 @@ class Worker:
 
         execution = Execution.from_message(function, message)
 
-        log_context |= execution.specific_labels()
+        log_context = {**log_context, **execution.specific_labels()}
         counter_labels = {**self.labels(), **execution.general_labels()}
 
         arrow = "↬" if execution.attempt > 1 else "↪"
         call = execution.call_repr()
 
-        if self.docket.strike_list.is_stricken(execution):
+        if any(condition(execution) for condition in self._strike_conditions):
             arrow = "🗙"
             logger.warning("%s %s", arrow, call, extra=log_context)
             TASKS_STRICKEN.add(1, counter_labels | {"docket.where": "worker"})
@@ -354,7 +394,7 @@ class Worker:
 
         start = datetime.now(timezone.utc)
         punctuality = start - execution.when
-        log_context["punctuality"] = punctuality.total_seconds()
+        log_context = {**log_context, "punctuality": punctuality.total_seconds()}
         duration = timedelta(0)
 
         TASKS_STARTED.add(1, counter_labels)
@@ -385,12 +425,20 @@ class Worker:
             TASKS_SUCCEEDED.add(1, counter_labels)
             duration = datetime.now(timezone.utc) - start
             log_context["duration"] = duration.total_seconds()
-            logger.info("%s [%s] %s", "↩", duration, call, extra=log_context)
+            rescheduled = await self._perpetuate_if_requested(
+                execution, dependencies, duration
+            )
+            arrow = "↫" if rescheduled else "↩"
+            logger.info("%s [%s] %s", arrow, duration, call, extra=log_context)
         except Exception:
             TASKS_FAILED.add(1, counter_labels)
             duration = datetime.now(timezone.utc) - start
             log_context["duration"] = duration.total_seconds()
             retried = await self._retry_if_requested(execution, dependencies)
+            if not retried:
+                retried = await self._perpetuate_if_requested(
+                    execution, dependencies, duration
+                )
             arrow = "↫" if retried else "↩"
             logger.exception("%s [%s] %s", arrow, duration, call, extra=log_context)
         finally:
@@ -442,6 +490,34 @@ class Worker:
 
         return False
 
+    async def _perpetuate_if_requested(
+        self, execution: Execution, dependencies: dict[str, Any], duration: timedelta
+    ) -> bool:
+        from .dependencies import Perpetual
+
+        perpetuals = [
+            perpetual
+            for perpetual in dependencies.values()
+            if isinstance(perpetual, Perpetual)
+        ]
+        if not perpetuals:
+            return False
+
+        perpetual = perpetuals[0]
+
+        if perpetual.cancelled:
+            return False
+
+        now = datetime.now(timezone.utc)
+        execution.when = max(now, now + perpetual.every - duration)
+        execution.args = perpetual.args
+        execution.kwargs = perpetual.kwargs
+
+        await self.docket.schedule(execution)
+
+        TASKS_PERPETUATED.add(1, {**self.labels(), **execution.specific_labels()})
+        return True
+
     @property
     def workers_set(self) -> str:
         return self.docket.workers_set

{pydocket-0.2.0.dist-info → pydocket-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocket
-Version: 0.2.0
+Version: 0.3.0
 Summary: A distributed background task system for Python functions
 Project-URL: Homepage, https://github.com/chrisguidry/docket
 Project-URL: Bug Tracker, https://github.com/chrisguidry/docket/issues

pydocket-0.3.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+docket/__init__.py,sha256=7oruGALDoU6W_ntF-mMxxv3FFtO970DVzj3lUgoVIiM,775
+docket/__main__.py,sha256=Vkuh7aJ-Bl7QVpVbbkUksAd_hn05FiLmWbc-8kbhZQ4,34
+docket/annotations.py,sha256=GZwOPtPXyeIhnsLh3TQMBnXrjtTtSmF4Ratv4vjPx8U,950
+docket/cli.py,sha256=EseF0Sj7IEgd9QDC-FSbHSffvF7DNsrmDGYGgZBdJc8,19413
+docket/dependencies.py,sha256=S3KqXxEF0Q2t_jO3R-kI5IIA3M-tqybtiSod2xnRO4o,4991
+docket/docket.py,sha256=zva6ofTm7i5hRwAaAnNtlgIqoMPaNLqCTs2PXGka_8s,19723
+docket/execution.py,sha256=ShP8MoLmxEslk2pAuhKi6KEEKbHdneyQukR9oQwXdjQ,11732
+docket/instrumentation.py,sha256=bZlGA02JoJcY0J1WGm5_qXDfY0AXKr0ZLAYu67wkeKY,4611
+docket/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docket/tasks.py,sha256=RIlSM2omh-YDwVnCz6M5MtmK8T_m_s1w2OlRRxDUs6A,1437
+docket/worker.py,sha256=A0jfi6f2QZ2OA5z9rVvEcstSiIAQPrxaJmKkFBHH48g,21752
+pydocket-0.3.0.dist-info/METADATA,sha256=O6NoNE03rUVEMokkKArLaH6_sXhnrx-kWTnVBN8h5Ak,13092
+pydocket-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pydocket-0.3.0.dist-info/entry_points.txt,sha256=4WOk1nUlBsUT5O3RyMci2ImuC5XFswuopElYcLHtD5k,47
+pydocket-0.3.0.dist-info/licenses/LICENSE,sha256=YuVWU_ZXO0K_k2FG8xWKe5RGxV24AhJKTvQmKfqXuyk,1087
+pydocket-0.3.0.dist-info/RECORD,,

pydocket-0.2.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-docket/__init__.py,sha256=GoJYpyuO6QFeBB8GNaxGGvMMuai55Eaw_8u-o1PM3hk,743
-docket/__main__.py,sha256=Vkuh7aJ-Bl7QVpVbbkUksAd_hn05FiLmWbc-8kbhZQ4,34
-docket/annotations.py,sha256=GZwOPtPXyeIhnsLh3TQMBnXrjtTtSmF4Ratv4vjPx8U,950
-docket/cli.py,sha256=EseF0Sj7IEgd9QDC-FSbHSffvF7DNsrmDGYGgZBdJc8,19413
-docket/dependencies.py,sha256=gIDwcBUhrLk7xGh0ZxdqpsnSeX-hZzGMNvUrVFfqbJI,4281
-docket/docket.py,sha256=zva6ofTm7i5hRwAaAnNtlgIqoMPaNLqCTs2PXGka_8s,19723
-docket/execution.py,sha256=ShP8MoLmxEslk2pAuhKi6KEEKbHdneyQukR9oQwXdjQ,11732
-docket/instrumentation.py,sha256=SUVhVFf8AX2HAfmi0HPTT_QvQezlGPJEKs_1YAmrCbA,4454
-docket/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-docket/tasks.py,sha256=RIlSM2omh-YDwVnCz6M5MtmK8T_m_s1w2OlRRxDUs6A,1437
-docket/worker.py,sha256=UZIPfAsIhsBsr2tBCgGGkLKU1mJs_nnP8-Retwl3218,19104
-pydocket-0.2.0.dist-info/METADATA,sha256=X8Yqvi_cqCqYaGu6ZGr4dMvxqcvy6otYvt-J2jwCHOs,13092
-pydocket-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pydocket-0.2.0.dist-info/entry_points.txt,sha256=4WOk1nUlBsUT5O3RyMci2ImuC5XFswuopElYcLHtD5k,47
-pydocket-0.2.0.dist-info/licenses/LICENSE,sha256=YuVWU_ZXO0K_k2FG8xWKe5RGxV24AhJKTvQmKfqXuyk,1087
-pydocket-0.2.0.dist-info/RECORD,,