rename pole -> poll (#242)

* renme pole -> poll

* tweak test

Author: samuelcolvin

arq/jobs.py

@@ -1,6 +1,7 @@
 import asyncio
 import logging
 import pickle
+import warnings
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
@@ -73,15 +74,24 @@ def __init__(
         self._queue_name = _queue_name
         self._deserializer = _deserializer
 
-    async def result(self, timeout: Optional[float] = None, *, pole_delay: float = 0.5) -> Any:
+    async def result(
+        self, timeout: Optional[float] = None, *, poll_delay: float = 0.5, pole_delay: float = None
+    ) -> Any:
         """
         Get the result of the job, including waiting if it's not yet available. If the job raised an exception,
         it will be raised here.
 
         :param timeout: maximum time to wait for the job result before raising ``TimeoutError``, will wait forever
-        :param pole_delay: how often to poll redis for the job result
+        :param poll_delay: how often to poll redis for the job result
+        :param pole_delay: deprecated, use poll_delay instead
         """
-        async for delay in poll(pole_delay):
+        if pole_delay is not None:
+            warnings.warn(
+                '"pole_delay" is deprecated, use the correct spelling "poll_delay" instead', DeprecationWarning
+            )
+            poll_delay = pole_delay
+
+        async for delay in poll(poll_delay):
             info = await self.result_info()
             if info:
                 result = info.result
@@ -132,18 +142,18 @@ async def status(self) -> JobStatus:
                 return JobStatus.not_found
             return JobStatus.deferred if score > timestamp_ms() else JobStatus.queued
 
-    async def abort(self, *, timeout: Optional[float] = None, pole_delay: float = 0.5) -> bool:
+    async def abort(self, *, timeout: Optional[float] = None, poll_delay: float = 0.5) -> bool:
         """
         Abort the job.
 
         :param timeout: maximum time to wait for the job result before raising ``TimeoutError``,
         will wait forever on None
-        :param pole_delay: how often to poll redis for the job result
+        :param poll_delay: how often to poll redis for the job result
         :return: True if the job aborted properly, False otherwise
         """
         await self._redis.zadd(abort_jobs_ss, timestamp_ms(), self.job_id)
         try:
-            await self.result(timeout=timeout, pole_delay=pole_delay)
+            await self.result(timeout=timeout, poll_delay=poll_delay)
         except asyncio.CancelledError:
             return True
         else:

tests/test_jobs.py

@@ -27,7 +27,7 @@ async def test_unknown(arq_redis: ArqRedis):
 async def test_result_timeout(arq_redis: ArqRedis):
     j = Job('foobar', arq_redis)
     with pytest.raises(asyncio.TimeoutError):
-        await j.result(0.1, pole_delay=0)
+        await j.result(0.1, poll_delay=0)
 
 
 async def test_enqueue_job(arq_redis: ArqRedis, worker, queue_name=default_queue_name):
@@ -39,7 +39,7 @@ async def foobar(ctx, *args, **kwargs):
     assert JobStatus.queued == await j.status()
     worker: Worker = worker(functions=[func(foobar, name='foobar')], queue_name=queue_name)
     await worker.main()
-    r = await j.result(pole_delay=0)
+    r = await j.result(poll_delay=0)
     assert r == 42
     assert JobStatus.complete == await j.status()
     info = await j.info()
@@ -138,13 +138,13 @@ async def foobar(ctx, a, b):
     assert JobStatus.queued == await j.status()
     worker: Worker = worker(functions=[func(foobar, name='foobar')])
     await worker.run_check()
-    assert await j.result(pole_delay=0) == 3
-    assert await j.result(pole_delay=0) == 3
+    assert await j.result(poll_delay=0) == 3
+    assert await j.result(poll_delay=0) == 3
     info = await j.info()
     assert info.args == (1, 2)
     await arq_redis.set(result_key_prefix + j.job_id, b'invalid pickle data')
     with pytest.raises(DeserializationError, match='unable to deserialize job result'):
-        assert await j.result(pole_delay=0) == 3
+        assert await j.result(poll_delay=0) == 3
 
 
 async def test_deserialize_info(arq_redis: ArqRedis):
@@ -165,3 +165,13 @@ async def test_deserialize_job_raw():
 async def test_get_job_result(arq_redis: ArqRedis):
     with pytest.raises(KeyError, match='job "foobar" not found'):
         await arq_redis._get_job_result('foobar')
+
+
+async def test_result_pole_delay_dep(arq_redis: ArqRedis):
+    j = Job('foobar', arq_redis)
+    r = serialize_result('foobar', (1,), {}, 1, 123, True, 42, 123, 123, 'testing', 'test-queue')
+    await arq_redis.set(result_key_prefix + j.job_id, r)
+    with pytest.warns(
+        DeprecationWarning, match='"pole_delay" is deprecated, use the correct spelling "poll_delay" instead'
+    ):
+        assert await j.result(pole_delay=0) == 42

tests/test_main.py

@@ -25,7 +25,7 @@ async def foobar(ctx):
     j = await arq_redis.enqueue_job('foobar')
     worker: Worker = worker(functions=[func(foobar, name='foobar')])
     await worker.main()
-    r = await j.result(pole_delay=0)
+    r = await j.result(poll_delay=0)
     assert r == 42  # 1
 
 
@@ -40,8 +40,8 @@ async def foobar(ctx):
 
     await worker1.main()
     await worker2.main()
-    r1 = await j1.result(pole_delay=0)
-    r2 = await j2.result(pole_delay=0)
+    r1 = await j1.result(poll_delay=0)
+    r2 = await j2.result(poll_delay=0)
     assert r1 == 42  # 1
     assert r2 == 42  # 2
 
@@ -58,10 +58,10 @@ async def parent_job(ctx):
     worker: Worker = worker(functions=[func(parent_job, name='parent_job'), func(foobar, name='foobar')])
 
     await worker.main()
-    result = await job.result(pole_delay=0)
+    result = await job.result(poll_delay=0)
     assert result is not None
     inner_job = Job(result, arq_redis)
-    inner_result = await inner_job.result(pole_delay=0)
+    inner_result = await inner_job.result(poll_delay=0)
     assert inner_result == 42
 
 
@@ -83,10 +83,10 @@ async def parent_job(ctx):
     )
 
     await worker.main()
-    result = await job.result(pole_delay=0)
+    result = await job.result(poll_delay=0)
     assert result is not None
     inner_job = Job(result, arq_redis_msgpack, _deserializer=functools.partial(msgpack.unpackb, raw=False))
-    inner_result = await inner_job.result(pole_delay=0)
+    inner_result = await inner_job.result(poll_delay=0)
     assert inner_result == 42
 
 
@@ -107,10 +107,10 @@ async def parent_job(ctx):
     )
 
     await worker.main()
