switch to_unix_ms, add to_unix_ms_tz

Author: samuelcolvin

HISTORY.rst

@@ -3,10 +3,12 @@
 History
 -------
 
-v0.9.0 (2017-XX-XX)
+v0.9.0 (2017-06-23)
 ...................
 * allow set encoding in msgpack for jobs #49
 * cron tasks allowing scheduling of functions in the future #50
+* **Breaking change:** switch ``to_unix_ms`` to just return the timestamp int, add ``to_unix_ms_tz`` to
+  return tz offset too
 
 v0.8.1 (2017-06-05)
 ...................

arq/jobs.py

@@ -8,7 +8,7 @@
 
 import msgpack
 
-from .utils import DEFAULT_CURTAIL, ellipsis, from_unix_ms, timestamp, to_unix_ms
+from .utils import DEFAULT_CURTAIL, ellipsis, from_unix_ms, timestamp, to_unix_ms_tz
 
 __all__ = ['JobSerialisationError', 'Job', 'DatetimeJob']
 
@@ -122,7 +122,7 @@ class DatetimeJob(Job):
     @classmethod
     def msgpack_encoder(cls, obj):
         if isinstance(obj, datetime):
-            ts, tz = to_unix_ms(obj)
+            ts, tz = to_unix_ms_tz(obj)
             result = {DEVICE_CONTROL_TWO: ts}
             if tz is not None:
                 result[TIMEZONE] = tz

arq/main.py

@@ -158,7 +158,7 @@ async def run_cron(self):
             for cron_job, run_at in to_run:
                 if cron_job.unique:
                     sentinel_key = self.CRON_SENTINEL_PREFIX + f'{self.name}.{cron_job.__name__}'.encode()
-                    sentinel_value = str(to_unix_ms(run_at)[0]).encode()
+                    sentinel_value = str(to_unix_ms(run_at)).encode()
                     v, _ = await asyncio.gather(
                         redis.getset(sentinel_key, sentinel_value),
                         redis.expire(sentinel_key, 3600),

arq/utils.py

@@ -135,9 +135,9 @@ def timestamp() -> float:
     return (datetime.utcnow() - EPOCH).total_seconds()
 
 
-def to_unix_ms(dt: datetime) -> Tuple[int, Union[int, None]]:
+def to_unix_ms_tz(dt: datetime) -> Tuple[int, Union[int, None]]:
     """
-    convert a datetime to number of milliseconds since 1970
+    convert a datetime to number of milliseconds since 1970 and calculate timezone offset
     :param dt: datetime to evaluate
     :return: tuple - (unix time in milliseconds, utc offset in seconds)
     """
@@ -150,6 +150,15 @@ def to_unix_ms(dt: datetime) -> Tuple[int, Union[int, None]]:
         return int((dt - EPOCH).total_seconds() * 1000), None
 
 
+def to_unix_ms(dt: datetime) -> int:
+    """
+    convert a datetime to number of milliseconds since 1970
+    :param dt: datetime to evaluate
+    :return: unix time in milliseconds
+    """
+    return to_unix_ms_tz(dt)[0]
+
+
 def from_unix_ms(ms: int, utcoffset: int=None) -> datetime:
     """
     convert int to a datetime.

arq/version.py

@@ -2,4 +2,4 @@
 
 __all__ = ['VERSION']
 
-VERSION = StrictVersion('0.8.1')
+VERSION = StrictVersion('0.9.0')

docs/index.rst

@@ -106,7 +106,7 @@ API Reference
    :members:
 
 .. automodule:: arq.utils
-   :members: RedisSettings, RedisMixin, create_tz, timestamp, timestamp, to_unix_ms, from_unix_ms, gen_random, ellipsis
+   :members: RedisSettings, RedisMixin, create_tz, timestamp, timestamp, to_unix_ms_tz, to_unix_ms, from_unix_ms, gen_random, ellipsis
 
 .. automodule:: arq.testing
    :members:

tests/test_cron.py

@@ -45,7 +45,7 @@ async def test_cron_time_match_sentinel_set(tmpworkdir, redis_conn, actor):
     with open('datatime.pkl', 'wb') as f:
         pickle.dump(datetimes, f)
 
-    v = str(to_unix_ms(datetime(2032, 1, 1, 3, 0, 0, 123456))[0]).encode()
+    v = str(to_unix_ms(datetime(2032, 1, 1, 3, 0, 0, 123456))).encode()
     await redis_conn.set(b'arq:cron:CronActor.save_spam', v)
 
     worker = CronWorker(burst=True, loop=actor.loop)
@@ -59,7 +59,7 @@ async def test_cron_time_match_not_unique(tmpworkdir, redis_conn, actor):
     with open('datatime.pkl', 'wb') as f:
         pickle.dump(datetimes, f)
 
-    v = str(to_unix_ms(datetime(2032, 1, 1, 3, 0, 0, 123456))[0]).encode()
+    v = str(to_unix_ms(datetime(2032, 1, 1, 3, 0, 0, 123456))).encode()
     await redis_conn.set(b'arq:cron:CronActor.save_not_unique', v)
 
     worker = CronWorker(burst=True, loop=actor.loop)