Coverage for devtools/timer.py: 100.00%

64 statements  

« prev     ^ index     » next       coverage.py v7.16.2, created at 2026-10-11 17:56 +0000

1from time import perf_counter 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

2from typing import TextIO 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

3 

4__all__ = ('Timer',) 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

5 

6# required for type hinting because I (stupidly) added methods called `str` 

7StrType = str 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

8 

9 

10class TimerResult: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

11 def __init__(self, name: str | None = None, verbose: bool = True) -> None: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

12 self._name = name 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

13 self.verbose = verbose 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

14 self.finish: float | None = None 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

15 self.start = perf_counter() 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

16 

17 def capture(self) -> None: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

18 self.finish = perf_counter() 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

19 

20 def elapsed(self) -> float: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

21 if self.finish: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

22 return self.finish - self.start 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

23 else: 

24 return -1 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

25 

26 def str(self, dp: int = 3) -> StrType: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

27 if self._name: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

28 return f'{self._name}: {self.elapsed():0.{dp}f}s elapsed' 1abcdefghijkl

29 else: 

30 return f'{self.elapsed():0.{dp}f}s elapsed' 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

31 

32 def __str__(self) -> StrType: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

33 return self.str() 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

34 

35 

36_SUMMARY_TEMPLATE = '{count} times: mean={mean:0.{dp}f}s stdev={stddev:0.{dp}f}s min={min:0.{dp}f}s max={max:0.{dp}f}s' 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

37 

38 

39class Timer: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

40 def __init__(self, name: str | None = None, verbose: bool = True, file: TextIO | None = None, dp: int = 3) -> None: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

41 self.file = file 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

42 self.dp = dp 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

43 self._name = name 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

44 self._verbose = verbose 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

45 self.results: list[TimerResult] = [] 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

46 

47 def __call__(self, name: str | None = None, verbose: bool | None = None) -> 'Timer': 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

48 if name: 1abcdefghijkl

49 self._name = name 1abcdefghijkl

50 if verbose is not None: 1abcdefghijkl

51 self._verbose = verbose 1abcdefghijkl

52 return self 1abcdefghijkl

53 

54 def start(self, name: str | None = None, verbose: bool | None = None) -> 'Timer': 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

55 self.results.append(TimerResult(name or self._name, self._verbose if verbose is None else verbose)) 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

56 return self 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

57 

58 def capture(self, verbose: bool | None = None) -> TimerResult: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

59 r = self.results[-1] 1abcdefghijkl

60 r.capture() 1abcdefghijkl

61 print_ = r.verbose if verbose is None else verbose 1abcdefghijkl

62 if print_: 1abcdefghijkl

63 print(r.str(self.dp), file=self.file, flush=True) 1abcdefghijkl

64 return r 1abcdefghijkl

65 

66 def summary(self, verbose: bool = False) -> list[float]: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

67 times: list[float] = [] 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

68 for r in self.results: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

69 if not r.finish: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

70 r.capture() 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

71 if verbose: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

72 print(f' {r.str(self.dp)}', file=self.file) 1abcdefghijkl

73 times.append(r.elapsed()) 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

74 

75 if times: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

76 from statistics import mean, stdev 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

77 

78 print( 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

79 f'{len(times)} times: ' 

80 f'mean={mean(times):0.{self.dp}f}s ' 

81 f'stdev={stdev(times) if len(times) > 1 else 0:0.{self.dp}f}s ' 

82 f'min={min(times):0.{self.dp}f}s ' 

83 f'max={max(times):0.{self.dp}f}s', 

84 file=self.file, 

85 flush=True, 

86 ) 

87 else: 

88 raise RuntimeError('timer not started') 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

89 return times 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

90 

91 def __enter__(self) -> 'Timer': # noqa: PYI034 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

92 self.start() 1abcdefghijkl

93 return self 1abcdefghijkl

94 

95 def __exit__(self, *args: object) -> None: 1abcdefghijklmnopqrstuvwxyzABCDEFGHIJ

96 self.capture() 1abcdefghijkl