A minimal boilerplate logger for functions.
To install DecLog, use pip to install the latest version from PyPI.
$ pip install declog
Analysis code is typically run through a main processing function, which draws together library code to produce a meaningful result.
The logger is applied as a decorator to the processing function,
and captures the function arguments, intermediate values marked
with log and the return value.
from declog import log
from declog.logger import DefaultLogger
@DefaultLogger
def my_processing_function(a, b, c=2, d=3.14):
ab = a * b
log(ab, 'ab')
cd = c - d
log(cd)
return ab + cd
if __name__ == '__main__':
my_processing_function(1, 5)
print(DefaultLogger.db)The BaseLogger is designed to be flexible, in the above example the base class BaseDatabase is used which only saves logged items to a dictionary in memory. For use as a proper logger, the database must be saved to memory. View the reference for options or create your own backend as in the tutorial.
For more information on usage, check out the about page or tutorials in the docs.
All contributions are welcome! Please raise an issue or make a pull request.