Add TaskLogger dependency

src/docket/__init__.py

@@ -8,7 +8,14 @@
 
 __version__ = version("pydocket")
 
-from .dependencies import CurrentDocket, CurrentExecution, CurrentWorker, Retry, TaskKey
+from .dependencies import (
+    CurrentDocket,
+    CurrentExecution,
+    CurrentWorker,
+    Retry,
+    TaskKey,
+    TaskLogger,
+)
 from .docket import Docket
 from .execution import Execution
 from .worker import Worker
@@ -21,6 +28,7 @@
     "CurrentWorker",
     "CurrentExecution",
     "TaskKey",
+    "TaskLogger",
     "Retry",
     "__version__",
 ]

src/docket/dependencies.py

@@ -1,5 +1,6 @@
 import abc
 import inspect
+import logging
 from datetime import timedelta
 from typing import Any, Awaitable, Callable, Counter, cast
 
@@ -55,6 +56,26 @@ def TaskKey() -> str:
     return cast(str, _TaskKey())
 
 
+class _TaskLogger(Dependency):
+    def __call__(
+        self, docket: Docket, worker: Worker, execution: Execution
+    ) -> logging.LoggerAdapter:
+        logger = logging.getLogger(f"docket.task.{execution.key}")
+
+        extra = {
+            "task.key": execution.key,
+            "task.attempt": execution.attempt,
+            "worker.name": worker.name,
+            "docket.name": docket.name,
+        }
+
+        return logging.LoggerAdapter(logger, extra)
+
+
+def TaskLogger() -> logging.LoggerAdapter[logging.Logger]:
+    return cast(logging.LoggerAdapter[logging.Logger], _TaskLogger())
+
+
 class Retry(Dependency):
     single: bool = True
 

tests/test_fundamentals.py

@@ -5,7 +5,9 @@
 as possible to aid with understanding docket.
 """
 
+import logging
 from datetime import datetime, timedelta
+from logging import LoggerAdapter
 from typing import Callable
 from unittest.mock import AsyncMock
 from uuid import uuid4
@@ -20,6 +22,7 @@
     Execution,
     Retry,
     TaskKey,
+    TaskLogger,
     Worker,
 )
 
@@ -390,3 +393,32 @@ async def the_task(a: str, b: str, this_key: str = TaskKey()):
     await worker.run_until_current()
 
     assert called
+
+
+async def test_logging_inside_of_task(
+    docket: Docket,
+    worker: Worker,
+    now: Callable[[], datetime],
+    caplog: pytest.LogCaptureFixture,
+):
+    """docket should support providing a logger with task context"""
+    called = False
+
+    async def the_task(a: str, b: str, logger: LoggerAdapter = TaskLogger()):
+        assert a == "a"
+        assert b == "c"
+
+        logger.info("Task is running")
+
+        nonlocal called
+        called = True
+
+    await docket.add(the_task, key="my-cool-task:123")("a", b="c")
+
+    with caplog.at_level(logging.INFO):
+        await worker.run_until_current()
+
+    assert called
+    assert "Task is running" in caplog.text
+    assert "docket.task.my-cool-task:123" in caplog.text
+    print(caplog.text)