-    inner_job_id = await job.result(pole_delay=0)
+    inner_job_id = await job.result(poll_delay=0)
     assert inner_job_id is not None
     inner_job = Job(inner_job_id, arq_redis, _queue_name='spanner')
-    inner_result = await inner_job.result(pole_delay=0)
+    inner_result = await inner_job.result(poll_delay=0)
     assert inner_result == 42
 
 
@@ -123,7 +123,7 @@ async def foobar(ctx):
     await worker.main()
 
     with pytest.raises(RuntimeError, match='foobar error'):
-        await j.result(pole_delay=0)
+        await j.result(poll_delay=0)
 
 
 async def test_job_info(arq_redis: ArqRedis):
@@ -190,12 +190,12 @@ async def foobar(ctx):
     j1 = await arq_redis.enqueue_job('foobar')
     w: Worker = worker(functions=[func(foobar, name='foobar')])
     await w.main()
-    r = await j1.result(pole_delay=0)
+    r = await j1.result(poll_delay=0)
     assert r == 1
 
     j2 = await arq_redis.enqueue_job('foobar', _job_try=3)
     await w.main()
-    r = await j2.result(pole_delay=0)
+    r = await j2.result(poll_delay=0)
     assert r == 3
 
 
@@ -208,7 +208,7 @@ async def foobar(ctx):
     j1 = await arq_redis.enqueue_job('foobar', _job_try=3)
     w: Worker = worker(functions=[func(foobar, name='foobar')])
     await w.main()
-    r = await j1.result(pole_delay=0)
+    r = await j1.result(poll_delay=0)
     assert r == 4
 
 
@@ -233,7 +233,7 @@ async def foobar(ctx):
     w: Worker = worker(functions=[func(foobar, name='foobar')])
     await w.main()
     with pytest.raises(SerializationError, match='unable to serialize result'):
-        await j1.result(pole_delay=0)
+        await j1.result(poll_delay=0)
 
 
 async def test_get_jobs(arq_redis: ArqRedis):

tests/test_worker.py

@@ -489,7 +489,7 @@ async def return_error(ctx):
     worker: Worker = worker(functions=[func(return_error, name='return_error')])
     await worker.main()
     assert (worker.jobs_complete, worker.jobs_failed, worker.jobs_retried) == (1, 0, 0)
-    r = await j.result(pole_delay=0)
+    r = await j.result(poll_delay=0)
     assert isinstance(r, TypeError)
     info = await j.result_info()
     assert info.success is True