Skip to content

academy.logging.configs.base

LogConfig 

LogConfig()

Bases: ABC

Implementations of this class can initialize Academy logging.

Academy logging is built around Python's logging system, with an Academy-provided configuration system that allows multiple configurations to be initialized and deinitialized within the same process.

Configurations which might be shared between processes should expect to be pickled/unpickled multiple times as they move around an Academy distributed system.

A log configuration is identified across the distributed system by the uuid attribute. This allows the log_context context manager to only initialize a particular configuration once per process, and only deinitialize it when all users of it are finished with it.

Source code in academy/logging/configs/base.py 
26
27
def __init__(self) -> None:
    self.uuid = str(uuid.uuid4())

init_logging abstractmethod 

init_logging() -> Callable[[], None]

Initialize logging in current process.

This should not be called by end users. Instead, users should use with log_context(config) to ensure that the configuration is initialized and deinitialized properly when there are overlapping uses of the same configuration.

This should return a callback to uninitialize the logging initialized by this call. log_context will call that callback when appropriate.

Source code in academy/logging/configs/base.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
@abc.abstractmethod
def init_logging(self) -> Callable[[], None]:
    """Initialize logging in current process.

    This should not be called by end users. Instead, users should use
    `with log_context(config)` to ensure that the configuration is
    initialized and deinitialized properly when there are overlapping
    uses of the same configuration.

    This should return a callback to uninitialize the logging initialized
    by this call. `log_context` will call that callback when appropriate.
    """
    ...