ds_stoa.utils.logger._context

Logger Context Filter

This module contains the context filter for the logger.

Classes

ContextFilter	Context filter to add customized field in the logging
FolderNameFilter	Filter instances are used to perform arbitrary filtering of LogRecords.

Module Contents

class ds_stoa.utils.logger._context.ContextFilter(prefix: str | None = None)

Bases: logging.Filter

Context filter to add customized field in the logging record. This filter is used to add a prefix to the log.

filter(record) → Literal[True]

Add prefix to the log record.

Parameters:

record – The log record.

Returns:

True

class ds_stoa.utils.logger._context.FolderNameFilter(name='')

Bases: logging.Filter

Filter instances are used to perform arbitrary filtering of LogRecords.

Loggers and Handlers can optionally use Filter instances to filter records as desired. The base filter class only allows events which are below a certain point in the logger hierarchy. For example, a filter initialized with “A.B” will allow events logged by loggers “A.B”, “A.B.C”, “A.B.C.D”, “A.B.D” etc. but not “A.BB”, “B.A.B” etc. If initialized with the empty string, all events are passed.

filter(record) → Literal[True]

Add the folder name to the log record.

Parameters:

record – The log record.

Returns:

True