Add support for newly added QStash features (#41)

There were lots of new features missing from the client, I have
added support for them.

Also, refactored some leftover parts.

Author: mdumandag

.github/workflows/tests.yml

@@ -40,7 +40,7 @@ jobs:
 
       - name: Run mypy
         run: |
-          poetry run mypy --show-error-codes .
+          poetry run mypy --show-error-codes --strict .
 
       - name: Run tests
         run: |

examples/async_publish.py

@@ -7,7 +7,7 @@
 from qstash import AsyncQStash
 
 
-async def main():
+async def main() -> None:
     client = AsyncQStash(
         token="<QSTASH-TOKEN>",
     )
@@ -21,7 +21,7 @@ async def main():
         delay="3s",
     )
 
-    print(res.message_id)
+    print(res.message_id)  # type:ignore[union-attr]
 
 
 if __name__ == "__main__":

examples/basic_publish.py

@@ -5,7 +5,7 @@
 from qstash import QStash
 
 
-def main():
+def main() -> None:
     client = QStash(
         token="<QSTASH-TOKEN>",
     )
@@ -19,7 +19,7 @@ def main():
         delay="3s",
     )
 
-    print(res.message_id)
+    print(res.message_id)  # type:ignore[union-attr]
 
 
 if __name__ == "__main__":

examples/basic_schedule.py

@@ -5,7 +5,7 @@
 from qstash import QStash
 
 
-def main():
+def main() -> None:
     client = QStash(
         token="<QSTASH-TOKEN>",
     )

examples/callback.py

@@ -9,7 +9,7 @@
 from qstash import QStash
 
 
-def main():
+def main() -> None:
     client = QStash(
         token="<QSTASH-TOKEN>",
     )

examples/llm.py

@@ -9,7 +9,7 @@
 from qstash.chat import openai
 
 
-def main():
+def main() -> None:
     client = QStash(
         token="<QSTASH-TOKEN>",
     )

pyproject.toml

@@ -21,6 +21,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Database",
     "Topic :: Database :: Front-Ends",
@@ -39,7 +40,7 @@ pytest = "^8.2.2"
 python-dotenv = "^1.0.1"
 pytest-asyncio = "^0.23.7"
 mypy = "^1.10.0"
-ruff = "^0.5.0"
+ruff = "^0.11.7"
 
 [build-system]
 requires = ["poetry-core"]

qstash/asyncio/dlq.py

@@ -90,4 +90,4 @@ async def delete_many(self, dlq_ids: List[str]) -> int:
             body=body,
         )
 
-        return response["deleted"]
+        return response["deleted"]  # type:ignore[no-any-return]

qstash/asyncio/log.py

