timer-for-python 0.7.0

Timer for Python

⏳ Timer for Python ⌛️

Lightweight Python package that makes it easy to measure how much time it takes to run Python programs and gauge performance of multiple, smaller bits of code.

Prerequisites

• Python 3.10 or higher

Installation

PyPI

Assuming that Python is installed already, execute this command in the terminal:

pip3 install timer-for-python

If you already have installed Timer for Python, use this command to upgrade to latest version:

pip3 install --upgrade timer-for-python

Homebrew

If you already have installed the Homebrew package manager for Mac and Linux, execute this terminal command to tap Timer for Python:

brew tap jakob-bagterp/timer-for-python

And then install:

brew install timer-for-python

NuGet

TBC

Getting Started

Basic

Firstly, add the Timer to your imports:

from timer import Timer

Wrap the Timer function around your code to measure performance of the executed block of code:

timer = Timer()
timer.start()

# Insert your code here

timer.stop() # Output example: 12.34 seconds

With Statement

Alternatively, use the with statement, which automatically will stop the Timer. Same result with less code:

with Timer():
    # Insert your code here

# Output example: 12.34 seconds

Decorator

Or use the benchmark_timer as function decorator:

from timer import benchmark_timer

@benchmark_timer
def test_function():
    # Insert your code here

test_function()

# Output example: 12.34 seconds for thread TEST_FUNCTION

Advanced

Decimals

Instead of the default value 2 for decimals, you can set the output precision up to 9 in the decimals argument:

timer = Timer()
timer.start(decimals=5)

# Insert your code here

timer.stop() # Output example: 0.12345 seconds

Multiple Threads

Imagine that you want to troubleshoot which parts of your code are performing better or worse? Or you want to split test the performance of different methods? Timer for Python is a quick, easy way to get the job done.

To measure performance of multiple blocks of code, use the thread argument to name different threads:

timer = Timer()
timer.start(thread="A")

# Insert your code here

    timer.start(thread="B", decimals=5)

    # Insert more code here

    timer.stop(thread="B") # Output example: 0.12345 seconds for thread B

# Insert even more code here

timer.stop(thread="A") # Output example: 6.78 seconds for thread A

Or use the with statement to get the same result with less code:

with Timer(thread="A")
    # Insert your code here

    with Timer(thread="B", decimals=5):
        # Insert more code here

    # Output example: 0.12345 seconds for thread B

# Insert even more code here

# Output example: 6.78 seconds for thread A

Documentation and Other Features

Precision in Nanoseconds

Timer for Python uses the native time.perf_counter_ns() function for maximum resolution in nanoseconds.

Decimals in Output

To set the number of decimals in the output (only if less than an hour), use the decimals argument.

Either, set the general precision of decimals when initiating the Timer:

timer = Timer(decimals=5)
timer.start()

# Insert your code here

timer.stop() # Output example: 0.12345 seconds

Or set the decimals when starting a new thread, which will also override the general decimals defined when initiating the Timer:

timer = Timer(decimals=5)
timer.start(decimals=9)

# Insert your code here

timer.stop() # Output example: 0.123456789 seconds

Default Decimals and Supported Interval

Default value for decimals is 2. The range is minimum 0 (for no decimals) and up to 9.

Humanised Output

Timer for Python supports time measurement from nanoseconds to days.

But. If the Timer runs for several minutes, it doesn't make sense to display the output time in milliseconds. And similarly if it runs for hours, it doesn't make sense to display the output time in seconds.

Therefore, the output is "humanised" so it's easier to read. Examples:

Elapsed time: 123 nanoseconds
Elapsed time: 4.56 microseconds
Elapsed time: 56.78 milliseconds
Elapsed time: 7.89 seconds
Elapsed time: 67.89 seconds (1m 8s)
Elapsed time: 3m 4s
Elapsed time: 2h 3m 4s
Elapsed time: 1d 2h 3m 4s

Graceful Error Handling

Timer for Python is designed with several nested try/catch clauses so it handles exceptions gracefully and therefore shouldn't break your application while running. However, if you find a bug, please report it.

Donate

This module is free to use. And if you like it, feel free to buy me a coffee.

Contribute

If you have suggestions or changes to the module, feel free to add to the code and create a pull request.

Report Bugs

Report bugs and issues here.

MIT License

Copyright (c) 2020 – present Jakob Bagterp

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.