Horology
Conveniently measures the time of your loops, contexts and functions.
Installation
Simply:
pip install horology
Works with python versions 3.6, 3.7, 3.8 and 3.9. Tested on Linux, Windows and MacOS.
Usage
The following 3 tools will let you measure practically any part of your Python code.
Timing an iterable (list, tuple, generator, etc)
Quick example
from horology import Timed
animals = ['cat', 'dog', 'crocodile']
for x in Timed(animals):
feed(x)
Result:
iteration 1: 12.0 s
iteration 2: 8.00 s
iteration 3: 100 s
total 3 iterations in 120 s
min/median/max: 8.00/12.0/100 s
average (std): 40.0 (52.0) s
More cool stuff:
You can specify where (if at all) you want each iteration and summary to be printed, eg.:
for x in Timed(animals, unit='ms',
iteration_print_fn=logger.debug,
summary_print_fn=logger.info):
feed(x)
Timing a function with a @timed decorator
Quick example
from horology import timed
@timed
def foo():
...
Result:
>>> foo()
foo: 7.12 ms
More cool stuff:
Personalize time unit and name
@timed(unit='s', name='Processing took ')
def bar():
...
Result:
>>> bar()
Processing took 0.185 s
Timing part of code with a Timing context
Quick example
Just wrap your code using a with statement
from horology import Timing
with Timing(name='Important calculations: '):
...
Result:
Important calculations: 12.4 s
More cool stuff:
You can suppress default printing and directly use measured time (also within context)
with Timing(print_fn=None) as t:
...
make_use_of(t.interval)
Time units
Time units are by default automatically adjusted, for example you will see foo: 7.12 ms rather than foo: 0.007 s. If you don't like it, you can override this by setting the unit argument with one of these names: ['ns', 'us', 'ms', 's', 'min', 'h', 'd'].
Contributions
Contributions are welcomed, see contribution guide.
Internals
Horology internally measures time with perf_counter which provides the highest available resolution, see docs.
14 Oct 14, 2022
3 Nov 6, 2021
12 Dec 12, 2022
2 Dec 5, 2021
73 Jan 6, 2023
3 Nov 23, 2022
8 Jul 24, 2022
6 Dec 12, 2022
3 Sep 13, 2021
![[ADD] iterations in decorator](https://avatars.githubusercontent.com/u/26277199?v=4)
1 Dec 31, 2021
7 May 21, 2022
2 Feb 17, 2022
9 Jun 08, 2022
2 Dec 17, 2021
1 Mar 31, 2022
4 Jan 05, 2022
1 Dec 09, 2021
3 Aug 10, 2022
23 Nov 04, 2022
2 Feb 12, 2022
2 Nov 02, 2022
0 Dec 11, 2022
11 Dec 05, 2022
242 Dec 15, 2022
6 Aug 01, 2022
2 Jan 29, 2022
398 Dec 25, 2022
4 Dec 11, 2021
2 Dec 11, 2021