@@ -2,7 +2,7 @@
 
 from qstash.asyncio.http import AsyncHttpClient
 from qstash.log import (
-    EventFilter,
+    LogFilter,
     ListLogsResponse,
     parse_logs_response,
     prepare_list_logs_request_params,
@@ -18,7 +18,7 @@ async def list(
         *,
         cursor: Optional[str] = None,
         count: Optional[int] = None,
-        filter: Optional[EventFilter] = None,
+        filter: Optional[LogFilter] = None,
     ) -> ListLogsResponse:
         """
         Lists all logs that happened, such as message creation or delivery.

qstash/asyncio/message.py

@@ -40,6 +40,8 @@ async def publish(
         content_type: Optional[str] = None,
         method: Optional[HttpMethod] = None,
         headers: Optional[Dict[str, str]] = None,
+        callback_headers: Optional[Dict[str, str]] = None,
+        failure_callback_headers: Optional[Dict[str, str]] = None,
         retries: Optional[int] = None,
         callback: Optional[str] = None,
         failure_callback: Optional[str] = None,
@@ -67,6 +69,9 @@ async def publish(
         :param content_type: MIME type of the message.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
+        :param callback_headers: Headers to forward along with the callback message.
+        :param failure_callback_headers: Headers to forward along with the failure
+            callback message.
         :param retries: How often should this message be retried in case the destination
             API is not available.
         :param callback: A callback url that will be called after each attempt.
@@ -86,8 +91,8 @@ async def publish(
             When a timeout is specified, it will be used instead of the maximum timeout
             value permitted by the QStash plan. It is useful in scenarios, where a message
             should be delivered with a shorter timeout.
-        :param flow_control: Settings for controlling the number of active requests and
-            number of requests per second with the same key.
+        :param flow_control: Settings for controlling the number of active requests,
+            as well as the rate of requests with the same flow control key.
         """
         headers = headers or {}
         destination = get_destination(
@@ -101,6 +106,8 @@ async def publish(
             content_type=content_type,
             method=method,
             headers=headers,
+            callback_headers=callback_headers,
+            failure_callback_headers=failure_callback_headers,
             retries=retries,
             callback=callback,
             failure_callback=failure_callback,
@@ -130,6 +137,8 @@ async def publish_json(
         body: Optional[Any] = None,
         method: Optional[HttpMethod] = None,
         headers: Optional[Dict[str, str]] = None,
+        callback_headers: Optional[Dict[str, str]] = None,
+        failure_callback_headers: Optional[Dict[str, str]] = None,
         retries: Optional[int] = None,
         callback: Optional[str] = None,
         failure_callback: Optional[str] = None,
@@ -158,6 +167,9 @@ async def publish_json(
             serialized as JSON string.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
+        :param callback_headers: Headers to forward along with the callback message.
+        :param failure_callback_headers: Headers to forward along with the failure
+            callback message.
         :param retries: How often should this message be retried in case the destination
             API is not available.
         :param callback: A callback url that will be called after each attempt.
@@ -177,8 +189,8 @@ async def publish_json(
             When a timeout is specified, it will be used instead of the maximum timeout
             value permitted by the QStash plan. It is useful in scenarios, where a message
             should be delivered with a shorter timeout.
-        :param flow_control: Settings for controlling the number of active requests and
-            number of requests per second with the same key.
+        :param flow_control: Settings for controlling the number of active requests,
+            as well as the rate of requests with the same flow control key.
         """
         return await self.publish(
             url=url,
@@ -188,6 +200,8 @@ async def publish_json(
             content_type="application/json",
             method=method,
             headers=headers,
+            callback_headers=callback_headers,
+            failure_callback_headers=failure_callback_headers,
             retries=retries,
             callback=callback,
             failure_callback=failure_callback,
@@ -210,6 +224,8 @@ async def enqueue(
         content_type: Optional[str] = None,
         method: Optional[HttpMethod] = None,
         headers: Optional[Dict[str, str]] = None,
+        callback_headers: Optional[Dict[str, str]] = None,
+        failure_callback_headers: Optional[Dict[str, str]] = None,
         retries: Optional[int] = None,
         callback: Optional[str] = None,
         failure_callback: Optional[str] = None,
@@ -236,6 +252,9 @@ async def enqueue(
         :param content_type: MIME type of the message.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
+        :param callback_headers: Headers to forward along with the callback message.
+        :param failure_callback_headers: Headers to forward along with the failure
+            callback message.
         :param retries: How often should this message be retried in case the destination
             API is not available.
         :param callback: A callback url that will be called after each attempt.
@@ -261,6 +280,8 @@ async def enqueue(
             content_type=content_type,
             method=method,
             headers=headers,
+            callback_headers=callback_headers,
+            failure_callback_headers=failure_callback_headers,
             retries=retries,
             callback=callback,
             failure_callback=failure_callback,
@@ -291,6 +312,8 @@ async def enqueue_json(
         body: Optional[Any] = None,
         method: Optional[HttpMethod] = None,
         headers: Optional[Dict[str, str]] = None,
+        callback_headers: Optional[Dict[str, str]] = None,
+        failure_callback_headers: Optional[Dict[str, str]] = None,
         retries: Optional[int] = None,
         callback: Optional[str] = None,
         failure_callback: Optional[str] = None,
@@ -318,6 +341,9 @@ async def enqueue_json(
             serialized as JSON string.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
+        :param callback_headers: Headers to forward along with the callback message.
+        :param failure_callback_headers: Headers to forward along with the failure
+            callback message.
         :param retries: How often should this message be retried in case the destination
             API is not available.
         :param callback: A callback url that will be called after each attempt.
@@ -340,6 +366,8 @@ async def enqueue_json(
             content_type="application/json",
             method=method,
             headers=headers,
+            callback_headers=callback_headers,
+            failure_callback_headers=failure_callback_headers,
             retries=retries,
             callback=callback,
             failure_callback=failure_callback,
@@ -440,9 +468,9 @@ async def cancel_many(self, message_ids: List[str]) -> int:
             body=body,
         )
 
-        return response["cancelled"]
+        return response["cancelled"]  # type:ignore[no-any-return]
 
-    async def cancel_all(self):
+    async def cancel_all(self) -> int:
         """
         Cancels delivery of all the existing messages.
 
@@ -457,4 +485,4 @@ async def cancel_all(self):
             method="DELETE",
         )
 
-        return response["cancelled"]
+        return response["cancelled"]  # type:ignore[no-any-return]