Commit 22246fdd authored by Vinay Sajip's avatar Vinay Sajip

logging: clarified Filter documentation.

parent 9450cc05
...@@ -3068,14 +3068,18 @@ etc.) This means that events which have been generated by descendant loggers ...@@ -3068,14 +3068,18 @@ etc.) This means that events which have been generated by descendant loggers
will not be filtered by a logger's filter setting, unless the filter has also will not be filtered by a logger's filter setting, unless the filter has also
been applied to those descendant loggers. been applied to those descendant loggers.
You don't actually need to subclass ``Filter``: you can pass any instance
which has a ``filter`` method with the same semantics.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
You don't need to create specialized ``Filter`` classes: you can use a plain You don't need to create specialized ``Filter`` classes, or use other classes
function (or other callable) as a filter. The filtering logic will check to with a ``filter`` method: you can use a function (or other callable) as a
see if the filter object has a ``filter`` attribute: if it does, it's assumed filter. The filtering logic will check to see if the filter object has a
to be a ``Filter`` and its :meth:`~Filter.filter` method is called. Otherwise, ``filter`` attribute: if it does, it's assumed to be a ``Filter`` and its
it's assumed to be a callable and called with the record as the single :meth:`~Filter.filter` method is called. Otherwise, it's assumed to be a
parameter. The result should conform to that of :meth:`~Filter.filter`. callable and called with the record as the single parameter. The returned
value should conform to that returned by :meth:`~Filter.filter`.
Other uses for filters Other uses for filters
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment