Blast timer

arkindex_worker/utils.py

-# -*- coding: utf-8 -*-
-"""
-General utility functions and classes.
-"""
-
-import datetime
-from timeit import default_timer
-
-
-class Timer(object):
-    """
-    A context manager to help measure execution times.
-
-    Example
-    ---
-    ```
-    with Timer() as t:
-        # do something interesting
-    print(t.delta)  # X days, X:XX:XX
-    ```
-    """
-
-    def __init__(self):
-        self.timer = default_timer
-
-    def __enter__(self):
-        self.start = self.timer()
-        return self
-
-    def __exit__(self, *args):
-        end = self.timer()
-        self.elapsed = end - self.start
-        self.delta = datetime.timedelta(seconds=self.elapsed)

docs/ref/utils.md

-# Generic Utilities
-
-::: arkindex_worker.utils

mkdocs.yml

@@ -86,7 +86,6 @@ nav:
           - Transcription: ref/api/transcription.md
           - WorkerVersion: ref/api/worker_version.md
       - Models: ref/models.md
-      - Generic Utilities: ref/utils.md
       - Git & Gitlab support: ref/git.md
       - Image utilities: ref/image.md
       - Reporting: ref/reporting.md

tests/test_utils.py

-# -*- coding: utf-8 -*-
-from datetime import timedelta
-from time import sleep
-
-from arkindex_worker.utils import Timer
-
-
-def test_timer_type():
-    with Timer() as timer:
-        pass
-    assert isinstance(timer.delta, timedelta)
-
-
-def test_timer():
-    # Assert the second timer has recorded a longer period
-    with Timer() as timer:
-        pass
-    with Timer() as timer2:
-        sleep(1 / 100)
-    assert timer.delta < timer2.delta