tasq-client-python 0.1.16__py3-none-any.whl → 0.1.18__py3-none-any.whl

tasq_client/client.py

@@ -6,13 +6,15 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from queue import Empty, Queue
 from threading import Thread
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Callable, Dict, Generator, List, Literal, Optional, Tuple
 
 import requests
 from requests.adapters import HTTPAdapter, Retry
 
 from .check_type import CheckTypeException, OptionalKey, OptionalValue, check_type
 
+ExceptionBehavior = Literal["fail", "expire", "ignore"]
+
 
 @dataclass
 class Task:
@@ -31,11 +33,15 @@ class QueueCounts:
     expired: int
     completed: int
 
+    # This is a newer field, so legacy servers will not return it.
+    failed: int = 0
+
     # Won't be set if a time window wasn't specified in the request, or if the
     # server is old enough to not support rate estimation.
     rate: Optional[float] = None
 
     modtime: Optional[int] = None
+    bytes: Optional[int] = None
 
 
 class TasqClient:
@@ -93,7 +99,7 @@ class TasqClient:
         full, in which case None is returned.
         """
         return self._post_form(
-            f"/task/push", dict(contents=contents, limit=limit), type_template=OptionalValue(str)
+            "/task/push", dict(contents=contents, limit=limit), type_template=OptionalValue(str)
         )
 
     def push_batch(self, ids: List[str], limit: int = 0) -> Optional[List[str]]:
@@ -130,12 +136,12 @@ class TasqClient:
         Unlike push_batch(), the ids returned by this method will never be
         None, since all tasks must be pushed.
         """
-        assert isinstance(
-            contents, (list, tuple)
-        ), f"expected a list of task contents, got object of type {type(contents)}"
-        assert (
-            init_wait_time <= self.max_timeout
-        ), f"wait time {init_wait_time=} should not be larger than {self.max_timeout=}"
+        assert isinstance(contents, (list, tuple)), (
+            f"expected a list of task contents, got object of type {type(contents)}"
+        )
+        assert init_wait_time <= self.max_timeout, (
+            f"wait time {init_wait_time=} should not be larger than {self.max_timeout=}"
+        )
         assert limit < 0 or limit >= len(contents)
 
         cur_wait = init_wait_time
@@ -225,8 +231,18 @@ class TasqClient:
         """Reset the timeout interval for a still in-progress task."""
         self._post_form("/task/keepalive", dict(id=id), supports_timeout=True)
 
+    def expire(self, id: str):
+        """Mark the given task as expired."""
+        self._post_form("/task/expire", dict(id=id))
+
+    def failed(self, id: str):
+        """Mark the given task as failed."""
+        self._post_form("/task/failed", dict(id=id))
+
     @contextmanager
-    def pop_running_task(self) -> Optional["RunningTask"]:
+    def pop_running_task(
+        self, on_exception: ExceptionBehavior = "ignore"
+    ) -> Generator[Optional["RunningTask"], None, None]:
         """
         Pop a task from the queue and wrap it in a RunningTask, blocking until
         the queue is completely empty or a task is successfully popped.
@@ -237,6 +253,11 @@ class TasqClient:
         This is meant to be used in a `with` clause. When the `with` clause is
         exited, the keepalive loop is stopped, and the task will be marked as
         completed unless the with clause is exited with an exception.
+
+        In the case of an exception, the on_exception behavior determines what
+        is done with the task. Optionally, the task can be marked as expired or
+        failed; by default, the task will be left in the running state until
+        its timeout expires.
         """
         while True:
             task, timeout = self.pop()
@@ -244,9 +265,16 @@ class TasqClient:
                 rt = RunningTask(self, id=task.id, contents=task.contents)
                 try:
                     yield rt
+                except:
+                    if on_exception == "fail":
+                        rt.failed()
+                    elif on_exception == "expire":
+                        rt.expire()
+                    else:
+                        rt.cancel()
+                    raise
+                else:
                     rt.completed()
-                finally:
-                    rt.cancel()
                 return
             elif timeout is not None:
                 time.sleep(min(timeout, self.max_timeout))
