codetiming 0.1.1

A flexible, customizable timer for your Python code

codetiming - A flexible, customizable timer for your Python code

Install codetiming from PyPI:

$ python -m pip install codetiming

The source code is available at GitHub.

Basic Usage

You can use codetiming.Timer in several different ways:

1. As a class:

   t = Timer(name="class")
   t.start()
   # Do something
   t.stop()
   

2. As a context manager:

   with Timer(name="context manager"):
       # Do something
   

3. As a decorator:

   @Timer(name="decorator")
   def stuff():
       # Do something
   

Arguments

Timer accepts the following arguments when it's created, all are optional:

• name: An optional name for your timer
• text: The text shown when your timer ends. It should contain a {} placeholder that will be filled by the elapsed time in seconds (default: "Elapsed time: {:.4f} seconds")
• logger: A function/callable that takes a string argument, and will report the elapsed time when the logger is stopped (default: print())

You can turn off explicit reporting of the elapsed time by setting logger=None.

When using Timer as a class, you can capture the elapsed time when calling .stop():

elapsed_time = t.stop()

Named timers are made available in the class dictionary Timer.timers. The elapsed time will accumulate if the same name or same timer is used several times. Consider the following example:

>>> import logging
>>> from codetiming import Timer

>>> t = Timer("example", text="Time spent: {:.2f}", logger=logging.warning)

>>> t.start()
>>> t.stop()
WARNING:root:Time spent: 3.58
3.5836678670002584

>>> with t:
...     _ = list(range(100000000))
... 
WARNING:root:Time spent: 1.73

>>> Timer.timers
{'example': 5.312697440000193}

The example shows how you can redirect the timer output to the logging module. Note that the elapsed time spent in the two different uses of t has been accumulated in Timer.timers.

Acknowledgements

codetiming is based on a similar module originally developed for the Midgard Geodesy library at the Norwegian Mapping Authority.