A versatile timing decorator
Project description
Timeit Decorator
Overview
timeit_decorator is a Python package providing a versatile decorator for timing the execution of functions. It supports executing functions multiple times, in parallel, and can use either threading or multiprocessing depending on the nature of the task.
Installation
To install timeit_decorator, run the following command:
pip install timeit_decorator
Usage
Basic Usage
Here's a simple example of how to use the timeit decorator:
from timeit_decorator import timeit
@timeit(runs=5, workers=2)
def sample_function():
# Function implementation
Using Multiprocessing
For CPU-bound tasks, you can enable multiprocessing:
from timeit_decorator import timeit
@timeit(runs=10, workers=4, use_multiprocessing=True)
def cpu_intensive_function():
# CPU-bound function implementation
Using Threading (Default)
For I/O-bound tasks, the default threading is more efficient:
from timeit_decorator import timeit
@timeit(runs=5, workers=2)
def io_bound_function():
# I/O-bound function implementation
Features
- Multiple Runs: Execute the function multiple times for more accurate timing.
- Concurrency: Run tasks in parallel using either threading or multiprocessing.
- Flexible: Suitable for both CPU-bound and I/O-bound tasks.
- Customizable: Control the number of runs and workers, and choose between threading and multiprocessing.
Requirements
timeit_decorator requires Python 3.x.
Contributing
Contributions to timeit_decorator are welcome! Please read our contributing guidelines for more details.
License
timeit_decorator is released under the MIT License.
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
Built Distribution
Hashes for timeit_decorator-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 971fcd79832ce9dfd1599d7ee44842ac1582bf44b5157f6919f8e3f69db32a5c |
|
MD5 | e633d0bc8936a2e6b9b6898b4a132240 |
|
BLAKE2b-256 | b89aca334fd934e7ba652533dec53eda1189d791172ea52bd094d5387b0c2a46 |