mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-31 23:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Bug #3738: Documentation is now more accurate in describing handler close methods.

Browse source
This commit is contained in:
Vinay Sajip 2008-09-01 17:44:14 +00:00
parent e5c1d294b1
commit aa5f873980
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/logging.rst
View file

@ -1504,8 +1504,10 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
.. method:: Handler.close() .. method:: Handler.close()
Tidy up any resources used by the handler. This version does nothing and is Tidy up any resources used by the handler. This version does no output but
intended to be implemented by subclasses. removes the handler from an internal list of handlers which is closed when
:func:`shutdown` is called. Subclasses should ensure that this gets called
from overridden :meth:`close` methods.
.. method:: Handler.handle(record) .. method:: Handler.handle(record)
@ -1567,7 +1569,7 @@ and :meth:`flush` methods).
Flushes the stream by calling its :meth:`flush` method. Note that the Flushes the stream by calling its :meth:`flush` method. Note that the
:meth:`close` method is inherited from :class:`Handler` and so does :meth:`close` method is inherited from :class:`Handler` and so does
nothing, so an explicit :meth:`flush` call may be needed at times. no output, so an explicit :meth:`flush` call may be needed at times.
FileHandler FileHandler
@ -1887,7 +1889,7 @@ extensions for Python installed.
source of event log entries. However, if you do this, you will not be able source of event log entries. However, if you do this, you will not be able
to see the events as you intended in the Event Log Viewer - it needs to be to see the events as you intended in the Event Log Viewer - it needs to be
able to access the registry to get the .dll name. The current version does able to access the registry to get the .dll name. The current version does
not do this (in fact it doesn't do anything). not do this.
.. method:: emit(record) .. method:: emit(record)