File size: 3,156 Bytes
12d2e9e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
"""
Copyright 2021, Dana-Farber Cancer Institute and Weill Cornell Medicine
License: GNU GPL 2.0
"""
import functools
import sys
from loguru import logger
class PathMLLogger:
"""
Convenience methods for turning on or off and configuring logging for PathML.
Note that this can also be achieved by interfacing with loguru directly
Example::
from pathml import PathMLLogger as pml
# turn on logging for PathML
pml.enable()
# turn off logging for PathML
pml.disable()
# turn on logging and output logs to a file named 'logs.txt', with colorization enabled
pml.enable(sink="logs.txt", colorize=True)
"""
logger.disable("pathml")
logger.disable(__name__)
@staticmethod
def disable():
"""
Turn off logging for PathML
"""
logger.disable("pathml")
logger.disable(__name__)
logger.info(
"Disabled Logging For PathML! If you are seeing this, there is a problem"
)
@staticmethod
def enable(
sink=sys.stderr,
level="DEBUG",
fmt="PathML:{level}:{time:HH:mm:ss} | {module}:{function}:{line} | {message}",
**kwargs
):
"""
Turn on and configure logging for PathML
Args:
sink (str or io._io.TextIOWrapper, optional):
Destination sink for log messages. Defaults to ``sys.stderr``.
level (str):
level of logs to capture. Defaults to 'DEBUG'.
fmt (str):
Formatting for the log message. Defaults to: 'PathML:{level}:{time:HH:mm:ss} | {module}:{function}:{line} | {message}'
**kwargs (dict, optional):
additional options passed to configure logger. See:
`loguru documentation <https://loguru.readthedocs.io/en/stable/api/logger.html#loguru._logger.Logger.add>`_
"""
logger.enable("pathml")
logger.enable(__name__)
# remove pre-configured logger (https://github.com/Delgan/loguru/issues/208#issuecomment-581002215)
logger.remove(0)
handler_id = logger.add(sink=sink, level=level, format=fmt, **kwargs)
logger.info("Enabled Logging For PathML!")
return handler_id
# courtesy of the people at loguru
# https://loguru.readthedocs.io/en/stable/resources/recipes.html#:~:text=or%20fallback%20policy.-,Logging%20entry%20and%20exit%20of%20functions%20with%20a%20decorator,-%EF%83%81
def logger_wraps(*, entry=True, exit=True, level="DEBUG"):
def wrapper(func):
name = func.__name__
@functools.wraps(func)
def wrapped(*args, **kwargs):
logger_ = logger.opt(depth=1)
if entry:
logger_.bind(enter_exit=True).log(
level, "Entering '{}' (args={}, kwargs={})", name, args, kwargs
)
result = func(*args, **kwargs)
if exit:
logger_.bind(enter_exit=True).log(
level, "Exiting '{}' (result={})", name, result
)
return result
return wrapped
return wrapper
|