From 03e58301330ad5925bb24b0d23c5fd6bcebf37e4 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Mon, 9 Nov 2020 11:04:40 -0800 Subject: [PATCH] Add some docstrings. --- voussoirkit/vlogging.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/voussoirkit/vlogging.py b/voussoirkit/vlogging.py index 2215727..54576bd 100644 --- a/voussoirkit/vlogging.py +++ b/voussoirkit/vlogging.py @@ -14,6 +14,20 @@ def add_loud(log): log.loud = lambda *args, **kwargs: log.log(LOUD, *args, **kwargs) def get_level_by_argv(argv): + ''' + If any of the following arguments are present in argv, return the + corresponding log level along with a new copy of argv that has had the + argument string removed. + + Since we are removing the argument, your argparser should not have options + with these same names. + + --loud: LOUD + --debug: DEBUG + --quiet: ERROR + --silent: 99999999999 + none of the above: INFO + ''' argv = argv[:] if '--loud' in argv: @@ -34,6 +48,12 @@ def get_level_by_argv(argv): return (level, argv) def set_level_by_argv(log, argv): + ''' + This function is helpful for single-file scripts where you instantiate the + logger in the global scope, and use this function to set its level + according to the "--debug" flags in argv, then pass the rest of argv to + your argparser. + ''' basicConfig() (level, argv) = get_level_by_argv(argv)