gemseo / utils

# logging_tools module¶

## Logging tools¶

Classes:

 MultiLineFileHandler(filename[, mode, ...]) FileHandler to split multiline logging messages. Stateless mixin class to override logging handlers behavior. MultiLineStreamHandler([stream]) StreamHandler to split multiline logging messages.
class gemseo.utils.logging_tools.MultiLineFileHandler(filename, mode='a', encoding=None, delay=False)[source]

Bases: gemseo.utils.logging_tools.MultiLineHandlerMixin, logging.FileHandler

FileHandler to split multiline logging messages.

Open the specified file and use it as the stream for logging.

Methods:

 Acquire the I/O thread lock. addFilter(filter) Add the specified filter to this handler. Closes the stream. Acquire a thread lock for serializing access to the underlying I/O. emit(record) Emit one logging message per input record line. filter(record) Determine if a record is loggable by consulting all the filters. Flushes the stream. format(record) Format the specified record. handle(record) Conditionally emit the specified logging record. handleError(record) Handle errors which occur during an emit() call. Release the I/O thread lock. removeFilter(filter) Remove the specified filter from this handler. Set the formatter for this handler. setLevel(level) Set the logging level of this handler. setStream(stream) Sets the StreamHandler's stream to the specified value, if it is different. set_name(name)

Attributes:

acquire()

Add the specified filter to this handler.

close()

Closes the stream.

createLock()

emit(record)

Emit one logging message per input record line.

filter(record)

Determine if a record is loggable by consulting all the filters.

The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.

Changed in version 3.2: Allow filters to be just callables.

flush()

Flushes the stream.

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_name()
handle(record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.

handleError(record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

property name
release()

removeFilter(filter)

Remove the specified filter from this handler.

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler. level must be an int or a str.

setStream(stream)

Sets the StreamHandler’s stream to the specified value, if it is different.

Returns the old stream, if the stream was changed, or None if it wasn’t.

set_name(name)
terminator = '\n'
class gemseo.utils.logging_tools.MultiLineHandlerMixin[source]

Bases: object

Stateless mixin class to override logging handlers behavior.

Methods:

 emit(record) Emit one logging message per input record line.
emit(record)[source]

Emit one logging message per input record line.

class gemseo.utils.logging_tools.MultiLineStreamHandler(stream=None)[source]

Bases: gemseo.utils.logging_tools.MultiLineHandlerMixin, logging.StreamHandler

StreamHandler to split multiline logging messages.

Initialize the handler.

If stream is not specified, sys.stderr is used.

Methods:

 Acquire the I/O thread lock. addFilter(filter) Add the specified filter to this handler. Tidy up any resources used by the handler. Acquire a thread lock for serializing access to the underlying I/O. emit(record) Emit one logging message per input record line. filter(record) Determine if a record is loggable by consulting all the filters. Flushes the stream. format(record) Format the specified record. handle(record) Conditionally emit the specified logging record. handleError(record) Handle errors which occur during an emit() call. Release the I/O thread lock. removeFilter(filter) Remove the specified filter from this handler. Set the formatter for this handler. setLevel(level) Set the logging level of this handler. setStream(stream) Sets the StreamHandler's stream to the specified value, if it is different. set_name(name)

Attributes:

acquire()

Add the specified filter to this handler.

close()

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

createLock()

emit(record)

Emit one logging message per input record line.

filter(record)

Determine if a record is loggable by consulting all the filters.

The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.

Changed in version 3.2: Allow filters to be just callables.

flush()

Flushes the stream.

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_name()
handle(record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.

handleError(record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

property name
release()

removeFilter(filter)

Remove the specified filter from this handler.

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler. level must be an int or a str.

setStream(stream)

Sets the StreamHandler’s stream to the specified value, if it is different.

Returns the old stream, if the stream was changed, or None if it wasn’t.

set_name(name)
terminator = '\n'