pydocket 0.6.1__py3-none-any.whl → 0.6.3__py3-none-any.whl

docket/__init__.py

@@ -17,6 +17,7 @@ from .dependencies import (
     ExponentialRetry,
     Perpetual,
     Retry,
+    TaskArgument,
     TaskKey,
     TaskLogger,
     Timeout,
@@ -26,19 +27,20 @@ from .execution import Execution
 from .worker import Worker
 
 __all__ = [
-    "Docket",
-    "Worker",
-    "Execution",
+    "__version__",
     "CurrentDocket",
-    "CurrentWorker",
     "CurrentExecution",
-    "TaskKey",
-    "TaskLogger",
-    "Retry",
+    "CurrentWorker",
+    "Depends",
+    "Docket",
+    "Execution",
     "ExponentialRetry",
     "Logged",
     "Perpetual",
+    "Retry",
+    "TaskArgument",
+    "TaskKey",
+    "TaskLogger",
     "Timeout",
-    "Depends",
-    "__version__",
+    "Worker",
 ]

docket/__main__.py

@@ -1,3 +1,3 @@
-from docket.cli import app
+from .cli import app
 
 app()

docket/cli.py

@@ -245,6 +245,13 @@ def worker(
             envvar="DOCKET_WORKER_SCHEDULING_RESOLUTION",
         ),
     ] = timedelta(milliseconds=250),
