1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

logging: Documented usage of callables as filters.

Browse Source
This commit is contained in:
Vinay Sajip 2010-10-19 21:13:49 +00:00
parent 435d306aa9
commit fc082cafa6
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Doc/library/logging.rst
View File

@ -3040,12 +3040,12 @@ Currently, the useful mapping keys in a :class:`LogRecord` are:
Filter Objects Filter Objects
-------------- --------------
:class:`Filter`\ s can be used by :class:`Handler`\ s and :class:`Logger`\ s for ``Filters` can be used by ``Handlers`` and ``Loggers`` for more sophisticated
more sophisticated filtering than is provided by levels. The base filter class filtering than is provided by levels. The base filter class only allows events
only allows events which are below a certain point in the logger hierarchy. For which are below a certain point in the logger hierarchy. For example, a filter
example, a filter initialized with "A.B" will allow events logged by loggers initialized with "A.B" will allow events logged by loggers "A.B", "A.B.C",
"A.B", "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If initialized with the
initialized with the empty string, all events are passed. empty string, all events are passed.
.. class:: Filter(name='') .. class:: Filter(name='')
@ -3068,6 +3068,15 @@ 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.
.. versionchanged:: 3.2
You don't need to create specialized ``Filter`` classes: you can use a plain
function (or other callable) as a filter. The filtering logic will check to
see if the filter object has a ``filter`` attribute: if it does, it's assumed
to be a ``Filter`` and its :meth:`~Filter.filter` method is called. Otherwise,
it's assumed to be a callable and called with the record as the single
parameter. The result should conform to that of :meth:`~Filter.filter`.
Other uses for filters Other uses for filters
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^

7
Lib/logging/__init__.py
View File

@ -613,13 +613,8 @@ class Filterer(object):
for f in self.filters: for f in self.filters:
if hasattr(f, 'filter'): if hasattr(f, 'filter'):
result = f.filter(record) result = f.filter(record)
elif hasattr(f, '__call__'):
try:
result = f(record)
except Exception:
result = True # filter failed, assume a pass
else: else:
result = False # we don't know what f is result = f(record) # assume callable - will raise if not
if not result: if not result:
rv = 0 rv = 0
break break