mirror of
https://gitlab.archlinux.org/archlinux/aurweb.git
synced 2025-02-03 10:43:03 +01:00
7bcc8d7ce7
This variable allows users to override the logging.conf used for Python logging configuration. By default, this is set to logging.conf, which is a production config. LOG_CONFIG is treated relative to [options] aurwebdir. This patch allows us to specify the logging config as opposed to copying over logging.conf in our test docker and gitlab test scripts, as well as ease-of-testing as a developer. Signed-off-by: Kevin Morris <kevr@0cost.org>
26 lines
840 B
Python
26 lines
840 B
Python
import logging
|
|
import logging.config
|
|
import os
|
|
|
|
import aurweb.config
|
|
|
|
# For testing, users should set LOG_CONFIG=logging.test.conf
|
|
# We test against various debug log output.
|
|
aurwebdir = aurweb.config.get("options", "aurwebdir")
|
|
log_config = os.environ.get("LOG_CONFIG", "logging.conf")
|
|
config_path = os.path.join(aurwebdir, log_config)
|
|
|
|
logging.config.fileConfig(config_path, disable_existing_loggers=False)
|
|
logging.getLogger("root").addHandler(logging.NullHandler())
|
|
|
|
|
|
def get_logger(name: str) -> logging.Logger:
|
|
""" A logging.getLogger wrapper. Importing this function and
|
|
using it to get a module-local logger ensures that logging.conf
|
|
initialization is performed wherever loggers are used.
|
|
|
|
:param name: Logger name; typically `__name__`
|
|
:returns: name's logging.Logger
|
|
"""
|
|
|
|
return logging.getLogger(name)
|