pydocket 0.6.2__tar.gz → 0.6.3__tar.gz

{pydocket-0.6.2 → pydocket-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocket
-Version: 0.6.2
+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.2 → pydocket-0.6.3}/examples/common.py

@@ -43,8 +43,6 @@ async def run_example_workers(workers: int, concurrency: int, tasks: str):
             await asyncio.create_subprocess_exec(
                 "docket",
                 "worker",
-                "--name",
-                f"worker-{i}",
                 "--url",
                 redis_url,
                 "--tasks",

{pydocket-0.6.2 → pydocket-0.6.3}/examples/find_and_flood.py

@@ -1,4 +1,5 @@
 import asyncio
+import random
 from datetime import timedelta
 from logging import Logger, LoggerAdapter
 from typing import Annotated
@@ -16,7 +17,7 @@ async def find(
     perpetual: Perpetual = Perpetual(every=timedelta(seconds=3), automatic=True),
 ) -> None:
     for i in range(1, 10 + 1):
-        await docket.add(flood, key=f"item-{i}")(i)
+        await docket.add(flood)(i)
 
 
 async def flood(
@@ -24,6 +25,7 @@ async def flood(
     logger: LoggerAdapter[Logger] = TaskLogger(),
 ) -> None:
     logger.info("Working on %s", item)
+    await asyncio.sleep(random.uniform(0.5, 2))
 
 
 tasks = [find, flood]

pydocket-0.6.3/examples/self_perpetuating.py

@@ -0,0 +1,36 @@
+import asyncio
+import random
+from datetime import datetime, timedelta, timezone
+from logging import Logger, LoggerAdapter
+
+from docket import Docket
+from docket.dependencies import CurrentDocket, Perpetual, TaskLogger
+
+from .common import run_example_workers
+
+
+def now() -> datetime:
+    return datetime.now(timezone.utc)
+
+
+async def bouncey(
+    docket: Docket = CurrentDocket(),
+    logger: LoggerAdapter[Logger] = TaskLogger(),
+    perpetual: Perpetual = Perpetual(every=timedelta(seconds=3), automatic=True),
+) -> None:
+    seconds = random.randint(1, 10)
+    perpetual.every = timedelta(seconds=seconds)
+    logger.info("See you in %s seconds at %s", seconds, now() + perpetual.every)
+
+
+tasks = [bouncey]
+
+
+if __name__ == "__main__":
+    asyncio.run(
+        run_example_workers(
+            workers=3,
+            concurrency=8,
+            tasks="examples.self_perpetuating:tasks",
+        )
+    )

{pydocket-0.6.2 → pydocket-0.6.3}/pyproject.toml

@@ -28,6 +28,7 @@ dependencies = [
     "redis>=4.6",
     "rich>=13.9.4",
     "typer>=0.15.1",
+    "uuid7>=0.1.0",
 ]
 
 [dependency-groups]

pydocket-0.6.3/src/docket/__main__.py

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

{pydocket-0.6.2 → pydocket-0.6.3}/src/docket/dependencies.py

@@ -81,18 +81,25 @@ def TaskKey() -> str:
 
 class _TaskArgument(Dependency):
     parameter: str | None
+    optional: bool
 
-    def __init__(self, parameter: str | None = None) -> None:
+    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()
-        return execution.get_argument(self.parameter)
+        try:
+            return execution.get_argument(self.parameter)
+        except KeyError:
+            if self.optional:
+                return None
+            raise
 
 
-def TaskArgument(parameter: str | None = None) -> Any:
-    return cast(Any, _TaskArgument(parameter))
+def TaskArgument(parameter: str | None = None, optional: bool = False) -> Any:
+    return cast(Any, _TaskArgument(parameter, optional))
 
 
 class _TaskLogger(Dependency):

{pydocket-0.6.2 → pydocket-0.6.3}/src/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)

{pydocket-0.6.2 → pydocket-0.6.3}/src/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__)
 
@@ -117,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 = "!="

{pydocket-0.6.2 → pydocket-0.6.3}/src/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,15 +13,12 @@ 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,
@@ -37,6 +36,7 @@ from .docket import (
     RedisMessageID,
     RedisReadGroupResponse,
 )
+from .execution import compact_signature, get_signature
 from .instrumentation import (
     QUEUE_DEPTH,
     REDIS_DISRUPTIONS,
@@ -86,7 +86,7 @@ class Worker:
         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
@@ -205,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:
@@ -506,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,
@@ -516,17 +515,17 @@ 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)
 
