mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated handler documentation.

This commit is contained in:
Vinay Sajip 2012-03-26 17:17:39 +01:00
parent 16ecb9dea0 8ece80faae
commit 38a12af36a
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -704,7 +704,7 @@ The :class:`SMTPHandler` class, located in the :mod:`logging.handlers` module,
supports sending logging messages to an email address via SMTP. supports sending logging messages to an email address via SMTP.
.. class:: SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None) .. class:: SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)
Returns a new instance of the :class:`SMTPHandler` class. The instance is Returns a new instance of the :class:`SMTPHandler` class. The instance is
initialized with the from and to addresses and subject line of the email. The initialized with the from and to addresses and subject line of the email. The
@ -720,6 +720,12 @@ supports sending logging messages to an email address via SMTP.
and certificate file. (This tuple is passed to the and certificate file. (This tuple is passed to the
:meth:`smtplib.SMTP.starttls` method.) :meth:`smtplib.SMTP.starttls` method.)
A timeout can be specified for communication with the SMTP server using the
*timeout* argument.
.. versionadded:: 3.3
The *timeout* argument was added.
.. method:: emit(record) .. method:: emit(record)
Formats the record and sends it to the specified addressees. Formats the record and sends it to the specified addressees.
@ -744,7 +750,7 @@ event of a certain severity or greater is seen.
:class:`BufferingHandler`, which is an abstract class. This buffers logging :class:`BufferingHandler`, which is an abstract class. This buffers logging
records in memory. Whenever each record is added to the buffer, a check is made records in memory. Whenever each record is added to the buffer, a check is made
by calling :meth:`shouldFlush` to see if the buffer should be flushed. If it by calling :meth:`shouldFlush` to see if the buffer should be flushed. If it
should, then :meth:`flush` is expected to do the needful. should, then :meth:`flush` is expected to do the flushing.
.. class:: BufferingHandler(capacity) .. class:: BufferingHandler(capacity)