init_logging(
logfile: Path | None = None,
level: int | str = logging.INFO,
logfile_level: int | str = logging.INFO,
force: bool = False,
) -> None
Initialize logging with custom formats.
Adds a custom log levels RUN and APP which are higher than INFO and
lower than WARNING. RUN is used by the benchmark harness
and APP is using within the applications.
Usage
logger = init_logger(...)
logger.log(RUN_LOG_LEVEL, 'message')
Parameters:
-
logfile
(str, default:
None
)
–
option filepath to write log to (default: None).
-
level
((int, str), default:
INFO
)
–
minimum logging level (default: INFO).
-
logfile_level
((int, str), default:
INFO
)
–
minimum logging level for the logfile
(default: INFO).
-
force
(bool, default:
False
)
–
remove any existing handlers attached to the root
handler. This option is useful to silencing the third-party
package logging. Note: should not be set when running inside
pytest (default: False).
Source code in taps/logging.py
| def init_logging(
logfile: pathlib.Path | None = None,
level: int | str = logging.INFO,
logfile_level: int | str = logging.INFO,
force: bool = False,
) -> None:
"""Initialize logging with custom formats.
Adds a custom log levels RUN and APP which are higher than INFO and
lower than WARNING. RUN is used by the benchmark harness
and APP is using within the applications.
Usage:
>>> logger = init_logger(...)
>>> logger.log(RUN_LOG_LEVEL, 'message')
Args:
logfile (str): option filepath to write log to (default: None).
level (int, str): minimum logging level (default: INFO).
logfile_level (int, str): minimum logging level for the logfile
(default: INFO).
force (bool): remove any existing handlers attached to the root
handler. This option is useful to silencing the third-party
package logging. Note: should not be set when running inside
pytest (default: False).
"""
logging.addLevelName(RUN_LOG_LEVEL, 'RUN')
logging.addLevelName(APP_LOG_LEVEL, 'APP')
stdout_handler = logging.StreamHandler(sys.stdout)
stdout_handler.setLevel(level)
handlers: list[logging.Handler] = [stdout_handler]
if logfile is not None:
logfile.parent.mkdir(parents=True, exist_ok=True)
handler = logging.FileHandler(logfile)
handler.setLevel(logfile_level)
handlers.append(handler)
kwargs: dict[str, Any] = {}
if force: # pragma: no cover
kwargs['force'] = force
logging.basicConfig(
format=(
'[%(asctime)s.%(msecs)03d] %(levelname)-5s (%(name)s) :: '
'%(message)s'
),
datefmt='%Y-%m-%d %H:%M:%S',
level=logging.DEBUG,
handlers=handlers,
**kwargs,
)
|