dycw-utilities 0.133.1__tar.gz → 0.133.2__tar.gz

{dycw_utilities-0.133.1 → dycw_utilities-0.133.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.133.1
+Version: 0.133.2
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.133.1 → dycw_utilities-0.133.2}/pyproject.toml

@@ -104,7 +104,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.133.1"
+version = "0.133.2"
 
 [project.optional-dependencies]
 logging = [
@@ -130,7 +130,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.133.1"
+current_version = "0.133.2"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.133.1 → dycw_utilities-0.133.2}/src/tests/test_arq.py

@@ -3,45 +3,56 @@ from __future__ import annotations
 from asyncio import sleep
 from typing import TYPE_CHECKING, Any, cast
 
+from arq.connections import ArqRedis
 from hypothesis import given
 from hypothesis.strategies import integers
 
-from utilities.arq import Worker, cron_raw
+from tests.conftest import SKIPIF_CI_AND_NOT_LINUX
+from utilities.arq import Worker, cron_raw, job_enqueuer
 from utilities.iterables import one
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
-    from arq.cron import CronJob
     from arq.typing import WorkerCoroutine
 
     from utilities.types import CallableCoroutine1
 
 
-class TestWorker:
+class TestCronRaw:
     @given(x=integers(), y=integers())
     async def test_main(self, *, x: int, y: int) -> None:
         async def func(x: int, y: int, /) -> int:
             await sleep(0.01)
             return x + y
 
-        class Example(Worker):
-            functions_raw: Sequence[CallableCoroutine1[Any]] = [func]
-
-        func_use = cast("WorkerCoroutine", one(Example.functions))
-        result = await func_use({}, x, y)
+        job = cron_raw(func, args=(x, y))
+        result = await job.coroutine({})
         assert result == (x + y)
 
+
+class TestJobEnqueuer:
+    @given(x=integers(), y=integers())
+    @SKIPIF_CI_AND_NOT_LINUX
+    async def test_main(self, *, x: int, y: int) -> None:
+        async def func(x: int, y: int, /) -> int:
+            await sleep(0.01)
+            return x + y
+
+        redis = ArqRedis(db=15)
+        _ = await job_enqueuer.settings(queue_name="test")(redis, func, x, y)
+
+
+class TestWorker:
     @given(x=integers(), y=integers())
-    async def test_cron(self, *, x: int, y: int) -> None:
+    async def test_main(self, *, x: int, y: int) -> None:
         async def func(x: int, y: int, /) -> int:
             await sleep(0.01)
             return x + y
 
         class Example(Worker):
-            cron_jobs: Sequence[CronJob] | None = [cron_raw(func, args=(x, y))]
+            functions_raw: Sequence[CallableCoroutine1[Any]] = [func]
 
-        assert Example.cron_jobs is not None
-        cron_job = one(Example.cron_jobs)
-        result = await cron_job.coroutine({})
+        func_use = cast("WorkerCoroutine", one(Example.functions))
+        result = await func_use({}, x, y)
         assert result == (x + y)

{dycw_utilities-0.133.1 → dycw_utilities-0.133.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.133.1"
+__version__ = "0.133.2"

{dycw_utilities-0.133.1 → dycw_utilities-0.133.2}/src/utilities/arq.py

@@ -3,18 +3,21 @@ from __future__ import annotations
 from dataclasses import dataclass
 from functools import wraps
 from itertools import chain
-from typing import TYPE_CHECKING, Any, ParamSpec, TypeVar, cast, override
+from typing import TYPE_CHECKING, Any, ParamSpec, Self, TypeVar, cast, override
 
 from arq.constants import default_queue_name, expires_extra_ms
 from arq.cron import cron
 
+from utilities.dataclasses import replace_non_sentinel
+from utilities.sentinel import Sentinel, sentinel
+
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Sequence
-    from datetime import timezone
+    from datetime import datetime, timedelta, timezone
 
     from arq.connections import ArqRedis, RedisSettings
     from arq.cron import CronJob
-    from arq.jobs import Deserializer, Serializer
+    from arq.jobs import Deserializer, Job, Serializer
     from arq.typing import (
         OptionType,
         SecondsTimedelta,
@@ -26,6 +29,7 @@ if TYPE_CHECKING:
 
     from utilities.types import CallableCoroutine1, Coroutine1, StrMapping
 
+
 _P = ParamSpec("_P")
 _T = TypeVar("_T")
 
@@ -95,6 +99,64 @@ def _lift_cron(
 ##
 
 
+@dataclass(kw_only=True, slots=True)
+class _JobEnqueuer:
+    """Enqueuer of jobs."""
+
+    job_id: str | None = None
+    queue_name: str | None = None
+    defer_until: datetime | None = None
+    defer_by: int | float | timedelta | None = None
+    expires: int | float | timedelta | None = None
+    job_try: int | None = None
+
+    async def __call__(
+        self,
+        redis: ArqRedis,
+        function: Callable[_P, Coroutine1[_T]],
+        *args: _P.args,
+        **kwargs: _P.kwargs,
+    ) -> Job | None:
+        return await redis.enqueue_job(  # skipif-ci-and-not-linux
+            function.__name__,
+            *args,
+            _job_id=self.job_id,
+            _queue_name=self.queue_name,
+            _defer_until=self.defer_until,
+            _defer_by=self.defer_by,
+            _expires=self.expires,
+            _job_try=self.job_try,
+            **kwargs,
+        )
+
+    def settings(
+        self,
+        *,
+        job_id: str | None | Sentinel = sentinel,
+        queue_name: str | None | Sentinel = sentinel,
+        defer_until: datetime | None | Sentinel = sentinel,
+        defer_by: float | timedelta | None | Sentinel = sentinel,
+        expires: float | timedelta | None | Sentinel = sentinel,
+        job_try: int | None | Sentinel = sentinel,
+    ) -> Self:
+        """Replace elements of the enqueuer."""
+        return replace_non_sentinel(  # skipif-ci-and-not-linux
+            self,
+            job_id=job_id,
+            queue_name=queue_name,
+            defer_until=defer_until,
+            defer_by=defer_by,
+            expires=expires,
+            job_try=job_try,
+        )
+
+
+job_enqueuer = _JobEnqueuer()
+
+
+##
+
+
 class _WorkerMeta(type):
     @override
     def __new__(
@@ -158,4 +220,4 @@ class Worker(metaclass=_WorkerMeta):
     log_results: bool = True
 
 
-__all__ = ["Worker", "cron"]
+__all__ = ["Worker", "cron", "job_enqueuer"]