Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-32934: Clarified meaning of 'capacity' for BufferingHandler and MemoryHandler. (GH-14498)

This commit is contained in:
Vinay Sajip 2019-07-01 12:41:21 +01:00 committed by GitHub
parent 4a2edc34a4
commit 84de34e39e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/howto/logging-cookbook.rst
View File

@ -2266,9 +2266,9 @@ The script just arranges to decorate ``foo`` with a decorator which will do the
conditional logging that's required. The decorator takes a logger as a parameter
and attaches a memory handler for the duration of the call to the decorated
function. The decorator can be additionally parameterised using a target handler,
a level at which flushing should occur, and a capacity for the buffer. These
default to a :class:`~logging.StreamHandler` which writes to ``sys.stderr``,
``logging.ERROR`` and ``100`` respectively.
a level at which flushing should occur, and a capacity for the buffer (number of
records buffered). These default to a :class:`~logging.StreamHandler` which
writes to ``sys.stderr``, ``logging.ERROR`` and ``100`` respectively.
Here's the script::

16
Doc/library/logging.handlers.rst
View File

@ -861,7 +861,8 @@ should, then :meth:`flush` is expected to do the flushing.
.. class:: BufferingHandler(capacity)
Initializes the handler with a buffer of the specified capacity.
Initializes the handler with a buffer of the specified capacity. Here,
*capacity* means the number of logging records buffered.
.. method:: emit(record)
@ -885,12 +886,13 @@ should, then :meth:`flush` is expected to do the flushing.
.. class:: MemoryHandler(capacity, flushLevel=ERROR, target=None, flushOnClose=True)
Returns a new instance of the :class:`MemoryHandler` class. The instance is
initialized with a buffer size of *capacity*. If *flushLevel* is not specified,
:const:`ERROR` is used. If no *target* is specified, the target will need to be
set using :meth:`setTarget` before this handler does anything useful. If
*flushOnClose* is specified as ``False``, then the buffer is *not* flushed when
the handler is closed. If not specified or specified as ``True``, the previous
behaviour of flushing the buffer will occur when the handler is closed.
initialized with a buffer size of *capacity* (number of records buffered).
If *flushLevel* is not specified, :const:`ERROR` is used. If no *target* is
specified, the target will need to be set using :meth:`setTarget` before this
handler does anything useful. If *flushOnClose* is specified as ``False``,
then the buffer is *not* flushed when the handler is closed. If not specified
or specified as ``True``, the previous behaviour of flushing the buffer will
occur when the handler is closed.
.. versionchanged:: 3.6
The *flushOnClose* parameter was added.