pytimers

Pytimers

.. inclusion-marker-start

Pytimers is a python micro library that allows you to quickly measure time to run functions, methods or individual blocks of codes. Here's a quick demo.

.. code-block:: python

import logging
from time import sleep

from pytimers import timer

logging.basicConfig(level=logging.INFO)


@timer
def foo() -> None:
    print("Some heavy lifting.")
    sleep(2)


if __name__ == "__main__":

    print("Let's call the function decorated with timer.")
    foo()

    print("Use timer context manager.")
    with timer.label("sleeping block"):
        print("Some more work to do.")
        sleep(1)

.. code-block:: console

Let's call the function decorated with timer.
Some heavy lifting.
INFO:pytimers.triggers.logger_trigger:Finished foo in 2s 0.494ms [2.0s].
Use timer context manager.
Some more work to do.
INFO:pytimers.triggers.logger_trigger:Finished sleeping block in 1s 1.247ms [1.001s].

.. inclusion-marker-end

See the full Documentation <https://pytimers.readthedocs.io/en/latest/>_.

Build Status

.. image:: https://github.com/michalfilippi/pytimers/actions/workflows/test.yml/badge.svg
   :alt: Unit Tests
   :align: left

|

.. image:: https://github.com/michalfilippi/pytimers/actions/workflows/code_style.yml/badge.svg
   :alt: Code Style Check
   :align: left

|

PyPi
~~~~

.. image:: https://img.shields.io/pypi/v/pytimers.svg
   :target: https://pypi.python.org/pypi/pytimers/
   :alt: PyPi
   :align: left

|

.. image:: https://img.shields.io/pypi/l/pytimers.svg
   :target: https://pypi.python.org/pypi/pytimers/
   :alt: PyPI - License
   :align: left

|

.. image:: https://img.shields.io/pypi/pyversions/pytimers.svg
   :target: https://pypi.python.org/pypi/pytimers/
   :alt: PyPi - Python Version
   :align: left

|

.. image:: https://img.shields.io/pypi/implementation/pytimers.svg
   :target: https://pypi.python.org/pypi/pytimers/
   :alt: PyPi - Implementation
   :align: left

|