Welcome to py-stopwatch’s documentation!

https://img.shields.io/pypi/v/py-stopwatch?color=success

Stopwatch class for timing portions of python code.

Free software: MIT license
Documentation: https://py-stopwatch.readthedocs.io.

Features

Tick-based stopwatch
Support for Pause/Resume
Support for multiple named-ticks
Utility functions for time between different ticks
No third party requirements.

py-stopwatch

Stopwatch class for timing portions of python code.

Free software: MIT license
Documentation: https://py-stopwatch.readthedocs.io.

Features

Tick-based stopwatch
Support for Pause/Resume
Support for multiple named-ticks
Utility functions for time between different ticks
No third party requirements.

Usage

from stopwatch import Stopwatch
t = Stopwatch()
t.start()
print("Started ..")
time.sleep(0.24)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.48)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.16)
print(f"t.tick('Named Tick-1'): {t.tick('Named Tick-1'):.4f} seconds")
t.pause()
print("Paused ..")
time.sleep(0.12)
t.resume()
print("Resumed ..")
print(f"t.last(): {t.last():.4f} seconds")
time.sleep(0.12)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.12)
print(f"t.tick('Named Tick-2'): {t.tick('Named Tick-2'):.4f} seconds")
t.stop()
print("Timer stopped.")
print("---")
print(f"Total pause: {t.time_paused:.2f} seconds.")
print(f"Total runtime: {t.time_active:.2f} seconds.")
print(f"Total time: {t.time_total:.2f} seconds.")
tij = t.time_elapsed(start_name='Named Tick-1', end_name='Named Tick-2')
print(f"Time between 'Named Tick-1' and 'Named Tick-2': {tij:.4f}")

Installation

Stable release

To install py-stopwatch, run this command in your terminal:

$ pip install py_stopwatch

This is the preferred method to install py-stopwatch, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for py-stopwatch can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/hrishikeshrt/py_stopwatch

Or download the tarball:

$ curl -OJL https://github.com/hrishikeshrt/py_stopwatch/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

from stopwatch import Stopwatch
t = Stopwatch()
t.start()
print("Started ..")
time.sleep(0.24)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.48)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.16)
print(f"t.tick('Named Tick-1'): {t.tick('Named Tick-1'):.4f} seconds")
t.pause()
print("Paused ..")
time.sleep(0.12)
t.resume()
print("Resumed ..")
print(f"t.last(): {t.last():.4f} seconds")
time.sleep(0.12)
print(f"t.tick(): {t.tick():.4f} seconds")
time.sleep(0.12)
print(f"t.tick('Named Tick-2'): {t.tick('Named Tick-2'):.4f} seconds")
t.stop()
print("Timer stopped.")
print("---")
print(f"Total pause: {t.time_paused:.2f} seconds.")
print(f"Total runtime: {t.time_active:.2f} seconds.")
print(f"Total time: {t.time_total:.2f} seconds.")
tij = t.time_elapsed(start_name='Named Tick-1', end_name='Named Tick-2')
print(f"Time between 'Named Tick-1' and 'Named Tick-2': {tij:.4f}")

stopwatch

stopwatch package

Submodules

stopwatch.stopwatch module

Stopwatch class for timing portions of python code

class stopwatch.stopwatch.Tick(time: float, action: str, name: str)[source]

Bases: object

time: float

action: str

name: str

class stopwatch.stopwatch.Stopwatch[source]

Bases: object

Stopwatch Instance

A typical lifecycle of the stopwatch:: [creation] –> [start] –> [tick, pause, resume] –> [stop]

start()[source]: Start the stopwatch

tick(name=None)[source]

Record a tick

Return type: Time since the last tick

pause()[source]: Pause the stopwatch (Ticks are not recorded until resumed)

resume()[source]

Resume

Return type: Time for which the instance was paused

stop()[source]

Stops the stopwatch

Return type: Total time (including pause-time)

get_time_paused(start_idx=0, end_idx=- 1)[source]: Get pause-time

property time_paused: Get pause-time

property time_active

property time_total

time_elapsed(start_idx=0, end_idx=- 1, start_name=None, end_name=None, exclude_pause=True)[source]

Get time elapsed between different ticks

Parameters: exclude_pause (boolean) – If True, pause-time is not counted. The default is True.
Return type: Total runtime (with or without pause-time)

last()[source]: Return the time between the last two ticks

current()[source]: Return the time elapsed since the last tick

stopwatch.stopwatch.main()[source]

Module contents

Stopwatch class for timing your python code with support for pause, resume and multiple named-ticks.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/hrishikeshrt/py_stopwatch/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

py-stopwatch could always use more documentation, whether as part of the official py-stopwatch docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/hrishikeshrt/py_stopwatch/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up py_stopwatch for local development.

Fork the py_stopwatch repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your-username-here/py_stopwatch.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv py_stopwatch
$ cd py_stopwatch/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 py_stopwatch tests
$ python setup.py test or pytest
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/hrishikeshrt/py_stopwatch/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_py_stopwatch

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Hrishikesh Terdalkar <hrishikeshrt@linuxmail.org>

Contributors

None yet. Why not be the first?

History

0.0.1 (2021-04-13)

First release on PyPI.

Welcome to py-stopwatch’s documentation!

Features

py-stopwatch

Features

Usage

Installation

Stable release

From sources

Usage

Usage

stopwatch

stopwatch package

Submodules

stopwatch.stopwatch module

Module contents

Contributing

Types of Contributions

Report Bugs

Fix Bugs

Implement Features

Write Documentation

Submit Feedback

Get Started!

Pull Request Guidelines

Tips

Deploying

Credits

Development Lead

Contributors

History

0.0.1 (2021-04-13)

Indices and tables