For easy configuration of `logging.Logger`s with `argparse.Action`s.
Project description
logging-actions
For easy configuration of logging.Logger
s with argparse.Action
s.
Use it like this:
>>> from logging_actions import log_level_action
>>> from argparse import ArgumentParser
>>> import logging
>>> logger = logging.getLogger("foo") # Create your script's logger
>>> logger.addHandler(logging.StreamHandler()) # Don't forget to add a handler!
>>> parser = ArgumentParser()
>>> _ = parser.add_argument("--log-level", action=log_level_action(logger)) # create an action for your module's logger
>>> args = parser.parse_args() # Your logger's level will be set for you when parsing
Features
Choices are handled transparently
foo.py --help
usage: foo.py [-h] [--log-level {critical,fatal,error,warn,warning,info,debug,notset}]
optional arguments:
-h, --help show this help message and exit
--log-level {critical,fatal,error,warn,warning,info,debug,notset}
Set the logging level for foo.
If you specify a default the log-level will be set accordingly
parser.add_argument("-l", "--log-level", action=log_level_action(logger), default="info")
Custom levels are supported
logging.addLevelName(5, "TRACE")
parser.add_argument("-l", action=log_level_action(logger), default="trace")
Benefits
A better logging pattern
This replaces the following pattern for setting script log levels
from argparse import ArgumentParser
parser = ArgumentParser()
parser.add_argument(
"--log-level",
default=logging.INFO,
type=lambda x: getattr(logging, x)),
help="Configure the logging level.",
)
args = parser.parse_args()
logging.basicConfig(level=args.log_level)
Manage multiple loggers easily
parser.add_argment("--foo-log-level", action=log_level_action(foo_logger))
parser.add_argment("--bar-log-level", action=log_level_action(bar_logger))
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
logging-actions-0.1.6.tar.gz
(3.1 kB
view hashes)
Built Distribution
Close
Hashes for logging_actions-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e760f2824a61160e340fa6857570dd3194fd3cf755afc49454a7298163752d9 |
|
MD5 | 1e1cd370df1fdf68a1614a7c6bdb24b9 |
|
BLAKE2b-256 | 683cfd21e23a21406274b1f9f991513488b054ec23d16633e55ad3f3e4b59ec7 |