pydocket 0.6.1__tar.gz → 0.6.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocket
-Version: 0.6.1
+Version: 0.6.2
 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.6.1 → pydocket-0.6.2}/pyproject.toml

@@ -64,6 +64,9 @@ source = "vcs"
 [tool.hatch.build.targets.wheel]
 packages = ["src/docket"]
 
+[tool.ruff]
+target-version = "py312"
+
 [tool.pytest.ini_options]
 addopts = [
     "--numprocesses=logical",

{pydocket-0.6.1 → pydocket-0.6.2}/src/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",
 ]

{pydocket-0.6.1 → pydocket-0.6.2}/src/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,

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

@@ -79,6 +79,22 @@ def TaskKey() -> str:
     return cast(str, _TaskKey())
 
 
+class _TaskArgument(Dependency):
+    parameter: str | None
+
+    def __init__(self, parameter: str | None = None) -> None:
+        self.parameter = parameter
+
+    async def __aenter__(self) -> Any:
+        assert self.parameter is not None
+        execution = self.execution.get()
+        return execution.get_argument(self.parameter)
+
+
+def TaskArgument(parameter: str | None = None) -> Any:
+    return cast(Any, _TaskArgument(parameter))
+
+
 class _TaskLogger(Dependency):
     async def __aenter__(self) -> logging.LoggerAdapter[logging.Logger]:
         execution = self.execution.get()
@@ -275,6 +291,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 +359,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 +388,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

{pydocket-0.6.1 → pydocket-0.6.2}/src/docket/execution.py

@@ -83,6 +83,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__

{pydocket-0.6.1 → pydocket-0.6.2}/src/docket/worker.py

@@ -22,6 +22,7 @@ from docket.execution import get_signature
 
 from .dependencies import (
     Dependency,
+    FailedDependency,
     Perpetual,
     Retry,
     Timeout,
@@ -71,6 +72,7 @@ class Worker:
     reconnection_delay: timedelta
     minimum_check_interval: timedelta
     scheduling_resolution: timedelta
+    schedule_automatic_tasks: bool
 
     def __init__(
         self,
@@ -81,6 +83,7 @@ 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()}"
@@ -89,6 +92,7 @@ class Worker:
         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()
@@ -220,7 +226,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)
@@ -520,6 +527,23 @@ class Worker:
                         await self._delete_known_task(redis, execution)
 
                 try:
+                    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()
+                            ],
+                        )
+
                     if timeout := get_single_dependency_of_type(dependencies, Timeout):
                         await self._run_function_with_timeout(
                             execution, dependencies, timeout

{pydocket-0.6.1 → pydocket-0.6.2}/tests/test_dependencies.py

@@ -1,7 +1,9 @@
+import logging
+
 import pytest
 
 from docket import CurrentDocket, CurrentWorker, Docket, Worker
-from docket.dependencies import Retry
+from docket.dependencies import Depends, Retry, TaskArgument
 
 
 async def test_dependencies_may_be_duplicated(docket: Docket, worker: Worker):
@@ -91,3 +93,48 @@ async def test_user_provide_retries_are_used(docket: Docket, worker: Worker):
     await worker.run_until_finished()
 
     assert calls == 2
+
+
+async def test_dependencies_error_for_missing_task_argument(
+    docket: Docket, worker: Worker, caplog: pytest.LogCaptureFixture
+):
+    """A task will fail when asking for a missing task argument"""
+
+    async def dependency_one(nope: list[str] = TaskArgument()) -> list[str]:
+        raise NotImplementedError("This should not be called")  # pragma: no cover
+
+    async def dependent_task(
+        a: list[str],
+        b: list[str] = TaskArgument("a"),
+        c: list[str] = Depends(dependency_one),
+    ) -> None:
+        raise NotImplementedError("This should not be called")  # pragma: no cover
+
+    await docket.add(dependent_task)(a=["hello", "world"])
+
+    await worker.run_until_finished()
+
+    with caplog.at_level(logging.ERROR):
+        await worker.run_until_finished()
+
+    assert "Failed to resolve dependencies for parameter(s): c" in caplog.text
+    assert "ExceptionGroup" in caplog.text
+    assert "KeyError: 'nope'" in caplog.text
+
+
+async def test_a_task_argument_cannot_ask_for_itself(
+    docket: Docket, worker: Worker, caplog: pytest.LogCaptureFixture
+):
+    """A task argument cannot ask for itself"""
+
+    # This task would be nonsense, because it's asking for itself.
+    async def dependent_task(a: list[str] = TaskArgument()) -> None:
+        raise NotImplementedError("This should not be called")  # pragma: no cover
+
+    await docket.add(dependent_task)()
+
+    with caplog.at_level(logging.ERROR):
+        await worker.run_until_finished()
+
+    assert "Failed to resolve dependencies for parameter(s): a" in caplog.text
+    assert "ValueError: No parameter name specified" in caplog.text

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

@@ -27,6 +27,7 @@ from docket import (
     Logged,
     Perpetual,
     Retry,
+    TaskArgument,
     TaskKey,
     TaskLogger,
     Timeout,
@@ -1383,3 +1384,66 @@ async def test_dependencies_can_ask_for_docket_dependencies(
     await docket.add(dependent_task)()
 
     await worker.run_until_finished()
+
+
+async def test_dependency_failures_are_task_failures(
+    docket: Docket, worker: Worker, caplog: pytest.LogCaptureFixture
+):
+    """A task dependency failure will cause the task to fail"""
+
+    called: bool = False
+
+    async def dependency_one() -> str:
+        raise ValueError("this one is bad")
+
+    async def dependency_two() -> str:
+        raise ValueError("and so is this one")
+
+    async def dependent_task(
+        a: str = Depends(dependency_one),
+        b: str = Depends(dependency_two),
+    ) -> None:
+        nonlocal called
+        called = True  # 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, b" in caplog.text
+    assert "ValueError: this one is bad" in caplog.text
+    assert "ValueError: and so is this one" 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"""
+
+    called = 0
+
+    async def dependency_one(a: list[str] = TaskArgument()) -> list[str]:
+        return a
+
+    async def dependency_two(another_name: list[str] = TaskArgument("a")) -> list[str]:
+        return another_name
+
+    async def dependent_task(
+        a: list[str],
+        b: list[str] = TaskArgument("a"),
+        c: list[str] = Depends(dependency_one),
+        d: list[str] = Depends(dependency_two),
+    ) -> None:
+        assert a is b
+        assert a is c
+        assert a is d
+
+        nonlocal called
+        called += 1
+
+    await docket.add(dependent_task)(a=["hello", "world"])
+
+    await worker.run_until_finished()
+
+    assert called == 1

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

@@ -491,3 +491,25 @@ def test_formatting_durations():
     assert ms(1000.000) == "  1000s "
     assert ms(10000.00) == " 10000s "
     assert ms(100000.0) == "100000s "
+
+
+async def test_worker_can_be_told_to_skip_automatic_tasks(docket: Docket):
+    """A worker can be told to skip automatic tasks"""
+
+    called = False
+
+    async def perpetual_task(
+        perpetual: Perpetual = Perpetual(
+            every=timedelta(milliseconds=50), automatic=True
+        ),
+    ):
+        nonlocal called
+        called = True  # pragma: no cover
+
+    docket.register(perpetual_task)
+
+    # Without the flag, this would hang because the task would always be scheduled
+    async with Worker(docket, schedule_automatic_tasks=False) as worker:
+        await worker.run_until_finished()
+
+    assert not called