Add support for using isort to order imports (#19)

Author: gahjelle

codetiming/__init__.py

@@ -21,7 +21,7 @@ def stuff():
         # Do something
 """
 
-# Import Timer for cleaner namespace
+# Codetiming imports
 from codetiming._timer import Timer, TimerError  # noqa
 
 # Versioning is handled by bump2version

codetiming/_timer.py

@@ -5,10 +5,10 @@
 """
 
 # Standard library imports
+import math
 import time
 from contextlib import ContextDecorator
 from dataclasses import dataclass, field
-from math import nan
 from typing import Any, Callable, ClassVar, Dict, Optional
 
 
@@ -21,11 +21,11 @@ class Timer(ContextDecorator):
     """Time your code using a class, context manager, or decorator"""
 
     timers: ClassVar[Dict[str, float]] = dict()
+    _start_time: Optional[float] = field(default=None, init=False, repr=False)
     name: Optional[str] = None
     text: str = "Elapsed time: {:0.4f} seconds"
     logger: Optional[Callable[[str], None]] = print
-    _start_time: Optional[float] = field(default=None, init=False, repr=False)
-    last: float = field(default=nan, init=False, repr=False)
+    last: float = field(default=math.nan, init=False, repr=False)
 
     def __post_init__(self) -> None:
         """Initialization: add timer to dict of timers"""

pyproject.toml

@@ -39,6 +39,15 @@ requires           = [
 "Tutorial" = "https://realpython.com/python-timer"
 
 [tool.flit.metadata.requires-extra]
-dev                = ["black", "bump2version", "flake8", "flit", "mypy"]
+dev                = ["black", "bump2version", "flake8", "flit", "isort", "mypy"]
 test               = ["pytest", "pytest-cov", "tox"]
 
+[tool.isort]
+multi_line_output             = 3
+include_trailing_comma        = true
+force_grid_wrap               = 0
+use_parentheses               = true
+line_length                   = 88
+import_heading_stdlib         = "Standard library imports"
+import_heading_thirdparty     = "Third party imports"
+import_heading_firstparty     = "Codetiming imports"

tests/test_codetiming.py

@@ -3,9 +3,9 @@
 Based on the Pytest test runner
 """
 # Standard library imports
+import math
 import re
 import time
-from math import isnan
 
 # Third party imports
 import pytest
@@ -167,11 +167,15 @@ def test_error_if_restarting_running_timer():
         t.start()
 
 
-def test_timer_sets_last():
+def test_last_starts_as_nan():
+    """Test that .last attribute is initialized as nan"""
     t = Timer()
-    assert isnan(t.last)
-    t.start()
-    time.sleep(0.1)
-    t.stop()
+    assert math.isnan(t.last)
+
+
+def test_timer_sets_last():
+    """Test that .last attribute is properly set"""
+    with Timer() as t:
+        time.sleep(0.02)
 
-    assert 0.1 <= t.last
+    assert t.last >= 0.02