Skip to main content

Simplify logging of timings of selected parts of an application.

Project description

Simplify logging of timings of selected parts of an application.

package version from PyPI build status from GitHub test coverage from Codecov grade from Codacy license

How to use

Recommended initialization is as follows.

import timing

_TIME = timing.get_timing_group(__name__)  # type: timing.TimingGroup

This follows the conventions of logging module.

import logging

_LOG = logging.getLogger(__name__)

Any name can be used instead of __name__. However, if names of format module.sub.sub_sub are used, this will create a timing hierarchy where each timing data is stored in its proper location and can be queried easier.

The resulting _TIME object is used to create individual timers, and will handle storing results in cache, which later can be used to obtain timing statistics.

You can obtain the timer object directly via start(name) method. You’ll need to manually call stop() in this case.

timer = _TIME.start('spam')  # type: timing.Timing
spam()
more_spam()
timer.stop()

You can also obtain the timer object indirectly via measure(name) context manager. The context manager will take care of calling stop() at the end.

with _TIME.measure('ham') as timer:  # type: timing.Timing
    ham()
    more_ham()

And if you want to time many repetitions of the same action (e.g. for statistical significance) you can use measure_many(name[, samples][, threshold]) generator.

You can decide how many times you want to measure via samples parameter and how many seconds at most you want to spend on measurements via threshold parameter

for timer in _TIME.measure_many('eggs', samples=1000):  # type: timing.Timing
    eggs()
    more_eggs()

for timer in _TIME.measure_many('bacon', threshold=0.5):  # type: timing.Timing
    bacon()
    more_bacon()

for timer in _TIME.measure_many('tomatoes', samples=500, threshold=0.5):  # type: timing.Timing
    tomatoes()
    more_tomatoes()

Also, you can use measure and measure(name) as decorator. In this scenario you cannot access the timings directly, but the results will be stored in the timing group object, as well as in the global cache unless you configure the timing to not use the cache.

import timing

_TIME = timing.get_timing_group(__name__)

@_TIME.measure
def recipe():
    ham()
    eggs()
    bacon()

@_TIME.measure('the_best_recipe')
def bad_recipe():
    spam()
    spam()
    spam()

Then, after calling each function the results can be accessed through summary property.

recipe()
bad_recipe()
bad_recipe()

assert _TIME.summary['recipe']['samples'] == 1
assert _TIME.summary['the_best_recipe']['samples'] == 2

The summary property is dynamically computed on first access. Subsequent accesses will not recompute the values, so if you need to access the updated results, call the summarize() method.

recipe()
assert _TIME.summary['recipe']['samples'] == 1

bad_recipe()
bad_recipe()
assert _TIME.summary['the_best_recipe']['samples'] == 2  # will fail
_TIME.summarize()
assert _TIME.summary['the_best_recipe']['samples'] == 2  # ok

Further API and documentation are in development.

See these examples in action in examples.ipynb notebook.

Requirements

Python version 3.11 or later.

Python libraries as specified in requirements.txt.

Building and running tests additionally requires packages listed in requirements_test.txt.

Tested on Linux, macOS and Windows.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

timing-0.6.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

timing-0.6.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file timing-0.6.0.tar.gz.

File metadata

  • Download URL: timing-0.6.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for timing-0.6.0.tar.gz
Algorithm Hash digest
SHA256 75f341a3bb7a893bb78988f51220a1a0ca4dfaaaf2b69bb95fe49fa664b6c542
MD5 741e150362a9fedbf3c3d1c6a3150f3b
BLAKE2b-256 8aa5edcb1374255e73de8ca8b67cf3ebc1c8a3ab9bdcc348b4154fb15e87bb57

See more details on using hashes here.

File details

Details for the file timing-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: timing-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for timing-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b72eb85274d573badaa13cca30137ea9059c9d6f877ea998db7796518eebf847
MD5 f8be47c00a4c4966198566207c2c3fd8
BLAKE2b-256 f30e6da554a67029ef45abb32485c3ec0d88c69571a127ef835ff7c04ce9adb2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page