logging :: Filter :: Class Filter

Class 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.

Instance Methods

[hide private]

__init__(self, name='')
Initialize a filter. source code

filter(self, record)
Determine if the specified record is to be logged.

source code

Method Details

[hide private]

init(self, name=`''`)
(Constructor)

source code

Initialize a filter.

Initialize with the name of the logger which, together with its children, will have its events allowed through the filter. If no name is specified, allow every event.

filter(self, record)

source code

Determine if the specified record is to be logged.

Is the specified record to be logged? Returns 0 for no, nonzero for yes. If deemed appropriate, the record may be modified in-place.

Class Filter

__init__(self, name='') (Constructor)

filter(self, record)

init(self, name=`''`)
(Constructor)