projects
/
python_utils.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Minor cleanup.
[python_utils.git]
/
stopwatch.py
diff --git
a/stopwatch.py
b/stopwatch.py
index d54af8792d28eef4025c150cb1920fbd2113efee..4e69b6992b278df8eb8e725954d9c610468318aa 100644
(file)
--- a/
stopwatch.py
+++ b/
stopwatch.py
@@
-1,27
+1,39
@@
#!/usr/bin/env python3
#!/usr/bin/env python3
+# © Copyright 2021-2022, Scott Gasch
+
+"""A simple stopwatch decorator / context for timing things."""
+
+import contextlib
import time
import time
-from typing import Callable
+from typing import Callable
, Literal
-class Timer(
object
):
+class Timer(
contextlib.AbstractContextManager
):
"""
"""
- with timer.Timer() as t:
- do_the_thing()
+ A stopwatch to time how long something takes (walltime).
+
+ e.g.
- walltime = t()
- print(f'That took {walltime}s.')
+ with stopwatch.Timer() as t:
+ do_the_thing()
+
+ walltime = t()
+ print(f'That took {walltime} seconds.')
"""
def __init__(self) -> None:
"""
def __init__(self) -> None:
- self.start =
None
- self.end =
None
+ self.start =
0.0
+ self.end =
0.0
def __enter__(self) -> Callable[[], float]:
def __enter__(self) -> Callable[[], float]:
+ """Returns a functor that, when called, returns the walltime of the
+ operation in seconds.
+ """
self.start = time.perf_counter()
self.end = 0.0
return lambda: self.end - self.start
self.start = time.perf_counter()
self.end = 0.0
return lambda: self.end - self.start
- def __exit__(self, *args) ->
bool
:
+ def __exit__(self, *args) ->
Literal[False]
:
self.end = time.perf_counter()
self.end = time.perf_counter()
- return
Tru
e
+ return
Fals
e