A decorator for methods to log the execution time (sync and async)
Project description
sag_py_execution_time_decorator
A decorator for methods to log the execution time (sync and async)
What it does
- Logs the execution time in milliseconds
Sample log entry:
decorated_sync_method took 1000 ms.
The entry contains "function_name" and "execution_time" as extra data.
Installation
pip install sag-py-execution-time-decorator
How to use
Decorate your methods like that:
from sag_py_execution_time_decorator.execution_time_decorator import log_execution_time
@log_execution_time()
def decorated_sync_method(param: str) -> str:
time.sleep(SLEEP_TIME_MS / 1000)
return f"test: {param}"
@log_execution_time(log_level=logging.ERROR, log_params=("param",))
async def decorated_async_method(param: str) -> str:
await asyncio.sleep(SLEEP_TIME_MS / 1000)
return f"test: {param}"
Optional arguments:
Argument | Description | Default |
---|---|---|
log_level | The log level integar. Use logging.* constants | logging.INFO |
logger_name | The name of the logger that is internally used for logging.getLogger | execution_time_decorator |
log_params | A tuple of parameter names to be logged with their values in 'extra' | () |
How to start developing
With vscode
Just install vscode with dev containers extension. All required extensions and configurations are prepared automatically.
With pycharm
- Install latest pycharm
- Install pycharm plugin BlackConnect
- Install pycharm plugin Mypy
- Configure the python interpreter/venv
- pip install requirements-dev.txt
- pip install black[d]
- Ctl+Alt+S => Check Tools => BlackConnect => Trigger when saving changed files
- Ctl+Alt+S => Check Tools => BlackConnect => Trigger on code reformat
- Ctl+Alt+S => Click Tools => BlackConnect => "Load from pyproject.yaml" (ensure line length is 120)
- Ctl+Alt+S => Click Tools => BlackConnect => Configure path to the blackd.exe at the "local instance" config (e.g. C:\Python310\Scripts\blackd.exe)
- Ctl+Alt+S => Click Tools => Actions on save => Reformat code
- Restart pycharm
How to publish
- Update the version in setup.py and commit your change
- Create a tag with the same version number
- Let github do the rest
How to test
To avoid publishing to pypi unnecessarily you can do as follows
- Tag your branch however you like
- Use the chosen tag in the requirements.txt-file of the project you want to test this library in, eg.
sag_py_execution_time_decorator==<your tag>
- Rebuild/redeploy your project
Project details
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
File details
Details for the file sag_py_execution_time_decorator-2.1.1.tar.gz
.
File metadata
- Download URL: sag_py_execution_time_decorator-2.1.1.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1df269169e564049e2484c2411f252c6a0892fdeba8d60f30c4c9790dcb3717c |
|
MD5 | 22874213c5d7e2eabcb10a8e8e8a56cb |
|
BLAKE2b-256 | 5069d3550884388432a593ac63ce0fd362a12a3f9b989c53274ebe53a6c324b8 |
File details
Details for the file sag_py_execution_time_decorator-2.1.1-py3-none-any.whl
.
File metadata
- Download URL: sag_py_execution_time_decorator-2.1.1-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 858d294ffa4e4ba8e089f9218162f87c6c42eb435847a850b293225461a31507 |
|
MD5 | d37b1dc3855811414cd28539de4baab5 |
|
BLAKE2b-256 | fe7451e220cbbb9edde2fd4716aca8a240e52e462c0acbf6d23db8beb483dd47 |