Penguin: a customizable stopwatch decorator
Project description
🐧 penguin-py 🐧
Penguin is a lightweight, customizable stopwatch ⏱ decorator that helps you determine how long it takes for your functions to run. It supports both synchronous and asynchronous functions.
Source code
The source code of this package lives here: https://github.com/espitiaandres/penguin
Installation
With Command Line
To install penguin-py with the command line, run this command:
pip install penguin-py.
With a requirements.txt file
To install penguin-py using a requirements.txt file, add this line to your requirements.txt file.
penguin-py==0.3.8
Usage
Synchronous Functions
For synchronous functions, use the @penguin() decorator.
✅ To run with default kwargs:
from penguin_py import penguin
@penguin()
def foo(test1, test2=None):
# Note: this function can be anything!
for i in range(10000000):
pass
return "test", True
test = foo("", test2="")
✅ To run with user specified kwargs:
@penguin(
verbose=True,
show_args=True,
show_return=True,
foreground='cyan',
background='yellow',
)
def foo(test1, test2=None):
for i in range(10000000):
pass
return "test", True
test = foo("", test2="")
Note: For a more detailed list of all kwargs and their defaults, visit this section: List of kwargs
❌ Since penguin is a decorator that takes in kwargs, do not call it without the brackets ().
from penguin_py import penguin
@penguin
def foo(test1, test2=None):
# Note: this function can be anything!
for i in range(10000000):
pass
return "test", True
test = test_func("", test2=":")
If you do this, you'll get a TypeError relating to arguments.
Asynchronous Functions
For asynchronous functions, use the @penguin_async() decorator.
✅ To run with default kwargs:
from penguin_py import penguin
@penguin_async()
def foo(test1, test2=None):
# Note: this function can be anything!
for i in range(10000000):
pass
return "test", True
test = foo("", test2="")
This will output the following to your logger:
✅ To run with user specified kwargs:
@penguin(
verbose=True,
show_args=True,
show_return=True,
foreground='cyan',
background='yellow',
)
def foo(test1, test2=None):
for i in range(10000000):
pass
return "test", True
test = foo("", test2="")
This will output the following to your logger:
List of kwargs
verbose: WhenTrue, it shows all logs that are described by the other kwargs. WhenFalse, each kwarg would determine if that specific log is shown - default:Falseshow_args: WhenTrue, it shows the function's signature, with the*argsand**kwargsbeing passed in.- default:
False
- default:
show_return: WhenTrue, it shows the function's return value(s).- default:
False
- default:
foreground: When chosen from this list,["red", "yellow", "green", "blue", "magenta", "cyan", "grey"], it colour the logger output text the chosen colour.- default:
"grey"
- default:
background: When chosen from this list,["red", "yellow", "green", "blue", "magenta", "cyan", "grey", "black", "white"], it colour the logger output background the chosen colour.- default:
"black"
- default:
Documentation
Documentation of penguin-py can be found here: https://github.com/espitiaandres/penguin/blob/master/README.md
Bugs/Requests
If you find any bugs or have any suggestions to penguin-py, submit them in the issues tab in the Github repo. This can be found here: https://github.com/espitiaandres/penguin/issues
License
Distributed under the terms of the MIT license, penguin-py is free and open source software.
Release history Release notifications | RSS feed
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 penguin_py-0.3.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 611e2068ec32d490d8a688daf9c942649cf7c7fe3cdf8e4ed5058a69484f48fd |
|
| MD5 | b82942132e97ebf9556d83daaa68898a |
|
| BLAKE2b-256 | bc5d3298f2037dae6f1c7a053408f3f1441b3eb56d871965e8546353eef216df |