+    schedule_automatic_tasks: Annotated[
+        bool,
+        typer.Option(
+            "--schedule-automatic-tasks",
+            help="Schedule automatic tasks",
+        ),
+    ] = True,
     until_finished: Annotated[
         bool,
         typer.Option(
@@ -270,6 +277,7 @@ def worker(
             reconnection_delay=reconnection_delay,
             minimum_check_interval=minimum_check_interval,
             scheduling_resolution=scheduling_resolution,
+            schedule_automatic_tasks=schedule_automatic_tasks,
             until_finished=until_finished,
             metrics_port=metrics_port,
             tasks=tasks,

docket/dependencies.py

@@ -79,6 +79,29 @@ def TaskKey() -> str:
     return cast(str, _TaskKey())
 
 
+class _TaskArgument(Dependency):
+    parameter: str | None
+    optional: bool
+
+    def __init__(self, parameter: str | None = None, optional: bool = False) -> None:
+        self.parameter = parameter
+        self.optional = optional
+
+    async def __aenter__(self) -> Any:
+        assert self.parameter is not None
+        execution = self.execution.get()
+        try:
+            return execution.get_argument(self.parameter)
+        except KeyError:
+            if self.optional:
+                return None
+            raise
+
+
+def TaskArgument(parameter: str | None = None, optional: bool = False) -> Any:
+    return cast(Any, _TaskArgument(parameter, optional))
+
+
 class _TaskLogger(Dependency):
     async def __aenter__(self) -> logging.LoggerAdapter[logging.Logger]:
         execution = self.execution.get()
@@ -275,6 +298,11 @@ class _Depends(Dependency, Generic[R]):
         parameters = get_dependency_parameters(function)
 
         for parameter, dependency in parameters.items():
+            # Special case for TaskArguments, they are "magical" and infer the parameter
+            # they refer to from the parameter name (unless otherwise specified)
+            if isinstance(dependency, _TaskArgument) and not dependency.parameter:
+                dependency.parameter = parameter
+
             arguments[parameter] = await stack.enter_async_context(dependency)
 
         return arguments
@@ -338,6 +366,12 @@ def validate_dependencies(function: TaskFunction) -> None:
             )
 
 
+class FailedDependency:
+    def __init__(self, parameter: str, error: Exception) -> None:
+        self.parameter = parameter
+        self.error = error
+
+
 @asynccontextmanager
 async def resolved_dependencies(
     worker: "Worker", execution: Execution
@@ -361,6 +395,19 @@ async def resolved_dependencies(
                 arguments[parameter] = kwargs[parameter]
                 continue
 
-            arguments[parameter] = await stack.enter_async_context(dependency)
+            # Special case for TaskArguments, they are "magical" and infer the parameter
+            # they refer to from the parameter name (unless otherwise specified).  At
+            # the top-level task function call, it doesn't make sense to specify one
+            # _without_ a parameter name, so we'll call that a failed dependency.
+            if isinstance(dependency, _TaskArgument) and not dependency.parameter:
+                arguments[parameter] = FailedDependency(
+                    parameter, ValueError("No parameter name specified")
+                )
+                continue
+
+            try:
+                arguments[parameter] = await stack.enter_async_context(dependency)
+            except Exception as error:
+                arguments[parameter] = FailedDependency(parameter, error)
 
         yield arguments

docket/docket.py

@@ -23,12 +23,12 @@ from typing import (
     cast,
     overload,
 )
-from uuid import uuid4
 
 import redis.exceptions
 from opentelemetry import propagate, trace
 from redis.asyncio import ConnectionPool, Redis
 from redis.asyncio.client import Pipeline
+from uuid_extensions import uuid7
 
 from .execution import (
     Execution,
@@ -254,7 +254,7 @@ class Docket:
             when = datetime.now(timezone.utc)
 
         if key is None:
-            key = f"{function.__name__}:{uuid4()}"
+            key = str(uuid7())
 
         async def scheduler(*args: P.args, **kwargs: P.kwargs) -> Execution:
             execution = Execution(function, args, kwargs, when, key, attempt=1)

docket/execution.py

@@ -3,15 +3,23 @@ import enum
 import inspect
 import logging
 from datetime import datetime
-from typing import Any, Awaitable, Callable, Hashable, Literal, Mapping, Self, cast
+from typing import (
+    Any,
+    Awaitable,
+    Callable,
+    Hashable,
+    Literal,
+    Mapping,
+    Self,
+    cast,
+)
 
 import cloudpickle  # type: ignore[import]
-
-from opentelemetry import trace, propagate
 import opentelemetry.context
+from opentelemetry import propagate, trace
 
 from .annotations import Logged
-from docket.instrumentation import message_getter
+from .instrumentation import message_getter
 
 logger: logging.Logger = logging.getLogger(__name__)
 
@@ -83,6 +91,11 @@ class Execution:
             "docket.attempt": self.attempt,
         }
 
+    def get_argument(self, parameter: str) -> Any:
+        signature = get_signature(self.function)
+        bound_args = signature.bind(*self.args, **self.kwargs)
+        return bound_args.arguments[parameter]
+
     def call_repr(self) -> str:
         arguments: list[str] = []
         function_name = self.function.__name__
@@ -112,6 +125,37 @@ class Execution:
         return [trace.Link(initiating_context)] if initiating_context.is_valid else []
 
 
+def compact_signature(signature: inspect.Signature) -> str:
+    from .dependencies import Dependency
+
+    parameters: list[str] = []
+    dependencies: int = 0
+
+    for parameter in signature.parameters.values():
+        if isinstance(parameter.default, Dependency):
+            dependencies += 1
+            continue
+
+        parameter_definition = parameter.name
+        if parameter.annotation is not parameter.empty:
+            annotation = parameter.annotation
+            if hasattr(annotation, "__origin__"):
+                annotation = annotation.__args__[0]
+
+            type_name = getattr(annotation, "__name__", str(annotation))
+            parameter_definition = f"{parameter.name}: {type_name}"
+
+        if parameter.default is not parameter.empty:
+            parameter_definition = f"{parameter_definition} = {parameter.default!r}"
+
+        parameters.append(parameter_definition)
+
+    if dependencies > 0:
+        parameters.append("...")
+
+    return ", ".join(parameters)
+
+
 class Operator(enum.StrEnum):
     EQUAL = "=="
     NOT_EQUAL = "!="

docket/worker.py

@@ -1,5 +1,7 @@
 import asyncio
 import logging
+import os
+import socket
 import sys
 import time
 from datetime import datetime, timedelta, timezone
@@ -11,17 +13,15 @@ from typing import (
     Self,
     cast,
 )
-from uuid import uuid4
 
 from opentelemetry import trace
 from opentelemetry.trace import Tracer
 from redis.asyncio import Redis
 from redis.exceptions import ConnectionError, LockError
 
-from docket.execution import get_signature
-
 from .dependencies import (
     Dependency,
+    FailedDependency,
     Perpetual,
     Retry,
     Timeout,
@@ -36,6 +36,7 @@ from .docket import (
     RedisMessageID,
     RedisReadGroupResponse,
 )
+from .execution import compact_signature, get_signature
 from .instrumentation import (
     QUEUE_DEPTH,
     REDIS_DISRUPTIONS,
@@ -71,6 +72,7 @@ class Worker:
     reconnection_delay: timedelta
     minimum_check_interval: timedelta
     scheduling_resolution: timedelta
+    schedule_automatic_tasks: bool
 
     def __init__(
         self,
@@ -81,14 +83,16 @@ class Worker:
         reconnection_delay: timedelta = timedelta(seconds=5),
         minimum_check_interval: timedelta = timedelta(milliseconds=250),
         scheduling_resolution: timedelta = timedelta(milliseconds=250),
+        schedule_automatic_tasks: bool = True,
     ) -> None:
         self.docket = docket
-        self.name = name or f"worker:{uuid4()}"
+        self.name = name or f"{socket.gethostname()}#{os.getpid()}"
         self.concurrency = concurrency
         self.redelivery_timeout = redelivery_timeout
         self.reconnection_delay = reconnection_delay
         self.minimum_check_interval = minimum_check_interval
         self.scheduling_resolution = scheduling_resolution
+        self.schedule_automatic_tasks = schedule_automatic_tasks
 
     async def __aenter__(self) -> Self:
         self._heartbeat_task = asyncio.create_task(self._heartbeat())
@@ -134,6 +138,7 @@ class Worker:
         reconnection_delay: timedelta = timedelta(seconds=5),
         minimum_check_interval: timedelta = timedelta(milliseconds=100),
         scheduling_resolution: timedelta = timedelta(milliseconds=250),
+        schedule_automatic_tasks: bool = True,
         until_finished: bool = False,
         metrics_port: int | None = None,
         tasks: list[str] = ["docket.tasks:standard_tasks"],
@@ -151,6 +156,7 @@ class Worker:
                     reconnection_delay=reconnection_delay,
                     minimum_check_interval=minimum_check_interval,
                     scheduling_resolution=scheduling_resolution,
+                    schedule_automatic_tasks=schedule_automatic_tasks,
                 ) as worker:
                     if until_finished:
                         await worker.run_until_finished()
@@ -199,10 +205,7 @@ class Worker:
             self._execution_counts = {}
 
     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():
-            signature = get_signature(task)
-            logger.info("* %s%s", task_name, signature)
+        self._startup_log()
 
         while True:
             try:
@@ -220,7 +223,8 @@ class Worker:
     async def _worker_loop(self, redis: Redis, forever: bool = False):
         worker_stopping = asyncio.Event()
 
-        await self._schedule_all_automatic_perpetual_tasks()
+        if self.schedule_automatic_tasks:
+            await self._schedule_all_automatic_perpetual_tasks()
 
         scheduler_task = asyncio.create_task(
             self._scheduler_loop(redis, worker_stopping)
@@ -499,6 +503,8 @@ class Worker:
         arrow = "↬" if execution.attempt > 1 else "↪"
         logger.info("%s [%s] %s", arrow, ms(punctuality), call, extra=log_context)
 
+        dependencies: dict[str, Dependency] = {}
+
         with tracer.start_as_current_span(
             execution.function.__name__,
             kind=trace.SpanKind.CONSUMER,
@@ -509,17 +515,34 @@ class Worker:
             },
             links=execution.incoming_span_links(),
         ):
-            async with resolved_dependencies(self, execution) as dependencies:
-                # Preemptively reschedule the perpetual task for the future, or clear
-                # the known task key for this task
-                rescheduled = await self._perpetuate_if_requested(
-                    execution, dependencies
-                )
-                if not rescheduled:
-                    async with self.docket.redis() as redis:
-                        await self._delete_known_task(redis, execution)
+            try:
+                async with resolved_dependencies(self, execution) as dependencies:
+                    # Preemptively reschedule the perpetual task for the future, or clear
+                    # the known task key for this task
+                    rescheduled = await self._perpetuate_if_requested(
+                        execution, dependencies
+                    )
+                    if not rescheduled:
+                        async with self.docket.redis() as redis:
+                            await self._delete_known_task(redis, execution)
+
+                    dependency_failures = {
+                        k: v
+                        for k, v in dependencies.items()
+                        if isinstance(v, FailedDependency)
+                    }
+                    if dependency_failures:
+                        raise ExceptionGroup(
+                            (
+                                "Failed to resolve dependencies for parameter(s): "
+                                + ", ".join(dependency_failures.keys())
+                            ),
+                            [
+                                dependency.error
+                                for dependency in dependency_failures.values()
+                            ],
+                        )
 
-                try:
                     if timeout := get_single_dependency_of_type(dependencies, Timeout):
                         await self._run_function_with_timeout(
                             execution, dependencies, timeout
@@ -544,24 +567,24 @@ class Worker:
                     logger.info(
                         "%s [%s] %s", arrow, ms(duration), call, extra=log_context
                     )
-                except Exception:
-                    duration = log_context["duration"] = time.time() - start
-                    TASKS_FAILED.add(1, counter_labels)
-
-                    retried = await self._retry_if_requested(execution, dependencies)
-                    if not retried:
-                        retried = await self._perpetuate_if_requested(
-                            execution, dependencies, timedelta(seconds=duration)
-                        )
+            except Exception:
+                duration = log_context["duration"] = time.time() - start
+                TASKS_FAILED.add(1, counter_labels)
 
-                    arrow = "↫" if retried else "↩"
-                    logger.exception(
-                        "%s [%s] %s", arrow, ms(duration), call, extra=log_context
+                retried = await self._retry_if_requested(execution, dependencies)
+                if not retried:
+                    retried = await self._perpetuate_if_requested(
+                        execution, dependencies, timedelta(seconds=duration)
                     )
-                finally:
-                    TASKS_RUNNING.add(-1, counter_labels)
-                    TASKS_COMPLETED.add(1, counter_labels)
-                    TASK_DURATION.record(duration, counter_labels)
+
+                arrow = "↫" if retried else "↩"
+                logger.exception(
+                    "%s [%s] %s", arrow, ms(duration), call, extra=log_context
+                )
+            finally:
+                TASKS_RUNNING.add(-1, counter_labels)
+                TASKS_COMPLETED.add(1, counter_labels)
+                TASK_DURATION.record(duration, counter_labels)
 
     async def _run_function_with_timeout(
         self,
@@ -641,6 +664,11 @@ class Worker:
 
         return True
 
+    def _startup_log(self) -> None:
+        logger.info("Starting worker %r with the following tasks:", self.name)
+        for task_name, task in self.docket.tasks.items():
+            logger.info("* %s(%s)", task_name, compact_signature(get_signature(task)))
+
     @property
     def workers_set(self) -> str:
         return self.docket.workers_set

{pydocket-0.6.1.dist-info → pydocket-0.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocket
-Version: 0.6.1
+Version: 0.6.3
 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
@@ -31,6 +31,7 @@ Requires-Dist: python-json-logger>=3.2.1
 Requires-Dist: redis>=4.6
 Requires-Dist: rich>=13.9.4
 Requires-Dist: typer>=0.15.1
+Requires-Dist: uuid7>=0.1.0
 Description-Content-Type: text/markdown
 
 Docket is a distributed background task system for Python functions with a focus

pydocket-0.6.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+docket/__init__.py,sha256=sY1T_NVsXQNOmOhOnfYmZ95dcE_52Ov6DSIVIMZp-1w,869
+docket/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
+docket/annotations.py,sha256=6sCgQxsgOjBN6ithFdXulXq4CPNSdyFocwyJ1gK9v2Q,1688
+docket/cli.py,sha256=znHN7eqaD_PFpSFn7iXa_uZlKzVWDrKkrmOd1CNuZRk,20561
+docket/dependencies.py,sha256=-gruEho5jf07Jx9fEh2YBFg4gDSJFm7X5qhQjArVXjU,11910
+docket/docket.py,sha256=r5TNcGmaQuxST56OVKNjFXDsrU5-Ioz3Y_I38PkLqRM,21411
+docket/execution.py,sha256=6KozjnS96byvyCMTQ2-IkcIrPsqaPIVu2HZU0U4Be9E,14813
+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=Xf6_7GyrIUNq1jG8YjbJk5KkRQdvxs0CniF9XW8kdJg,27450
+pydocket-0.6.3.dist-info/METADATA,sha256=LRtykRFP2dcauKjzQDoNpC_xe6aVjvleAN1xS5cSIUY,13120
+pydocket-0.6.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pydocket-0.6.3.dist-info/entry_points.txt,sha256=4WOk1nUlBsUT5O3RyMci2ImuC5XFswuopElYcLHtD5k,47
+pydocket-0.6.3.dist-info/licenses/LICENSE,sha256=YuVWU_ZXO0K_k2FG8xWKe5RGxV24AhJKTvQmKfqXuyk,1087
+pydocket-0.6.3.dist-info/RECORD,,

pydocket-0.6.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-docket/__init__.py,sha256=124XWbyQQHO1lhCoLQ-oheZnu4vNDHIaq4Whb7z3ogI,831
-docket/__main__.py,sha256=Vkuh7aJ-Bl7QVpVbbkUksAd_hn05FiLmWbc-8kbhZQ4,34
-docket/annotations.py,sha256=6sCgQxsgOjBN6ithFdXulXq4CPNSdyFocwyJ1gK9v2Q,1688
-docket/cli.py,sha256=OWql6QFthSbvRCGkIg-ufo26F48z0eCmzRXJYOdyAEc,20309
-docket/dependencies.py,sha256=pkjseBZjdSpgW9g2H4cZ_RXIRZ2ZfdngBCXJGUcbmao,10052
-docket/docket.py,sha256=KJxgiyOskEHsRQOmfgLpJCYDNNleHI-vEKK3uBPL_K8,21420
-docket/execution.py,sha256=f3LLt9bC7ExEZhgde5OBo1faKLYv-8ryfNLXSswo318,13579
-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=NrzmfpjHjQaGS8CoTOiKM5Bn88tPh_q2hz9f4hFegSk,26280
-pydocket-0.6.1.dist-info/METADATA,sha256=mxI1OHWe9W9bAyi8QiH69eMSsSk1Dm2oDvh301BJFgo,13092
-pydocket-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pydocket-0.6.1.dist-info/entry_points.txt,sha256=4WOk1nUlBsUT5O3RyMci2ImuC5XFswuopElYcLHtD5k,47
-pydocket-0.6.1.dist-info/licenses/LICENSE,sha256=YuVWU_ZXO0K_k2FG8xWKe5RGxV24AhJKTvQmKfqXuyk,1087
-pydocket-0.6.1.dist-info/RECORD,,