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.
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.2.5
Usage
✅ To run with default kwargs:
from penguin_py import penguin
@penguin()
def test_func(test1, test2=None):
# NOTE: this function can be anything!
for i in range(10000000):
pass
return "test", True
test = test_func("", test2=":")
✅ To run with user specified kwargs:
@penguin(
verbose=True,
show_args=True,
show_return=True,
foreground='cyan',
background='yellow',
)
def test_func(test1, test2=None):
for i in range(10000000):
pass
return "test", True
test = test_func("", 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 ()
.
@penguin
def test_func(test1, test2=None):
# NOTE: this function can be anything!
for i in range(10000000):
pass
return "test", True
test = test_func("", test2=":")
You'll get a TypeError
relating to arguments.
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:
False
- default:
show_args
: WhenTrue
, it shows the function's signature, with the*args
and**kwargs
being 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.
Project details
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.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a1c841cbe528fa1fdc310da23f2faf099a2c9c08cb0159eaa9438a06ca902d3 |
|
MD5 | 38cf179b7262e5cefef8bf8d8fe5b78f |
|
BLAKE2b-256 | a6753b2873a9c9bae0cf7d86ef5192895902c0258ba037473617c3b87c0caf42 |