Upgrade your print statements

Loggers are like print() statements

except they also include loads of other metadata:

• timestamp
• msg (same as print!)
• args (values or variables put into functions)
• function name
• level (e.g. DEBUG)
• line number (e.g line 42)
• module (which python script it came from)
• processes (getting fancy)
• threads (getting very fancy)

I want it all WITHOUT CONFIGURATION!

No problems. Check out the Loguru repo!
You can pretty much run with minimal config and loads of features. Loguru has all the features of this repo and more, along with a badass logo.

Where do I start?

This repo comes bundled with tidy logging configuration files saved in src/logconfig/.
There is also a timing decorator in src/utils/ so you can optimize your code by simply decorating your function with @timing above it. There are many online articles but very few clearly explain how to configure complex loggers with filters and yaml files.
To see loggers in action, setup a virtual environment and then run src/mainmodule.py

Requirements

• Python 3.6+

^{(Feel free to submit earlier versions that work)}

Quickstart - Git clone and virtual env setup

git clone https://github.com/izzley/loggerexamples
cd loggerexamples\
py -0p # Optional: check your version and python path
py -m venv .venv
.venv\Scripts\activate
pip install --upgrade pip
pip install -r requirements.txt

# run main script
.\src\main.py

cd /to/clone/location
git clone https://github.com/izzley/loggerexamples
cd loggerexamples/
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

$ echo $(pwd) >> .venv/lib/python3.8/site-packages/my_p_ext.pth

Play with the logger

Whats in the YAML file??

formatters:
    standard:
        format: "%(asctime)s %(levelname)s - [%(filename)s: line %(lineno)s] - %(funcName)s - %(message)s"

def funccalc(n):
    logger.debug("something executed")
    for _ in range(n):
        i = 0
    return

2021-11-21 15:43:47,689 DEBUG - [module01.py: line 17] - funccalc - something executed

root:
  level: DEBUG
  handlers: [console, debug_file_handler, info_file_handler, warn_file_handler, error_file_handler, critical_file_handler, root_file_handler]

References

• Docs: https://docs.python.org/3/library/logging.html#module-logging
• lots of logging examples: https://zetcode.com/python/logging/
• loguru. Everyone should know about it: https://github.com/Delgan/loguru#readme
• rich logging handler makes it pretty: https://rich.readthedocs.io/en/stable/logging.html
• filters explained: https://gist.github.com/kingspp/9451566a5555fb022215ca2b7b802f19
• timeit vs decorator: https://stackoverflow.com/questions/1622943/timeit-versus-timing-decorator
• real python uses perf_counter: https://realpython.com/lessons/timing-functions-decorators/
• What are decorators: https://gist.github.com/Zearin/2f40b7b9cfc51132851a
• Decorators can be reinforced to accept args: https://stackoverflow.com/questions/653368/how-to-create-a-python-decorator-that-can-be-used-either-with-or-without-paramet