@@ -257,13 +285,16 @@ class TasqClient:
     def counts(self, rate_window: int = 0) -> QueueCounts:
         """Get the number of tasks in each state within the queue."""
         data = self._get(
-            f"/counts?window={rate_window}&includeModtime=1",
+            f"/counts?window={rate_window}&includeModtime=1&includeBytes=1",
             {
                 "pending": int,
                 "running": int,
                 "expired": int,
                 "completed": int,
+                OptionalKey("failed"): int,
                 OptionalKey("minute_rate"): float,
+                OptionalKey("modtime"): int,
+                OptionalKey("bytes"): int,
             },
         )
         return QueueCounts(**data)
@@ -361,6 +392,7 @@ class RunningTask(Task):
             daemon=True,
         )
         self._thread.start()
+        self._sent_final_status = False
 
     def cancel(self):
         if self._thread is None:
@@ -370,8 +402,20 @@ class RunningTask(Task):
         self._thread = None
 
     def completed(self):
+        self._send_status(self.client.completed)
+
+    def failed(self):
+        self._send_status(self.client.failed)
+
+    def expire(self):
+        self._send_status(self.client.expire)
+
+    def _send_status(self, fn: Callable[[str], None]):
+        if self._sent_final_status:
+            return
         self.cancel()
-        self.client.completed(self.id)
+        fn(self.id)
+        self._sent_final_status = True
 
     @staticmethod
     def _keepalive_worker(

tasq_client_python-0.1.18.dist-info/METADATA

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: tasq-client-python
+Version: 0.1.18
+Requires-Dist: requests
+Dynamic: requires-dist

tasq_client_python-0.1.18.dist-info/RECORD

@@ -0,0 +1,8 @@
+tasq_client/__init__.py,sha256=I0ik-_c0hcVKUgx7QsE3YnoCQyAVMFKKOzoLt-jNFtE,277
+tasq_client/check_type.py,sha256=t_jreI8rf6QWS9Jf105ZvUVbwFe-uL4rMg4kZk6e4cA,2795
+tasq_client/check_type_test.py,sha256=bvhVaO-Bu18aI3J4Kxnb0H27fzDCKkTHVBWhjJMFMis,1433
+tasq_client/client.py,sha256=3og7zL7TkGmAYIDzt-fyrNfovvghiJL8Iy_TCsiad0w,16730
+tasq_client_python-0.1.18.dist-info/METADATA,sha256=5w7-axKtRfNu28vjLIyRFGCG-r04ABxMBSnvGdtpZjU,110
+tasq_client_python-0.1.18.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+tasq_client_python-0.1.18.dist-info/top_level.txt,sha256=JUs_FTRfs_ggMu8zusU5CSXgAl-JHhrjMXxuZay-B58,12
+tasq_client_python-0.1.18.dist-info/RECORD,,

{tasq_client_python-0.1.16.dist-info → tasq_client_python-0.1.18.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tasq_client_python-0.1.16.dist-info/METADATA

@@ -1,11 +0,0 @@
-Metadata-Version: 2.1
-Name: tasq-client-python
-Version: 0.1.16
-Summary: UNKNOWN
-Home-page: UNKNOWN
-License: UNKNOWN
-Platform: UNKNOWN
-Requires-Dist: requests
-
-UNKNOWN
-

tasq_client_python-0.1.16.dist-info/RECORD

@@ -1,8 +0,0 @@
-tasq_client/__init__.py,sha256=I0ik-_c0hcVKUgx7QsE3YnoCQyAVMFKKOzoLt-jNFtE,277
-tasq_client/check_type.py,sha256=t_jreI8rf6QWS9Jf105ZvUVbwFe-uL4rMg4kZk6e4cA,2795
-tasq_client/check_type_test.py,sha256=bvhVaO-Bu18aI3J4Kxnb0H27fzDCKkTHVBWhjJMFMis,1433
-tasq_client/client.py,sha256=1f-BBYaiILfziZfzW3J4HOGwAgRbU80pbmlPX2J9wQE,15162
-tasq_client_python-0.1.16.dist-info/METADATA,sha256=Y5auv-WWFODNhED09_NvXXNcVvyq6GDUYGvlzWf-Tx8,168
-tasq_client_python-0.1.16.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
-tasq_client_python-0.1.16.dist-info/top_level.txt,sha256=JUs_FTRfs_ggMu8zusU5CSXgAl-JHhrjMXxuZay-B58,12
-tasq_client_python-0.1.16.dist-info/RECORD,,