asdftimer 0.1.2

Simple customizable Python timer.

Asdftimer

asdftimer is a simple Python utility class for measuring elapsed time. It provides an easy-to-use interface for timing code execution, with support for logging and context management.

Features

• Measure elapsed time.
• Log elapsed time using a custom logger or print().
• Restart the timer at any point.
• Use as a context manager for automatic timing.

Installation

pip install asdftimer

Usage

Basic Usage

from asdftimer import Timer
from time import sleep

timer = Timer()
sleep(2.4)
elapsed_time = timer.stop()
# Output: AsdfTimer took 2.40 seconds

Using a Custom Logger

from asdftimer.timer import Timer
import logging
logger = logging.getLogger(__name__)

timer = Timer(name="LoggedTimer", logger=logger)
# ur code here
timer.stop()
# Output: LoggedTimer took X seconds

Timing a context

from asdftimer.timer import Timer
with Timer(name="ContextTimer") as timer:
    pass # ur code here
# Output: ContextTimer took X seconds

API Reference

Timer

__init__(name="AsdfTimer", logger=None, disable_print=False, print_digits=2)

• name (str): The name of the timer. Defaults to "AsdfTimer".
• logger (Logger): A logger instance for logging. Uses print() if None.
• disable_print (bool): Whether to disable logging/printing the elapsed time. Defaults to False.
• print_digits (int): Number of decimal places to print for elapsed time. Defaults to 2.

stop() -> float

Pauses the timer and outputs/returns the elapsed time in seconds.

restart() -> None

Restarts the timer.

__enter__()

Starts the timer when used as a context manager.

__exit__(exc_type, exc_value, traceback)

Stops the timer and outputs the elapsed time when exiting the context.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve asdftimer.

Author

Developed by Nibs.