Kaydet (Commit) 05ed6959 authored tarafından Vinay Sajip's avatar Vinay Sajip

logging: Improved StreamHandler documentation.

üst 2a20dfc2
...@@ -2100,6 +2100,11 @@ and :meth:`flush` methods). ...@@ -2100,6 +2100,11 @@ and :meth:`flush` methods).
:meth:`close` method is inherited from :class:`Handler` and so does :meth:`close` method is inherited from :class:`Handler` and so does
no output, so an explicit :meth:`flush` call may be needed at times. no output, so an explicit :meth:`flush` call may be needed at times.
.. versionchanged:: 3.2
The ``StreamHandler`` class now has a ``terminator`` attribute, default
value ``"\n"``, which is used as the terminator when writing a formatted
record to a stream. If you don't want this newline termination, you can
set the handler instance's ``terminator`` attribute to the empty string.
.. _file-handler: .. _file-handler:
...@@ -3072,14 +3077,14 @@ You don't actually need to subclass ``Filter``: you can pass any instance ...@@ -3072,14 +3077,14 @@ You don't actually need to subclass ``Filter``: you can pass any instance
which has a ``filter`` method with the same semantics. which has a ``filter`` method with the same semantics.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
You don't need to create specialized ``Filter`` classes, or use other
You don't need to create specialized ``Filter`` classes, or use other classes classes with a ``filter`` method: you can use a function (or other
with a ``filter`` method: you can use a function (or other callable) as a callable) as a filter. The filtering logic will check to see if the filter
filter. The filtering logic will check to see if the filter object has a object has a ``filter`` attribute: if it does, it's assumed to be a
``filter`` attribute: if it does, it's assumed to be a ``Filter`` and its ``Filter`` and its :meth:`~Filter.filter` method is called. Otherwise, it's
:meth:`~Filter.filter` method is called. Otherwise, it's assumed to be a assumed to be a callable and called with the record as the single
callable and called with the record as the single parameter. The returned parameter. The returned value should conform to that returned by
value should conform to that returned by :meth:`~Filter.filter`. :meth:`~Filter.filter`.
Other uses for filters Other uses for filters
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
...@@ -3160,9 +3165,6 @@ wire). ...@@ -3160,9 +3165,6 @@ wire).
messages, whose ``__str__`` method can return the actual format string to messages, whose ``__str__`` method can return the actual format string to
be used. be used.
.. versionchanged:: 2.5
*func* was added.
.. _logger-adapter: .. _logger-adapter:
LoggerAdapter Objects LoggerAdapter Objects
......
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