pydocket 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

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,
@@ -51,6 +51,7 @@ from .instrumentation import (
     TASKS_STARTED,
     TASKS_STRICKEN,
     TASKS_SUCCEEDED,
+    healthcheck_server,
     metrics_server,
 )
 
@@ -65,6 +66,18 @@ class _stream_due_tasks(Protocol):
 
 
 class Worker:
+    """A Worker executes tasks on a Docket.  You may run as many workers as you like
+    to work a single Docket.
+
+    Example:
+
+    ```python
+    async with Docket() as docket:
+        async with Worker(docket) as worker:
+            await worker.run_forever()
+    ```
+    """
+
     docket: Docket
     name: str
     concurrency: int
@@ -86,7 +99,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
@@ -140,10 +153,14 @@ class Worker:
         scheduling_resolution: timedelta = timedelta(milliseconds=250),
         schedule_automatic_tasks: bool = True,
         until_finished: bool = False,
+        healthcheck_port: int | None = None,
         metrics_port: int | None = None,
         tasks: list[str] = ["docket.tasks:standard_tasks"],
     ) -> None:
-        with metrics_server(port=metrics_port):
+        with (
+            healthcheck_server(port=healthcheck_port),
+            metrics_server(port=metrics_port),
+        ):
             async with Docket(name=docket_name, url=url) as docket:
                 for task_path in tasks:
                     docket.register_collection(task_path)
@@ -205,10 +222,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 +520,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 +532,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 +584,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 +681,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.4.dist-info/METADATA

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: pydocket
+Version: 0.6.4
+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
+Author-email: Chris Guidry <guid@omg.lol>
+License: # Released under MIT License
+        
+        Copyright (c) 2025 Chris Guidry.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: cloudpickle>=3.1.1
+Requires-Dist: opentelemetry-api>=1.30.0
+Requires-Dist: opentelemetry-exporter-prometheus>=0.51b0
+Requires-Dist: prometheus-client>=0.21.1
+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
+on the scheduling of future work as seamlessly and efficiently as immediate work.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pydocket)](https://pypi.org/project/pydocket/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydocket)](https://pypi.org/project/pydocket/)
+[![GitHub main checks](https://img.shields.io/github/check-runs/chrisguidry/docket/main)](https://github.com/chrisguidry/docket/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/chrisguidry/docket)](https://app.codecov.io/gh/chrisguidry/docket)
+[![PyPI - License](https://img.shields.io/pypi/l/pydocket)](https://github.com/chrisguidry/docket/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://chrisguidry.github.io/docket/)
+
+## At a glance
+
+```python
+from datetime import datetime, timedelta, timezone
+
+from docket import Docket
+
+
+async def greet(name: str, greeting="Hello") -> None:
+    print(f"{greeting}, {name} at {datetime.now()}!")
+
+
+async with Docket() as docket:
+    await docket.add(greet)("Jane")
+
+    now = datetime.now(timezone.utc)
+    soon = now + timedelta(seconds=3)
+    await docket.add(greet, when=soon)("John", greeting="Howdy")
+```
+
+```python
+from docket import Docket, Worker
+
+async with Docket() as docket:
+    async with Worker(docket) as worker:
+        await worker.run_until_finished()
+```
+
+```
+Hello, Jane at 2025-03-05 13:58:21.552644!
+Howdy, John at 2025-03-05 13:58:24.550773!
+```
+
+Check out our docs for more [details](http://chrisguidry.github.io/docket/),
+[examples](https://chrisguidry.github.io/docket/getting-started/), and the [API
+reference](https://chrisguidry.github.io/docket/api-reference/).
+
+## Why `docket`?
+
+⚡️ Snappy one-way background task processing without any bloat
+
+📅 Schedule immediate or future work seamlessly with the same interface
+
+⏭️ Skip problematic tasks or parameters without redeploying
+
+🌊 Purpose-built for Redis streams
+
+🧩 Fully type-complete and type-aware for your background task functions
+
+## Installing `docket`
+
+Docket is [available on PyPI](https://pypi.org/project/pydocket/) under the package name
+`pydocket`. It targets Python 3.12 or above.
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install pydocket
+
+or
+
+uv add pydocket
+```
+
+With `pip`:
+
+```bash
+pip install pydocket
+```
+
+Docket requires a [Redis](http://redis.io/) server with Streams support (which was
+introduced in Redis 5.0.0). Docket is tested with Redis 6 and 7.
+
+# Hacking on `docket`
+
+We use [`uv`](https://docs.astral.sh/uv/) for project management, so getting set up
+should be as simple as cloning the repo and running:
+
+```bash
+uv sync
+```
+
+The to run the test suite:
+
+```bash
+pytest
+```
+
+We aim to maintain 100% test coverage, which is required for all PRs to `docket`. We
+believe that `docket` should stay small, simple, understandable, and reliable, and that
+begins with testing all the dusty branches and corners. This will give us the
+confidence to upgrade dependencies quickly and to adapt to new versions of Redis over
+time.

pydocket-0.6.4.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=SFBrOMbpAh7P67u8fRTH-u3MVvJQxe0qYi92WAShAsw,2173
+docket/cli.py,sha256=WPm_URZ54h8gHjrsHKP8SXpRzdeepmyH_FhQHai-Qus,20899
+docket/dependencies.py,sha256=_31Fgn6A_4aWn5TJpXdbsPtimBVIPabNJkw49RRLJTc,16441
+docket/docket.py,sha256=5e101CGLZ2tWNcADo4cdewapmXab47ieMCeQr6d92YQ,24478
+docket/execution.py,sha256=6KozjnS96byvyCMTQ2-IkcIrPsqaPIVu2HZU0U4Be9E,14813
+docket/instrumentation.py,sha256=f-GG5VS6EdS2It30qxjVpzWUBOZQcTnat-3KzPwwDgQ,5367
+docket/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docket/tasks.py,sha256=RIlSM2omh-YDwVnCz6M5MtmK8T_m_s1w2OlRRxDUs6A,1437
+docket/worker.py,sha256=tJfk2rlHODzHaWBzpBXT8h-Lo7RDQ6gb6HU8b3T9gFA,27878
+pydocket-0.6.4.dist-info/METADATA,sha256=R3ODtTRkrNkplBvC5-8pVsRjSLSfYKYHKXqZCT9Qr-w,5335
+pydocket-0.6.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pydocket-0.6.4.dist-info/entry_points.txt,sha256=4WOk1nUlBsUT5O3RyMci2ImuC5XFswuopElYcLHtD5k,47
+pydocket-0.6.4.dist-info/licenses/LICENSE,sha256=YuVWU_ZXO0K_k2FG8xWKe5RGxV24AhJKTvQmKfqXuyk,1087
+pydocket-0.6.4.dist-info/RECORD,,