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 a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an ‘encoding’ attribute, it is used to determine how to do the output to the stream.

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.