tempit 0.1.1

A dead simple time decorator

Tempit

Tempit is a Python package designed to simplify the process of measuring the execution time of your functions through a straightforward decorator.

Installation

You can install Tempit using pip:

pip install tempit

Usage

Below are some examples demonstrating Tempit's usage:

Basic Usage

from tempit import tempit

@tempit
def my_function():
    # Normal code of your function
    pass

my_function()

This will output something like:

Function my_function took 10.5908ms.

Advanced Usage

from tempit import tempit
@tempit(run_times=20, concurrency_mode="multithreading", verbose=True)
def my_function_with_args(a:int = 1, b:int = 2):
    return a + b

result = my_function_with_args(1, b=2)

This will provide detailed output:

***** tempit data for function my_function_with_args: *****
Function name: my_function_with_args
        Funcion object: <function my_function_with_args at 0x0000000000000000>
        Args: (1,)
        Kwargs: {'b': 2}
        Run times: 20
        Mean: 0.7000µs
        Median: 0.8000µs
        Min: 0.4000µs
        Max: 1.0000µs
        Standard deviation: 0.2828µs
        Sum time: 3.5000µs
        Real time: 965.1000µs
***** End of tempit data. *****

More examples can be found in the examples.py script.

Features

• Simplified usage.
• Accurate measurement of function execution time.
• Support for classmethod and staticmethods.
• Multithreading mode for performance measurement.
• Human-readable time formatting.
• Optional verbose mode for detailed information.

Parameters

Using the decorator @tempit without any parameters executes the function once and displays the execution time. However, you can enhance the experience using the following arguments:

• run_times (int, optional): Specifies the number of function executions. Defaults to 1.
• concurrency_mode (str, optional): Determines the concurrency mode for function execution. Options are "multithreading" and "none". Defaults to "multithreading".
• verbose (bool, optional): Controls whether detailed information is printed after execution. Defaults to False.

Contributing

Contributions are welcome! Please follow these guidelines when contributing:

1. Fork the repository.
2. Create a new branch for your changes.
3. Implement your changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request.

Testing

The package has been thoroughly tested using unittesting. Test cases can be found in the tests folder and can be executed using make test.

License

This project is licensed under the MIT License.

Contributors

• Mario Crespo