-                try:
                     dependency_failures = {
                         k: v
                         for k, v in dependencies.items()
@@ -568,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,
@@ -665,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.3/tests/test_execution.py

@@ -0,0 +1,63 @@
+from typing import Annotated
+
+import pytest
+
+from docket import Docket, Worker
+from docket.annotations import Logged
+from docket.dependencies import CurrentDocket, CurrentWorker, Depends
+from docket.execution import TaskFunction, compact_signature, get_signature
+
+
+async def no_args() -> None: ...  # pragma: no cover
+
+
+async def one_arg(a: str) -> None: ...  # pragma: no cover
+
+
+async def two_args(a: str, b: str) -> None: ...  # pragma: no cover
+
+
+async def optional_args(a: str, b: str, c: str = "c") -> None: ...  # pragma: no cover
+
+
+async def logged_args(
+    a: Annotated[str, Logged()],
+    b: Annotated[str, Logged()] = "foo",
+) -> None: ...  # pragma: no cover
+
+
+async def a_dependency() -> str: ...  # pragma: no cover
+
+
+async def dependencies(
+    a: str,
+    b: int = 42,
+    c: str = Depends(a_dependency),
+    docket: Docket = CurrentDocket(),
+    worker: Worker = CurrentWorker(),
+) -> None: ...  # pragma: no cover
+
+
+async def only_dependencies(
+    a: str = Depends(a_dependency),
+    docket: Docket = CurrentDocket(),
+    worker: Worker = CurrentWorker(),
+) -> None: ...  # pragma: no cover
+
+
+@pytest.mark.parametrize(
+    "function, expected",
+    [
+        (no_args, ""),
+        (one_arg, "a: str"),
+        (two_args, "a: str, b: str"),
+        (optional_args, "a: str, b: str, c: str = 'c'"),
+        (logged_args, "a: str, b: str = 'foo'"),
+        (dependencies, "a: str, b: int = 42, ..."),
+        (only_dependencies, "..."),
+    ],
+)
+async def test_compact_signature(
+    docket: Docket, worker: Worker, function: TaskFunction, expected: str
+):
+    assert compact_signature(get_signature(function)) == expected

{pydocket-0.6.2 → pydocket-0.6.3}/tests/test_fundamentals.py

@@ -151,10 +151,10 @@ async def test_rescheduling_by_name(
 
     key = f"my-cool-task:{uuid4()}"
 
-    soon = now() + timedelta(milliseconds=10)
+    soon = now() + timedelta(milliseconds=100)
     await docket.add(the_task, soon, key=key)("a", "b", c="c")
 
-    later = now() + timedelta(milliseconds=100)
+    later = now() + timedelta(milliseconds=200)
     await docket.replace("the_task", later, key=key)("b", "c", c="d")
 
     await worker.run_until_finished()
@@ -1418,6 +1418,65 @@ async def test_dependency_failures_are_task_failures(
     assert "ValueError: and so is this one" in caplog.text
 
 
+async def test_contextual_dependency_before_failures_are_task_failures(
+    docket: Docket, worker: Worker, caplog: pytest.LogCaptureFixture
+):
+    """A contextual task dependency failure will cause the task to fail"""
+
+    called: int = 0
+
+    @asynccontextmanager
+    async def dependency_before() -> AsyncGenerator[str, None]:
+        raise ValueError("this one is bad")
+        yield "this won't be used"  # pragma: no cover
+
+    async def dependent_task(
+        a: str = Depends(dependency_before),
+    ) -> None:
+        nonlocal called
+        called += 1  # pragma: no cover
+
+    await docket.add(dependent_task)()
+
+    with caplog.at_level(logging.ERROR):
+        await worker.run_until_finished()
+
+    assert not called
+
+    assert "Failed to resolve dependencies for parameter(s): a" in caplog.text
+    assert "ValueError: this one is bad" in caplog.text
+
+
+async def test_contextual_dependency_after_failures_are_task_failures(
+    docket: Docket, worker: Worker, caplog: pytest.LogCaptureFixture
+):
+    """A contextual task dependency failure will cause the task to fail"""
+
+    called: int = 0
+
+    @asynccontextmanager
+    async def dependency_after() -> AsyncGenerator[str, None]:
+        yield "this will be used"
+        raise ValueError("this one is bad")
+
+    async def dependent_task(
+        a: str = Depends(dependency_after),
+    ) -> None:
+        assert a == "this will be used"
+
+        nonlocal called
+        called += 1
+
+    await docket.add(dependent_task)()
+
+    with caplog.at_level(logging.ERROR):
+        await worker.run_until_finished()
+
+    assert called == 1
+
+    assert "ValueError: this one is bad" in caplog.text
+
+
 async def test_dependencies_can_ask_for_task_arguments(docket: Docket, worker: Worker):
     """A task dependency can ask for a task argument"""
 
@@ -1447,3 +1506,30 @@ async def test_dependencies_can_ask_for_task_arguments(docket: Docket, worker: W
     await worker.run_until_finished()
 
     assert called == 1
+
+
+async def test_task_arguments_may_be_optional(docket: Docket, worker: Worker):
+    """A task dependency can ask for a task argument optionally"""
+
+    called = 0
+
+    async def dependency_one(
+        a: list[str] | None = TaskArgument(optional=True),
+    ) -> list[str] | None:
+        return a
+
+    async def dependent_task(
+        not_a: list[str],
+        b: list[str] | None = Depends(dependency_one),
+    ) -> None:
+        assert not_a == ["hello", "world"]
+        assert b is None
+
+        nonlocal called
+        called += 1
+
+    await docket.add(dependent_task)(not_a=["hello", "world"])
+
+    await worker.run_until_finished()
+
+    assert called == 1

{pydocket-0.6.2 → pydocket-0.6.3}/tests/test_worker.py

@@ -273,14 +273,14 @@ async def test_worker_announcements(
     docket.register(the_task)
     docket.register(another_task)
 
-    async with Worker(docket) as worker_a:
+    async with Worker(docket, name="worker-a") as worker_a:
         await asyncio.sleep(heartbeat.total_seconds() * 5)
 
         workers = await docket.workers()
         assert len(workers) == 1
         assert worker_a.name in {w.name for w in workers}
 
-        async with Worker(docket) as worker_b:
+        async with Worker(docket, name="worker-b") as worker_b:
             await asyncio.sleep(heartbeat.total_seconds() * 5)
 
             workers = await docket.workers()
@@ -315,14 +315,14 @@ async def test_task_announcements(
 
     docket.register(the_task)
     docket.register(another_task)
-    async with Worker(docket) as worker_a:
+    async with Worker(docket, name="worker-a") as worker_a:
         await asyncio.sleep(heartbeat.total_seconds() * 5)
 
         workers = await docket.task_workers("the_task")
         assert len(workers) == 1
         assert worker_a.name in {w.name for w in workers}
 
-        async with Worker(docket) as worker_b:
+        async with Worker(docket, name="worker-b") as worker_b:
             await asyncio.sleep(heartbeat.total_seconds() * 5)
 
             workers = await docket.task_workers("the_task")
@@ -422,13 +422,13 @@ async def test_perpetual_tasks_are_scheduled_close_to_target_time(
     assert len(timestamps) == 8
 
     intervals = [next - previous for previous, next in zip(timestamps, timestamps[1:])]
-    minimum = min(intervals)
+    average = sum(intervals, timedelta(0)) / len(intervals)
 
     debug = ", ".join([f"{i.total_seconds() * 1000:.2f}ms" for i in intervals])
 
     # It's not reliable to assert the maximum duration on different machine setups, but
     # we'll make sure that the minimum is observed (within 5ms), which is the guarantee
-    assert minimum >= timedelta(milliseconds=45), debug
+    assert average >= timedelta(milliseconds=50), debug
 
 
 async def test_worker_can_exit_from_perpetual_tasks_that_queue_further_tasks(

{pydocket-0.6.2 → pydocket-0.6.3}/uv.lock

@@ -723,6 +723,7 @@ dependencies = [
     { name = "redis" },
     { name = "rich" },
     { name = "typer" },
+    { name = "uuid7" },
 ]
 
 [package.dev-dependencies]
@@ -756,6 +757,7 @@ requires-dist = [
     { name = "redis", specifier = ">=4.6" },
     { name = "rich", specifier = ">=13.9.4" },
     { name = "typer", specifier = ">=0.15.1" },
+    { name = "uuid7", specifier = ">=0.1.0" },
 ]
 
 [package.metadata.requires-dev]
@@ -1029,6 +1031,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/c8/19/4ec628951a74043532ca2cf5d97b7b14863931476d117c471e8e2b1eb39f/urllib3-2.3.0-py3-none-any.whl", hash = "sha256:1cee9ad369867bfdbbb48b7dd50374c0967a0bb7710050facf0dd6911440e3df", size = 128369 },
 ]
 
+[[package]]
+name = "uuid7"
+version = "0.1.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/5c/19/7472bd526591e2192926247109dbf78692e709d3e56775792fec877a7720/uuid7-0.1.0.tar.gz", hash = "sha256:8c57aa32ee7456d3cc68c95c4530bc571646defac01895cfc73545449894a63c", size = 14052 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b5/77/8852f89a91453956582a85024d80ad96f30a41fed4c2b3dce0c9f12ecc7e/uuid7-0.1.0-py2.py3-none-any.whl", hash = "sha256:5e259bb63c8cb4aded5927ff41b444a80d0c7124e8a0ced7cf44efa1f5cccf61", size = 7477 },
+]
+
 [[package]]
 name = "virtualenv"
 version = "20.29.2"

pydocket-0.6.2/src/docket/__main__.py

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