rename ellipsis > truncate

Author: samuelcolvin

arq/jobs.py

@@ -8,7 +8,7 @@
 
 import msgpack
 
-from .utils import DEFAULT_CURTAIL, ellipsis, from_unix_ms, timestamp, to_unix_ms_tz
+from .utils import DEFAULT_CURTAIL, from_unix_ms, timestamp, to_unix_ms_tz, truncate
 
 __all__ = ['JobSerialisationError', 'Job', 'DatetimeJob']
 
@@ -100,7 +100,7 @@ def to_string(self, args_curtail=DEFAULT_CURTAIL):
                 arguments += ', '
             arguments += ', '.join(f'{k}={v!r}' for k, v in sorted(self.kwargs.items()))
 
-        return '{s.class_name}.{s.func_name}({args})'.format(s=self, args=ellipsis(arguments, args_curtail))
+        return '{s.class_name}.{s.func_name}({args})'.format(s=self, args=truncate(arguments, args_curtail))
 
     def __str__(self):
         return self.to_string()

arq/utils.py

@@ -185,7 +185,7 @@ def gen_random(length: int=20) -> bytes:
 DEFAULT_CURTAIL = 80
 
 
-def ellipsis(s: str, length: int=DEFAULT_CURTAIL) -> str:
+def truncate(s: str, length: int=DEFAULT_CURTAIL) -> str:
     """
     Truncate a string and add an ellipsis (three dots) to the end if it was too long
 

arq/worker.py

@@ -22,7 +22,7 @@
 from .jobs import ArqError, Job
 from .logs import default_log_config
 from .main import Actor  # noqa
-from .utils import RedisMixin, ellipsis, timestamp
+from .utils import RedisMixin, timestamp, truncate
 
 __all__ = ['BaseWorker', 'RunWorkerProcess', 'StopJob', 'import_string']
 
@@ -327,7 +327,7 @@ def log_job_result(self, started_at: float, result, j: Job):
         if not jobs_logger.isEnabledFor(logging.INFO):
             return
         job_time = timestamp() - started_at
-        sr = '' if result is None else ellipsis(repr(result), self.log_curtail)
+        sr = '' if result is None else truncate(repr(result), self.log_curtail)
         jobs_logger.info('%-4s ran in%7.3fs ← %s.%s ● %s', j.queue, job_time, j.class_name, j.func_name, sr)
 
     def handle_prepare_exc(self, msg: str):

docs/index.rst

@@ -106,7 +106,7 @@ API Reference
    :members:
 
 .. automodule:: arq.utils
-   :members: RedisSettings, RedisMixin, create_tz, timestamp, timestamp, to_unix_ms_tz, 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, truncate
 
 .. automodule:: arq.testing
    :members: