Since this thing is on the innerwebs I suppose it should have a

[python_utils.git] / stopwatch.py

diff --git a/stopwatch.py b/stopwatch.py
index 516138c50fadb3fc71f29ffe8bf9e29169ddff3c..4e69b6992b278df8eb8e725954d9c610468318aa 100644 (file)
--- a/stopwatch.py
+++ b/stopwatch.py
@@ -1,16 +1,21 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
+"""A simple stopwatch decorator / context for timing things."""
+
+import contextlib
 import time
-from typing import Callable, Optional
+from typing import Callable, Literal
 
 
-class Timer(object):
+class Timer(contextlib.AbstractContextManager):
     """
     A stopwatch to time how long something takes (walltime).
 
     e.g.
 
-        with timer.Timer() as t:
+        with stopwatch.Timer() as t:
             do_the_thing()
 
         walltime = t()
@@ -29,6 +34,6 @@ class Timer(object):
         self.end = 0.0
         return lambda: self.end - self.start
 
-    def __exit__(self, *args) -> Optional[bool]:
+    def __exit__(self, *args) -> Literal[False]:
         self.end = time.perf_counter()
-        return None  # don't suppress exceptions
+        return False