Logging (`taurex.log`)¶

Logger¶

Taurex logging module.

class Loggable(name: str | None = None)[source]¶

Bases: object

Base class for loggable objects.

critical(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

debug(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

error(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

error_and_raise(exception: Type[Exception], message: str, *args: Any, **kwargs: Any) → Exception[source]¶: Print error message and raises exception.

info(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

warning(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

class TauRexHandler(stream: IOBase | None = None)[source]¶

Bases: StreamHandler

Logging Handler for Taurex 3.

Prevents other MPI threads from writing to log unless they are in trouble (>=ERROR)

Parameters:: stream (stream-object , optional) – Stream to write to otherwise defaults to stderr

emit(record: LogRecord) → None[source]¶: Emit log record.

setup_log(name: str) → Logger[source]¶

Build a logger class for the given name.

Parameters:: name (str) – Name of logger
Returns:: Logger class
Return type:: logging.Logger

Module contents¶

Main logging module.

class Loggable(name: str | None = None)[source]¶

Bases: object

Base class for loggable objects.

critical(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

debug(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

error(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

error_and_raise(exception: Type[Exception], message: str, *args: Any, **kwargs: Any) → Exception[source]¶: Print error message and raises exception.

info(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

warning(message: str, *args: Any, **kwargs: Any) → None[source]¶: See logging.Logger.

Logger¶: alias of Loggable

disableLogging() → None[source]¶: Disable logging.

enableLogging() → None[source]¶: Enable logging.

setLogLevel(level: int) → None[source]¶

Set the log level.

Parameters:: level (int) – Log level to set.

setup_log(name: str) → Logger[source]¶

Build a logger class for the given name.

Parameters:: name (str) – Name of logger
Returns:: Logger class
Return type:: logging.Logger