Conveniently measures the time of your loops, contexts and functions.

Last update: Nov 15, 2022

Related tags

General Utilities horology

Overview

`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.

Helpful functions for use alongside the rich Python library.

🔧 Rich Tools A python package with helpful functions for use alongside with the rich python library. 󠀠󠀠 The current features are: Convert a Pandas

14 Oct 14, 2022

Run functions in parallel easily, with their results typed correctly!

typesafe_parmap pip install pip install typesafe-parmap Run functions in parallel safely with typesafe parmap! GitHub: https://github.com/thejaminato

3 Nov 6, 2021

Python @deprecat decorator to deprecate old python classes, functions or methods.

deprecat Decorator Python @deprecat decorator to deprecate old python classes, functions or methods. Installation pip install deprecat Usage To use th

12 Dec 12, 2022

Dill_tils is a package that has my commonly used functions inside it for ease of use.

DilllonB07 Utilities Dill_tils is a package that has my commonly used functions inside it for ease of use. Installation Anyone can use this package by

2 Dec 5, 2021

A collection of utility functions to prototype geometry processing research in python

gpytoolbox This repo is a work in progress and contains general utility functions I have needed to code while trying to work on geometry process resea

73 Jan 6, 2023

A simple example for calling C++ functions in Python by `ctypes`.

ctypes-example A simple example for calling C++ functions in Python by ctypes. Features call C++ function int bar(int* value, char* msg) with argumene

3 Nov 23, 2022

Gradually automate your procedures, one step at a time

Gradualist Gradually automate your procedures, one step at a time Inspired by https://blog.danslimmon.com/2019/07/15/ Features Main Features Converts

8 Jul 24, 2022

A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

Kali Mirror Finder Using Single Python File A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use tha

6 Dec 12, 2022

jsoooooooon derulo - Make sure your 'jason derulo' is featured as the first part of your json data

jsonderulo Make sure your 'jason derulo' is featured as the first part of your json data Install: # python pip install jsonderulo poetry add jsonderul

3 Sep 13, 2021

Comments

[ADD] iterations in decorator

When using horology, I often end up putting in a for loop for performace based timings over many iterations.

By adding it to the decorator, it can help for quick analysis.

If you are happy I can also look at adding the same functionality to the context manage.

I am unsure how this would fit with the timed_iterable, maybe conflicts, maybe not??

I will let you decide :)

opened by johnashu 10

Releases(v1.2.0)

v1.2.0(Oct 1, 2021)
Link to this version on the The Python Package Index.

Features

Use always 3 significant digits when formatting output strings. Such formatting is much more elegant and avoids adding decimal points for integers.

Fixes

Wrong link in pepy badge.

Docs

All docs were rewritten in beautiful numpy style.

Tests and deployment

Add CI for python 3.9.

Use poetry to build and deploy

Source code(tar.gz)
Source code(zip)
v1.1.0(Jan 14, 2020)
Feature

Time units allow aliases, by @johnashu

Fix

Not rescaling total time in Timed iterable - fixed

Docs

Add contribution guide

Add bug report template

Add feature request template

Add doc strings in tformatter module

Add badges to readme

Tests:

Add CI for python 3.6-3.8

Add tests of Timed iterable summary

Add tests of tformatter exception

Credits

Thanks to our 1 contributor whose commits are featured in this release: @johnashu
Source code(tar.gz)
Source code(zip)
v1.0.0(Dec 11, 2019)
horology name was picked instead of confusing ttt

package can now be installed with pip install horology

Source code(tar.gz)
Source code(zip)

Owner

Maciej J Mikulski

GitHub Repository

Python HTTP Agent Parser

Features Fast Detects OS and Browser. Does not aim to be a full featured agent parser Will not turn into django-httpagentparser ;) Usage import ht

213 Dec 06, 2022

Make some improvements in the Pizza class and pizzashop file by refactoring.

1 Oct 18, 2021

Bounding Boxes Python Utils

4 May 01, 2022

A quick username checker to see if a username is available on a list of assorted websites.

4 Jan 04, 2022

Implicit hierarchical a posteriori error estimates in FEniCSx

FEniCSx Error Estimation (FEniCSx-EE) Description FEniCSx-EE is an open source library showing how various error estimation strategies can be implemen

1 Dec 08, 2021

Aggregating gridded data (xarray) to polygons

A package to aggregate gridded data in xarray to polygons in geopandas using area-weighting from the relative area overlaps between pixels and polygons.

42 Nov 09, 2022

A simple package for handling variables in string.

A simple package for handling string variables. Welcome! This is a simple package for handling variables in string, You can add or remove variables wi

1 Dec 31, 2021

Pyfunctools is a module that provides functions, methods and classes that help in the creation of projects in python

Pyfunctools Pyfunctools is a module that provides functions, methods and classes that help in the creation of projects in python, bringing functional

5 Dec 22, 2022

✨ Un chois aléatoire d'un article sur Wikipedia totalement fait en Python par moi, et en français.

Wikipedia Random Article ❗ Un chois aléatoire d'un article sur Wikipedia totalement fait en Python par moi, et en français. 🔮 Grâce a une requète a w

4 Jul 18, 2021

Color getter (including method to get random color or complementary color) made out of Python

python-color-getter Color getter (including method to get random color or complementary color) made out of Python Setup pip3 install git+https://githu

2 Sep 17, 2022

password generator

Password generator technologies used What is? It is Password generator How to Download? Download on releases Clone repo git clone https://github.com/m

1 Dec 16, 2021

Python USD rate in RUB parser

Python EUR and USD rate parser. Python USD and EUR rate in RUB parser. Parsing i

2 Feb 17, 2022

Analyze metadata of your Python project.

Analyze metadata of your Python projects Setup: Clone repo py-m venv venv (venv) pip install -r requirements.txt specify the folders which you want to

1 Nov 10, 2021

Audio Steganography is a technique used to transmit hidden information by modifying an audio signal in an imperceptible manner.

Audio Steganography Audio Steganography is a technique used to transmit hidden information by modifying an audio signal in an imperceptible manner. Ab

1 Oct 17, 2021

Conveniently measures the time of your loops, contexts and functions.

Related tags

Overview

Horology

Installation

Usage

Timing an iterable (list, tuple, generator, etc)

Quick example

More cool stuff:

Timing a function with a @timed decorator

Quick example

More cool stuff:

Timing part of code with a Timing context

Quick example

More cool stuff:

Time units

Contributions

Internals

You might also like...

Helpful functions for use alongside the rich Python library.

Run functions in parallel easily, with their results typed correctly!

Python @deprecat decorator to deprecate old python classes, functions or methods.

Dill_tils is a package that has my commonly used functions inside it for ease of use.

A collection of utility functions to prototype geometry processing research in python

A simple example for calling C++ functions in Python by `ctypes`.

Gradually automate your procedures, one step at a time

A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

jsoooooooon derulo - Make sure your 'jason derulo' is featured as the first part of your json data

Comments

[ADD] iterations in decorator

Releases(v1.2.0)

v1.2.0(Oct 1, 2021)

Features

Fixes

Docs

Tests and deployment

v1.1.0(Jan 14, 2020)

Feature

Fix

Docs

Tests:

Credits

v1.0.0(Dec 11, 2019)

Owner

Maciej J Mikulski

Python HTTP Agent Parser

Make some improvements in the Pizza class and pizzashop file by refactoring.

Bounding Boxes Python Utils

A quick username checker to see if a username is available on a list of assorted websites.

Implicit hierarchical a posteriori error estimates in FEniCSx

Aggregating gridded data (xarray) to polygons

A simple package for handling variables in string.

Pyfunctools is a module that provides functions, methods and classes that help in the creation of projects in python

✨ Un chois aléatoire d'un article sur Wikipedia totalement fait en Python par moi, et en français.

Color getter (including method to get random color or complementary color) made out of Python

password generator

Python USD rate in RUB parser

Analyze metadata of your Python project.

Audio Steganography is a technique used to transmit hidden information by modifying an audio signal in an imperceptible manner.

A fancy and practical functional tools

This utility synchronises spelling dictionaries from various tools with each other.

Python based tool to extract forensic info from EventTranscript.db (Windows Diagnostic Data)

A clock app, which helps you with routine tasks.

Export watched content from Tautulli to the Letterboxd CSV Import Format

A fixture that allows runtime xfail

`Horology`

Timing a function with a `@timed` decorator

Timing part of code with a `Timing` context