Skip to content

Fix config.toml property for logging always being overwritten by argparse default #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahester57 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix config.toml property for logging always being overwritten by argparse default #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9fd8fac
cli.py: fix KeyError when logging missing from config.toml
ahester57 Feb 25, 2024
168cecc
logger.py: add NoneGuard to enable logger arg defaults
ahester57 Feb 25, 2024
4929cd6
logger.py: Class constant added
ahester57 Feb 25, 2024
563a750
Merge pull request #1 from ahester57/patch-1
ahester57 Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions {{cookiecutter.project_slug}}/src/{{cookiecutter.app_name}}/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def main(argv=None) -> int:
if args.warn:
config.core.logging = args.warn
logger.stop() # clear handlers to prevent duplicate records
logger.start(config.core.logging)
logger.start(config.core.get("logging")) # dict.get() enables logger arg defaults
command = args.command
args = vars(args)
spec = getfullargspec(command)
Expand All @@ -55,8 +55,8 @@ def _args(argv):
parser.add_argument("-v", "--version", action="version",
version=f"{{ cookiecutter.app_name }} {__version__}",
help="print version and exit")
parser.add_argument("-w", "--warn", default="WARNING",
help="logger warning level [WARNING]")
parser.add_argument("-w", "--warn", # default not needed due to logger.start having default
help="logger warning level [WARN]")
parser.set_defaults(command=None)
subparsers = parser.add_subparsers(title="subcommands")
common = ArgumentParser(add_help=False) # common subcommand arguments
Expand Down
5 changes: 3 additions & 2 deletions {{cookiecutter.project_slug}}/src/{{cookiecutter.app_name}}/core/logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class _Logger(getLoggerClass()):

"""
LOGFMT = "%(asctime)s;%(levelname)s;%(name)s;%(message)s"
DFLTLEVEL = "WARN"

def __init__(self, name=None):
""" Initialize this logger.
Expand All @@ -34,7 +35,7 @@ def __init__(self, name=None):
self.addHandler(NullHandler()) # default to no output
return

def start(self, level="WARN", stream=None):
def start(self, level=DFLTLEVEL, stream=None):
""" Start logging to a stream.

Until the logger is started, no messages will be emitted. This applies
Expand All @@ -59,7 +60,7 @@ def start(self, level="WARN", stream=None):
:param level: logger priority level
:param stream: output stream (stderr by default)
"""
self.setLevel(level.upper())
self.setLevel(level.upper() if level is not None else self.DFLTLEVEL)
handler = StreamHandler(stream)
handler.setFormatter(Formatter(self.LOGFMT))
handler.setLevel(self.level)
Expand Down