Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : logging.handlers.html

<!DOCTYPE html>

<title>15.9. logging.handlers — Logging handlers &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="15.10. getpass — Portable password input" href="getpass.html" />
 <link rel="prev" title="15.8. logging.config — Logging configuration" href="logging.config.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/logging.handlers.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/logging.handlers.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="getpass.html" title="15.10. getpass — Portable password input"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="logging.config.html" title="15.8. logging.config — Logging configuration"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="allos.html" accesskey="U">15. Generic Operating System Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">15.9. <code class="xref py py-mod docutils literal notranslate">logging.handlers</code> — Logging handlers</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-logging.handlers">
<h1>15.9. <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> — Logging handlers<a class="headerlink" href="#module-logging.handlers" title="Permalink to this headline">¶</a></h1>
<aside class="sidebar">
Important
This page contains only reference information. For tutorials,
please see
<ul class="simple">
<li><a class="reference internal" href="../howto/logging.html#logging-basic-tutorial">Basic Tutorial</a></li>
<li><a class="reference internal" href="../howto/logging.html#logging-advanced-tutorial">Advanced Tutorial</a></li>
<li><a class="reference internal" href="../howto/logging-cookbook.html#logging-cookbook">Logging Cookbook</a></li>
</ul>
</aside>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/logging/handlers.py">Lib/logging/handlers.py</a>
<hr class="docutils" />
The following useful handlers are provided in the package. Note that three of
the handlers (<a class="reference internal" href="#logging.StreamHandler" title="logging.StreamHandler"><code class="xref py py-class docutils literal notranslate">StreamHandler</code></a>, <a class="reference internal" href="#logging.FileHandler" title="logging.FileHandler"><code class="xref py py-class docutils literal notranslate">FileHandler</code></a> and
<a class="reference internal" href="#logging.NullHandler" title="logging.NullHandler"><code class="xref py py-class docutils literal notranslate">NullHandler</code></a>) are actually defined in the <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate">logging</code></a> module itself,
but have been documented here along with the other handlers.
<section id="streamhandler">
<h2>15.9.1. StreamHandler<a class="headerlink" href="#streamhandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.StreamHandler" title="logging.StreamHandler"><code class="xref py py-class docutils literal notranslate">StreamHandler</code></a> class, located in the core <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate">logging</code></a> package,
sends logging output to streams such as sys.stdout, sys.stderr or any
file-like object (or, more precisely, any object which supports <code class="xref py py-meth docutils literal notranslate">write()</code>
and <code class="xref py py-meth docutils literal notranslate">flush()</code> methods).
<dl class="py class">
<dt class="sig sig-object py" id="logging.StreamHandler">
class logging.StreamHandler(stream=None)<a class="headerlink" href="#logging.StreamHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.StreamHandler" title="logging.StreamHandler"><code class="xref py py-class docutils literal notranslate">StreamHandler</code></a> class. If stream is
specified, the instance will use it for logging output; otherwise, sys.stderr
will be used.
<dl class="py method">
<dt class="sig sig-object py" id="logging.StreamHandler.emit">
emit(record)<a class="headerlink" href="#logging.StreamHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>If a formatter is specified, it is used to format the record. The record
is then written to the stream with a newline terminator. If exception
information is present, it is formatted using
<a class="reference internal" href="traceback.html#traceback.print_exception" title="traceback.print_exception"><code class="xref py py-func docutils literal notranslate">traceback.print_exception()</code></a> and appended to the stream.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.StreamHandler.flush">
flush()<a class="headerlink" href="#logging.StreamHandler.flush" title="Permalink to this definition">¶</a></dt>
<dd>Flushes the stream by calling its <a class="reference internal" href="#logging.StreamHandler.flush" title="logging.StreamHandler.flush"><code class="xref py py-meth docutils literal notranslate">flush()</code></a> method. Note that the
<code class="xref py py-meth docutils literal notranslate">close()</code> method is inherited from <code class="xref py py-class docutils literal notranslate">Handler</code> and so
does no output, so an explicit <a class="reference internal" href="#logging.StreamHandler.flush" title="logging.StreamHandler.flush"><code class="xref py py-meth docutils literal notranslate">flush()</code></a> call may be needed at times.
</dd></dl>

</dd></dl>

</section>
<section id="filehandler">
<h2>15.9.2. FileHandler<a class="headerlink" href="#filehandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.FileHandler" title="logging.FileHandler"><code class="xref py py-class docutils literal notranslate">FileHandler</code></a> class, located in the core <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate">logging</code></a> package,
sends logging output to a disk file. It inherits the output functionality from
<a class="reference internal" href="#logging.StreamHandler" title="logging.StreamHandler"><code class="xref py py-class docutils literal notranslate">StreamHandler</code></a>.
<dl class="py class">
<dt class="sig sig-object py" id="logging.FileHandler">
class logging.FileHandler(filename, mode='a', encoding=None, delay=False)<a class="headerlink" href="#logging.FileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.FileHandler" title="logging.FileHandler"><code class="xref py py-class docutils literal notranslate">FileHandler</code></a> class. The specified file is
opened and used as the stream for logging. If mode is not specified,
<code class="xref py py-const docutils literal notranslate">'a'</code> is used. If encoding is not <code class="docutils literal notranslate">None</code>, it is used to open the file
with that encoding. If delay is true, then file opening is deferred until the
first call to <a class="reference internal" href="#logging.FileHandler.emit" title="logging.FileHandler.emit"><code class="xref py py-meth docutils literal notranslate">emit()</code></a>. By default, the file grows indefinitely.
<div class="versionchanged">
Changed in version 2.6: delay was added.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="logging.FileHandler.close">
close()<a class="headerlink" href="#logging.FileHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Closes the file.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.FileHandler.emit">
emit(record)<a class="headerlink" href="#logging.FileHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Outputs the record to the file.
</dd></dl>

</dd></dl>

</section>
<section id="nullhandler">
<h2>15.9.3. NullHandler<a class="headerlink" href="#nullhandler" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 2.7.
</div>
The <a class="reference internal" href="#logging.NullHandler" title="logging.NullHandler"><code class="xref py py-class docutils literal notranslate">NullHandler</code></a> class, located in the core <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate">logging</code></a> package,
does not do any formatting or output. It is essentially a ‘no-op’ handler
for use by library developers.
<dl class="py class">
<dt class="sig sig-object py" id="logging.NullHandler">
class logging.NullHandler<a class="headerlink" href="#logging.NullHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.NullHandler" title="logging.NullHandler"><code class="xref py py-class docutils literal notranslate">NullHandler</code></a> class.
<dl class="py method">
<dt class="sig sig-object py" id="logging.NullHandler.emit">
emit(record)<a class="headerlink" href="#logging.NullHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>This method does nothing.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.NullHandler.handle">
handle(record)<a class="headerlink" href="#logging.NullHandler.handle" title="Permalink to this definition">¶</a></dt>
<dd>This method does nothing.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.NullHandler.createLock">
createLock()<a class="headerlink" href="#logging.NullHandler.createLock" title="Permalink to this definition">¶</a></dt>
<dd>This method returns <code class="docutils literal notranslate">None</code> for the lock, since there is no
underlying I/O to which access needs to be serialized.
</dd></dl>

</dd></dl>

See <a class="reference internal" href="../howto/logging.html#library-config">Configuring Logging for a Library</a> for more information on how to use
<a class="reference internal" href="#logging.NullHandler" title="logging.NullHandler"><code class="xref py py-class docutils literal notranslate">NullHandler</code></a>.
</section>
<section id="watchedfilehandler">
<h2>15.9.4. WatchedFileHandler<a class="headerlink" href="#watchedfilehandler" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 2.6.
</div>
The <a class="reference internal" href="#logging.handlers.WatchedFileHandler" title="logging.handlers.WatchedFileHandler"><code class="xref py py-class docutils literal notranslate">WatchedFileHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a>
module, is a <code class="xref py py-class docutils literal notranslate">FileHandler</code> which watches the file it is logging to. If
the file changes, it is closed and reopened using the file name.
A file change can happen because of usage of programs such as newsyslog and
logrotate which perform log file rotation. This handler, intended for use
under Unix/Linux, watches the file to see if it has changed since the last emit.
(A file is deemed to have changed if its device or inode have changed.) If the
file has changed, the old file stream is closed, and the file opened to get a
new stream.
This handler is not appropriate for use under Windows, because under Windows
open log files cannot be moved or renamed - logging opens the files with
exclusive locks - and so there is no need for such a handler. Furthermore,
ST_INO is not supported under Windows; <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate">stat()</code></a> always returns zero
for this value.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.WatchedFileHandler">
class logging.handlers.WatchedFileHandler(filename[, mode[, encoding[, delay]]])<a class="headerlink" href="#logging.handlers.WatchedFileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.WatchedFileHandler" title="logging.handlers.WatchedFileHandler"><code class="xref py py-class docutils literal notranslate">WatchedFileHandler</code></a> class. The specified
file is opened and used as the stream for logging. If mode is not specified,
<code class="xref py py-const docutils literal notranslate">'a'</code> is used. If encoding is not <code class="docutils literal notranslate">None</code>, it is used to open the file
with that encoding. If delay is true, then file opening is deferred until the
first call to <a class="reference internal" href="#logging.handlers.WatchedFileHandler.emit" title="logging.handlers.WatchedFileHandler.emit"><code class="xref py py-meth docutils literal notranslate">emit()</code></a>. By default, the file grows indefinitely.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.WatchedFileHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.WatchedFileHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Outputs the record to the file, but first checks to see if the file has
changed. If it has, the existing stream is flushed and closed and the
file opened again, before outputting the record to the file.
</dd></dl>

</dd></dl>

</section>
<section id="rotatingfilehandler">
<h2>15.9.5. RotatingFileHandler<a class="headerlink" href="#rotatingfilehandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.RotatingFileHandler" title="logging.handlers.RotatingFileHandler"><code class="xref py py-class docutils literal notranslate">RotatingFileHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a>
module, supports rotation of disk log files.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.RotatingFileHandler">
class logging.handlers.RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=0)<a class="headerlink" href="#logging.handlers.RotatingFileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.RotatingFileHandler" title="logging.handlers.RotatingFileHandler"><code class="xref py py-class docutils literal notranslate">RotatingFileHandler</code></a> class. The specified
file is opened and used as the stream for logging. If mode is not specified,
<code class="docutils literal notranslate">'a'</code> is used. If encoding is not <code class="docutils literal notranslate">None</code>, it is used to open the file
with that encoding. If delay is true, then file opening is deferred until the
first call to <a class="reference internal" href="#logging.handlers.RotatingFileHandler.emit" title="logging.handlers.RotatingFileHandler.emit"><code class="xref py py-meth docutils literal notranslate">emit()</code></a>. By default, the file grows indefinitely.
You can use the maxBytes and backupCount values to allow the file to
rollover at a predetermined size. When the size is about to be exceeded,
the file is closed and a new file is silently opened for output. Rollover occurs
whenever the current log file is nearly maxBytes in length; if either of
maxBytes or backupCount is zero, rollover never occurs. If backupCount
is non-zero, the system will save old log files by appending the extensions
‘.1’, ‘.2’ etc., to the filename. For example, with a backupCount of 5 and
a base file name of <code class="file docutils literal notranslate">app.log</code>, you would get <code class="file docutils literal notranslate">app.log</code>,
<code class="file docutils literal notranslate">app.log.1</code>, <code class="file docutils literal notranslate">app.log.2</code>, up to <code class="file docutils literal notranslate">app.log.5</code>. The file being
written to is always <code class="file docutils literal notranslate">app.log</code>. When this file is filled, it is closed
and renamed to <code class="file docutils literal notranslate">app.log.1</code>, and if files <code class="file docutils literal notranslate">app.log.1</code>,
<code class="file docutils literal notranslate">app.log.2</code>, etc. exist, then they are renamed to <code class="file docutils literal notranslate">app.log.2</code>,
<code class="file docutils literal notranslate">app.log.3</code> etc. respectively.
<div class="versionchanged">
Changed in version 2.6: delay was added.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.RotatingFileHandler.doRollover">
doRollover()<a class="headerlink" href="#logging.handlers.RotatingFileHandler.doRollover" title="Permalink to this definition">¶</a></dt>
<dd>Does a rollover, as described above.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.RotatingFileHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.RotatingFileHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Outputs the record to the file, catering for rollover as described
previously.
</dd></dl>

</dd></dl>

</section>
<section id="timedrotatingfilehandler">
<h2>15.9.6. TimedRotatingFileHandler<a class="headerlink" href="#timedrotatingfilehandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.TimedRotatingFileHandler" title="logging.handlers.TimedRotatingFileHandler"><code class="xref py py-class docutils literal notranslate">TimedRotatingFileHandler</code></a> class, located in the
<a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module, supports rotation of disk log files at certain
timed intervals.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.TimedRotatingFileHandler">
class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False)<a class="headerlink" href="#logging.handlers.TimedRotatingFileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.TimedRotatingFileHandler" title="logging.handlers.TimedRotatingFileHandler"><code class="xref py py-class docutils literal notranslate">TimedRotatingFileHandler</code></a> class. The
specified file is opened and used as the stream for logging. On rotating it also
sets the filename suffix. Rotating happens based on the product of when and
interval.
You can use the when to specify the type of interval. The list of possible
values is below. Note that they are not case sensitive.
<table class="docutils align-default">
<colgroup>
<col style="width: 41%" />
<col style="width: 59%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Value</th>
<th class="head">Type of interval</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">'S'</code></td>
<td>Seconds</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'M'</code></td>
<td>Minutes</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'H'</code></td>
<td>Hours</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'D'</code></td>
<td>Days</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'W0'-'W6'</code></td>
<td>Weekday (0=Monday)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'midnight'</code></td>
<td>Roll over at midnight</td>
</tr>
</tbody>
</table>
When using weekday-based rotation, specify ‘W0’ for Monday, ‘W1’ for
Tuesday, and so on up to ‘W6’ for Sunday. In this case, the value passed for
interval isn’t used.
The system will save old log files by appending extensions to the filename.
The extensions are date-and-time based, using the strftime format
<code class="docutils literal notranslate">%Y-%m-%d_%H-%M-%S</code> or a leading portion thereof, depending on the
rollover interval.
When computing the next rollover time for the first time (when the handler
is created), the last modification time of an existing log file, or else
the current time, is used to compute when the next rotation will occur.
If the utc argument is true, times in UTC will be used; otherwise
local time is used.
If backupCount is nonzero, at most backupCount files
will be kept, and if more would be created when rollover occurs, the oldest
one is deleted. The deletion logic uses the interval to determine which
files to delete, so changing the interval may leave old files lying around.
If delay is true, then file opening is deferred until the first call to
<a class="reference internal" href="#logging.handlers.TimedRotatingFileHandler.emit" title="logging.handlers.TimedRotatingFileHandler.emit"><code class="xref py py-meth docutils literal notranslate">emit()</code></a>.
<div class="versionchanged">
Changed in version 2.6: delay and utc were added.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.TimedRotatingFileHandler.doRollover">
doRollover()<a class="headerlink" href="#logging.handlers.TimedRotatingFileHandler.doRollover" title="Permalink to this definition">¶</a></dt>
<dd>Does a rollover, as described above.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.TimedRotatingFileHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.TimedRotatingFileHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Outputs the record to the file, catering for rollover as described above.
</dd></dl>

</dd></dl>

</section>
<section id="sockethandler">
<h2>15.9.7. SocketHandler<a class="headerlink" href="#sockethandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.SocketHandler" title="logging.handlers.SocketHandler"><code class="xref py py-class docutils literal notranslate">SocketHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module,
sends logging output to a network socket. The base class uses a TCP socket.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler">
class logging.handlers.SocketHandler(host, port)<a class="headerlink" href="#logging.handlers.SocketHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.SocketHandler" title="logging.handlers.SocketHandler"><code class="xref py py-class docutils literal notranslate">SocketHandler</code></a> class intended to
communicate with a remote machine whose address is given by host and port.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.close">
close()<a class="headerlink" href="#logging.handlers.SocketHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Closes the socket.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.emit">
emit()<a class="headerlink" href="#logging.handlers.SocketHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Pickles the record’s attribute dictionary and writes it to the socket in
binary format. If there is an error with the socket, silently drops the
packet. If the connection was previously lost, re-establishes the
connection. To unpickle the record at the receiving end into a
<a class="reference internal" href="logging.html#logging.LogRecord" title="logging.LogRecord"><code class="xref py py-class docutils literal notranslate">LogRecord</code></a>, use the <a class="reference internal" href="logging.html#logging.makeLogRecord" title="logging.makeLogRecord"><code class="xref py py-func docutils literal notranslate">makeLogRecord()</code></a>
function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.handleError">
handleError()<a class="headerlink" href="#logging.handlers.SocketHandler.handleError" title="Permalink to this definition">¶</a></dt>
<dd>Handles an error which has occurred during <a class="reference internal" href="#logging.handlers.SocketHandler.emit" title="logging.handlers.SocketHandler.emit"><code class="xref py py-meth docutils literal notranslate">emit()</code></a>. The most likely
cause is a lost connection. Closes the socket so that we can retry on the
next event.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.makeSocket">
makeSocket()<a class="headerlink" href="#logging.handlers.SocketHandler.makeSocket" title="Permalink to this definition">¶</a></dt>
<dd>This is a factory method which allows subclasses to define the precise
type of socket they want. The default implementation creates a TCP socket
(<a class="reference internal" href="socket.html#socket.SOCK_STREAM" title="socket.SOCK_STREAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_STREAM</code></a>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.makePickle">
makePickle(record)<a class="headerlink" href="#logging.handlers.SocketHandler.makePickle" title="Permalink to this definition">¶</a></dt>
<dd>Pickles the record’s attribute dictionary in binary format with a length
prefix, and returns it ready for transmission across the socket.
Note that pickles aren’t completely secure. If you are concerned about
security, you may want to override this method to implement a more secure
mechanism. For example, you can sign pickles using HMAC and then verify
them on the receiving end, or alternatively you can disable unpickling of
global objects on the receiving end.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.send">
send(packet)<a class="headerlink" href="#logging.handlers.SocketHandler.send" title="Permalink to this definition">¶</a></dt>
<dd>Send a pickled string packet to the socket. This function allows for
partial sends which can happen when the network is busy.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SocketHandler.createSocket">
createSocket()<a class="headerlink" href="#logging.handlers.SocketHandler.createSocket" title="Permalink to this definition">¶</a></dt>
<dd>Tries to create a socket; on failure, uses an exponential back-off
algorithm. On initial failure, the handler will drop the message it was
trying to send. When subsequent messages are handled by the same
instance, it will not try connecting until some time has passed. The
default parameters are such that the initial delay is one second, and if
after that delay the connection still can’t be made, the handler will
double the delay each time up to a maximum of 30 seconds.
This behaviour is controlled by the following handler attributes:
<ul class="simple">
<li><code class="docutils literal notranslate">retryStart</code> (initial delay, defaulting to 1.0 seconds).</li>
<li><code class="docutils literal notranslate">retryFactor</code> (multiplier, defaulting to 2.0).</li>
<li><code class="docutils literal notranslate">retryMax</code> (maximum delay, defaulting to 30.0 seconds).</li>
</ul>
This means that if the remote listener starts up after the handler has
been used, you could lose messages (since the handler won’t even attempt
a connection until the delay has elapsed, but just silently drop messages
during the delay period).
</dd></dl>

</dd></dl>

</section>
<section id="datagramhandler">
<h2>15.9.8. DatagramHandler<a class="headerlink" href="#datagramhandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.DatagramHandler" title="logging.handlers.DatagramHandler"><code class="xref py py-class docutils literal notranslate">DatagramHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a>
module, inherits from <a class="reference internal" href="#logging.handlers.SocketHandler" title="logging.handlers.SocketHandler"><code class="xref py py-class docutils literal notranslate">SocketHandler</code></a> to support sending logging messages
over UDP sockets.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.DatagramHandler">
class logging.handlers.DatagramHandler(host, port)<a class="headerlink" href="#logging.handlers.DatagramHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.DatagramHandler" title="logging.handlers.DatagramHandler"><code class="xref py py-class docutils literal notranslate">DatagramHandler</code></a> class intended to
communicate with a remote machine whose address is given by host and port.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.DatagramHandler.emit">
emit()<a class="headerlink" href="#logging.handlers.DatagramHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Pickles the record’s attribute dictionary and writes it to the socket in
binary format. If there is an error with the socket, silently drops the
packet. To unpickle the record at the receiving end into a
<a class="reference internal" href="logging.html#logging.LogRecord" title="logging.LogRecord"><code class="xref py py-class docutils literal notranslate">LogRecord</code></a>, use the <a class="reference internal" href="logging.html#logging.makeLogRecord" title="logging.makeLogRecord"><code class="xref py py-func docutils literal notranslate">makeLogRecord()</code></a>
function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.DatagramHandler.makeSocket">
makeSocket()<a class="headerlink" href="#logging.handlers.DatagramHandler.makeSocket" title="Permalink to this definition">¶</a></dt>
<dd>The factory method of <a class="reference internal" href="#logging.handlers.SocketHandler" title="logging.handlers.SocketHandler"><code class="xref py py-class docutils literal notranslate">SocketHandler</code></a> is here overridden to create
a UDP socket (<a class="reference internal" href="socket.html#socket.SOCK_DGRAM" title="socket.SOCK_DGRAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_DGRAM</code></a>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.DatagramHandler.send">
send(s)<a class="headerlink" href="#logging.handlers.DatagramHandler.send" title="Permalink to this definition">¶</a></dt>
<dd>Send a pickled string to a socket.
</dd></dl>

</dd></dl>

</section>
<section id="sysloghandler">
<h2>15.9.9. SysLogHandler<a class="headerlink" href="#sysloghandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.SysLogHandler" title="logging.handlers.SysLogHandler"><code class="xref py py-class docutils literal notranslate">SysLogHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module,
supports sending logging messages to a remote or local Unix syslog.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.SysLogHandler">
class logging.handlers.SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)<a class="headerlink" href="#logging.handlers.SysLogHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.SysLogHandler" title="logging.handlers.SysLogHandler"><code class="xref py py-class docutils literal notranslate">SysLogHandler</code></a> class intended to
communicate with a remote Unix machine whose address is given by address in
the form of a <code class="docutils literal notranslate">(host, port)</code> tuple. If address is not specified,
<code class="docutils literal notranslate">('localhost', 514)</code> is used. The address is used to open a socket. An
alternative to providing a <code class="docutils literal notranslate">(host, port)</code> tuple is providing an address as a
string, for example ‘/dev/log’. In this case, a Unix domain socket is used to
send the message to the syslog. If facility is not specified,
<code class="xref py py-const docutils literal notranslate">LOG_USER</code> is used. The type of socket opened depends on the
socktype argument, which defaults to <a class="reference internal" href="socket.html#socket.SOCK_DGRAM" title="socket.SOCK_DGRAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_DGRAM</code></a> and thus
opens a UDP socket. To open a TCP socket (for use with the newer syslog
daemons such as rsyslog), specify a value of <a class="reference internal" href="socket.html#socket.SOCK_STREAM" title="socket.SOCK_STREAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_STREAM</code></a>.
Note that if your server is not listening on UDP port 514,
<a class="reference internal" href="#logging.handlers.SysLogHandler" title="logging.handlers.SysLogHandler"><code class="xref py py-class docutils literal notranslate">SysLogHandler</code></a> may appear not to work. In that case, check what
address you should be using for a domain socket - it’s system dependent.
For example, on Linux it’s usually ‘/dev/log’ but on OS/X it’s
‘/var/run/syslog’. You’ll need to check your platform and use the
appropriate address (you may need to do this check at runtime if your
application needs to run on several platforms). On Windows, you pretty
much have to use the UDP option.
<div class="versionchanged">
Changed in version 2.7: socktype was added.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SysLogHandler.close">
close()<a class="headerlink" href="#logging.handlers.SysLogHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Closes the socket to the remote host.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SysLogHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.SysLogHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>The record is formatted, and then sent to the syslog server. If exception
information is present, it is not sent to the server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SysLogHandler.encodePriority">
encodePriority(facility, priority)<a class="headerlink" href="#logging.handlers.SysLogHandler.encodePriority" title="Permalink to this definition">¶</a></dt>
<dd>Encodes the facility and priority into an integer. You can pass in strings
or integers - if strings are passed, internal mapping dictionaries are
used to convert them to integers.
The symbolic <code class="docutils literal notranslate">LOG_</code> values are defined in <a class="reference internal" href="#logging.handlers.SysLogHandler" title="logging.handlers.SysLogHandler"><code class="xref py py-class docutils literal notranslate">SysLogHandler</code></a> and
mirror the values defined in the <code class="docutils literal notranslate">sys/syslog.h</code> header file.
Priorities
<table class="docutils align-default">
<colgroup>
<col style="width: 63%" />
<col style="width: 37%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Name (string)</th>
<th class="head">Symbolic value</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">alert</code></td>
<td>LOG_ALERT</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">crit</code> or <code class="docutils literal notranslate">critical</code></td>
<td>LOG_CRIT</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">debug</code></td>
<td>LOG_DEBUG</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">emerg</code> or <code class="docutils literal notranslate">panic</code></td>
<td>LOG_EMERG</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">err</code> or <code class="docutils literal notranslate">error</code></td>
<td>LOG_ERR</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">info</code></td>
<td>LOG_INFO</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">notice</code></td>
<td>LOG_NOTICE</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">warn</code> or <code class="docutils literal notranslate">warning</code></td>
<td>LOG_WARNING</td>
</tr>
</tbody>
</table>
Facilities
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Name (string)</th>
<th class="head">Symbolic value</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">auth</code></td>
<td>LOG_AUTH</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">authpriv</code></td>
<td>LOG_AUTHPRIV</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">cron</code></td>
<td>LOG_CRON</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">daemon</code></td>
<td>LOG_DAEMON</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">ftp</code></td>
<td>LOG_FTP</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">kern</code></td>
<td>LOG_KERN</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">lpr</code></td>
<td>LOG_LPR</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">mail</code></td>
<td>LOG_MAIL</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">news</code></td>
<td>LOG_NEWS</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">syslog</code></td>
<td>LOG_SYSLOG</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">user</code></td>
<td>LOG_USER</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">uucp</code></td>
<td>LOG_UUCP</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">local0</code></td>
<td>LOG_LOCAL0</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">local1</code></td>
<td>LOG_LOCAL1</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">local2</code></td>
<td>LOG_LOCAL2</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">local3</code></td>
<td>LOG_LOCAL3</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">local4</code></td>
<td>LOG_LOCAL4</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">local5</code></td>
<td>LOG_LOCAL5</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">local6</code></td>
<td>LOG_LOCAL6</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">local7</code></td>
<td>LOG_LOCAL7</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SysLogHandler.mapPriority">
mapPriority(levelname)<a class="headerlink" href="#logging.handlers.SysLogHandler.mapPriority" title="Permalink to this definition">¶</a></dt>
<dd>Maps a logging level name to a syslog priority name.
You may need to override this if you are using custom levels, or
if the default algorithm is not suitable for your needs. The
default algorithm maps <code class="docutils literal notranslate">DEBUG</code>, <code class="docutils literal notranslate">INFO</code>, <code class="docutils literal notranslate">WARNING</code>, <code class="docutils literal notranslate">ERROR</code> and
<code class="docutils literal notranslate">CRITICAL</code> to the equivalent syslog names, and all other level
names to ‘warning’.
</dd></dl>

</dd></dl>

</section>
<section id="nteventloghandler">
<h2>15.9.10. NTEventLogHandler<a class="headerlink" href="#nteventloghandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.NTEventLogHandler" title="logging.handlers.NTEventLogHandler"><code class="xref py py-class docutils literal notranslate">NTEventLogHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a>
module, supports sending logging messages to a local Windows NT, Windows 2000 or
Windows XP event log. Before you can use it, you need Mark Hammond’s Win32
extensions for Python installed.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler">
class logging.handlers.NTEventLogHandler(appname, dllname=None, logtype='Application')<a class="headerlink" href="#logging.handlers.NTEventLogHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.NTEventLogHandler" title="logging.handlers.NTEventLogHandler"><code class="xref py py-class docutils literal notranslate">NTEventLogHandler</code></a> class. The appname is
used to define the application name as it appears in the event log. An
appropriate registry entry is created using this name. The dllname should give
the fully qualified pathname of a .dll or .exe which contains message
definitions to hold in the log (if not specified, <code class="docutils literal notranslate">'win32service.pyd'</code> is used
- this is installed with the Win32 extensions and contains some basic
placeholder message definitions. Note that use of these placeholders will make
your event logs big, as the entire message source is held in the log. If you
want slimmer logs, you have to pass in the name of your own .dll or .exe which
contains the message definitions you want to use in the event log). The
logtype is one of <code class="docutils literal notranslate">'Application'</code>, <code class="docutils literal notranslate">'System'</code> or <code class="docutils literal notranslate">'Security'</code>, and
defaults to <code class="docutils literal notranslate">'Application'</code>.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler.close">
close()<a class="headerlink" href="#logging.handlers.NTEventLogHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>At this point, you can remove the application name from the registry as a
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
able to access the registry to get the .dll name. The current version does
not do this.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.NTEventLogHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Determines the message ID, event category and event type, and then logs
the message in the NT event log.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler.getEventCategory">
getEventCategory(record)<a class="headerlink" href="#logging.handlers.NTEventLogHandler.getEventCategory" title="Permalink to this definition">¶</a></dt>
<dd>Returns the event category for the record. Override this if you want to
specify your own categories. This version returns 0.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler.getEventType">
getEventType(record)<a class="headerlink" href="#logging.handlers.NTEventLogHandler.getEventType" title="Permalink to this definition">¶</a></dt>
<dd>Returns the event type for the record. Override this if you want to
specify your own types. This version does a mapping using the handler’s
typemap attribute, which is set up in <code class="xref py py-meth docutils literal notranslate">__init__()</code> to a dictionary
which contains mappings for <code class="xref py py-const docutils literal notranslate">DEBUG</code>, <code class="xref py py-const docutils literal notranslate">INFO</code>,
<code class="xref py py-const docutils literal notranslate">WARNING</code>, <code class="xref py py-const docutils literal notranslate">ERROR</code> and <code class="xref py py-const docutils literal notranslate">CRITICAL</code>. If you are using
your own levels, you will either need to override this method or place a
suitable dictionary in the handler’s typemap attribute.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.NTEventLogHandler.getMessageID">
getMessageID(record)<a class="headerlink" href="#logging.handlers.NTEventLogHandler.getMessageID" title="Permalink to this definition">¶</a></dt>
<dd>Returns the message ID for the record. If you are using your own messages,
you could do this by having the msg passed to the logger being an ID
rather than a format string. Then, in here, you could use a dictionary
lookup to get the message ID. This version returns 1, which is the base
message ID in <code class="file docutils literal notranslate">win32service.pyd</code>.
</dd></dl>

</dd></dl>

</section>
<section id="smtphandler">
<h2>15.9.11. SMTPHandler<a class="headerlink" href="#smtphandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.SMTPHandler" title="logging.handlers.SMTPHandler"><code class="xref py py-class docutils literal notranslate">SMTPHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module,
supports sending logging messages to an email address via SMTP.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.SMTPHandler">
class logging.handlers.SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None)<a class="headerlink" href="#logging.handlers.SMTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.SMTPHandler" title="logging.handlers.SMTPHandler"><code class="xref py py-class docutils literal notranslate">SMTPHandler</code></a> class. The instance is
initialized with the from and to addresses and subject line of the email.
The toaddrs should be a list of strings. To specify a non-standard SMTP
port, use the (host, port) tuple format for the mailhost argument. If you
use a string, the standard SMTP port is used. If your SMTP server requires
authentication, you can specify a (username, password) tuple for the
credentials argument.
To specify the use of a secure protocol (TLS), pass in a tuple to the
secure argument. This will only be used when authentication credentials are
supplied. The tuple should be either an empty tuple, or a single-value tuple
with the name of a keyfile, or a 2-value tuple with the names of the keyfile
and certificate file. (This tuple is passed to the
<a class="reference internal" href="smtplib.html#smtplib.SMTP.starttls" title="smtplib.SMTP.starttls"><code class="xref py py-meth docutils literal notranslate">smtplib.SMTP.starttls()</code></a> method.)
<div class="versionchanged">
Changed in version 2.6: credentials was added.
</div>
<div class="versionchanged">
Changed in version 2.7: secure was added.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SMTPHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.SMTPHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Formats the record and sends it to the specified addressees.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.SMTPHandler.getSubject">
getSubject(record)<a class="headerlink" href="#logging.handlers.SMTPHandler.getSubject" title="Permalink to this definition">¶</a></dt>
<dd>If you want to specify a subject line which is record-dependent, override
this method.
</dd></dl>

</dd></dl>

</section>
<section id="memoryhandler">
<h2>15.9.12. MemoryHandler<a class="headerlink" href="#memoryhandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.MemoryHandler" title="logging.handlers.MemoryHandler"><code class="xref py py-class docutils literal notranslate">MemoryHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module,
supports buffering of logging records in memory, periodically flushing them to a
target handler. Flushing occurs whenever the buffer is full, or when an
event of a certain severity or greater is seen.
<a class="reference internal" href="#logging.handlers.MemoryHandler" title="logging.handlers.MemoryHandler"><code class="xref py py-class docutils literal notranslate">MemoryHandler</code></a> is a subclass of the more general
<a class="reference internal" href="#logging.handlers.BufferingHandler" title="logging.handlers.BufferingHandler"><code class="xref py py-class docutils literal notranslate">BufferingHandler</code></a>, which is an abstract class. This buffers logging
records in memory. Whenever each record is added to the buffer, a check is made
by calling <code class="xref py py-meth docutils literal notranslate">shouldFlush()</code> to see if the buffer should be flushed. If it
should, then <code class="xref py py-meth docutils literal notranslate">flush()</code> is expected to do the flushing.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.BufferingHandler">
class logging.handlers.BufferingHandler(capacity)<a class="headerlink" href="#logging.handlers.BufferingHandler" title="Permalink to this definition">¶</a></dt>
<dd>Initializes the handler with a buffer of the specified capacity.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.BufferingHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.BufferingHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Appends the record to the buffer. If <a class="reference internal" href="#logging.handlers.BufferingHandler.shouldFlush" title="logging.handlers.BufferingHandler.shouldFlush"><code class="xref py py-meth docutils literal notranslate">shouldFlush()</code></a> returns true,
calls <a class="reference internal" href="#logging.handlers.BufferingHandler.flush" title="logging.handlers.BufferingHandler.flush"><code class="xref py py-meth docutils literal notranslate">flush()</code></a> to process the buffer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.BufferingHandler.flush">
flush()<a class="headerlink" href="#logging.handlers.BufferingHandler.flush" title="Permalink to this definition">¶</a></dt>
<dd>You can override this to implement custom flushing behavior. This version
just zaps the buffer to empty.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.BufferingHandler.shouldFlush">
shouldFlush(record)<a class="headerlink" href="#logging.handlers.BufferingHandler.shouldFlush" title="Permalink to this definition">¶</a></dt>
<dd>Returns true if the buffer is up to capacity. This method can be
overridden to implement custom flushing strategies.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.MemoryHandler">
class logging.handlers.MemoryHandler(capacity, flushLevel=ERROR, target=None)<a class="headerlink" href="#logging.handlers.MemoryHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.MemoryHandler" title="logging.handlers.MemoryHandler"><code class="xref py py-class docutils literal notranslate">MemoryHandler</code></a> class. The instance is
initialized with a buffer size of capacity. If flushLevel is not specified,
<code class="xref py py-const docutils literal notranslate">ERROR</code> is used. If no target is specified, the target will need to be
set using <a class="reference internal" href="#logging.handlers.MemoryHandler.setTarget" title="logging.handlers.MemoryHandler.setTarget"><code class="xref py py-meth docutils literal notranslate">setTarget()</code></a> before this handler does anything useful.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.MemoryHandler.close">
close()<a class="headerlink" href="#logging.handlers.MemoryHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Calls <a class="reference internal" href="#logging.handlers.MemoryHandler.flush" title="logging.handlers.MemoryHandler.flush"><code class="xref py py-meth docutils literal notranslate">flush()</code></a>, sets the target to <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> and clears the
buffer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.MemoryHandler.flush">
flush()<a class="headerlink" href="#logging.handlers.MemoryHandler.flush" title="Permalink to this definition">¶</a></dt>
<dd>For a <a class="reference internal" href="#logging.handlers.MemoryHandler" title="logging.handlers.MemoryHandler"><code class="xref py py-class docutils literal notranslate">MemoryHandler</code></a>, flushing means just sending the buffered
records to the target, if there is one. The buffer is also cleared when
this happens. Override if you want different behavior.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.MemoryHandler.setTarget">
setTarget(target)<a class="headerlink" href="#logging.handlers.MemoryHandler.setTarget" title="Permalink to this definition">¶</a></dt>
<dd>Sets the target handler for this handler.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.MemoryHandler.shouldFlush">
shouldFlush(record)<a class="headerlink" href="#logging.handlers.MemoryHandler.shouldFlush" title="Permalink to this definition">¶</a></dt>
<dd>Checks for buffer full or a record at the flushLevel or higher.
</dd></dl>

</dd></dl>

</section>
<section id="httphandler">
<h2>15.9.13. HTTPHandler<a class="headerlink" href="#httphandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#logging.handlers.HTTPHandler" title="logging.handlers.HTTPHandler"><code class="xref py py-class docutils literal notranslate">HTTPHandler</code></a> class, located in the <a class="reference internal" href="#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate">logging.handlers</code></a> module,
supports sending logging messages to a Web server, using either <code class="docutils literal notranslate">GET</code> or
<code class="docutils literal notranslate">POST</code> semantics.
<dl class="py class">
<dt class="sig sig-object py" id="logging.handlers.HTTPHandler">
class logging.handlers.HTTPHandler(host, url, method='GET')<a class="headerlink" href="#logging.handlers.HTTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Returns a new instance of the <a class="reference internal" href="#logging.handlers.HTTPHandler" title="logging.handlers.HTTPHandler"><code class="xref py py-class docutils literal notranslate">HTTPHandler</code></a> class. The <code class="docutils literal notranslate">host</code> can be
of the form <code class="docutils literal notranslate">host:port</code>, should you need to use a specific port number.
<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.HTTPHandler.mapLogRecord">
mapLogRecord(record)<a class="headerlink" href="#logging.handlers.HTTPHandler.mapLogRecord" title="Permalink to this definition">¶</a></dt>
<dd>Provides a dictionary, based on <code class="docutils literal notranslate">record</code>, which is to be URL-encoded
and sent to the web server. The default implementation just returns
<code class="docutils literal notranslate">record.__dict__</code>. This method can be overridden if e.g. only a
subset of <a class="reference internal" href="logging.html#logging.LogRecord" title="logging.LogRecord"><code class="xref py py-class docutils literal notranslate">LogRecord</code></a> is to be sent to the web server, or
if more specific customization of what’s sent to the server is required.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="logging.handlers.HTTPHandler.emit">
emit(record)<a class="headerlink" href="#logging.handlers.HTTPHandler.emit" title="Permalink to this definition">¶</a></dt>
<dd>Sends the record to the Web server as a URL-encoded dictionary. The
<a class="reference internal" href="#logging.handlers.HTTPHandler.mapLogRecord" title="logging.handlers.HTTPHandler.mapLogRecord"><code class="xref py py-meth docutils literal notranslate">mapLogRecord()</code></a> method is used to convert the record to the
dictionary to be sent.
</dd></dl>

<div class="admonition note">
Note
Since preparing a record for sending it to a Web server is not
the same as a generic formatting operation, using <code class="xref py py-meth docutils literal notranslate">setFormatter()</code>
to specify a <code class="xref py py-class docutils literal notranslate">Formatter</code> for a <a class="reference internal" href="#logging.handlers.HTTPHandler" title="logging.handlers.HTTPHandler"><code class="xref py py-class docutils literal notranslate">HTTPHandler</code></a> has no effect.
Instead of calling <a class="reference internal" href="functions.html#format" title="format"><code class="xref py py-meth docutils literal notranslate">format()</code></a>, this handler calls <a class="reference internal" href="#logging.handlers.HTTPHandler.mapLogRecord" title="logging.handlers.HTTPHandler.mapLogRecord"><code class="xref py py-meth docutils literal notranslate">mapLogRecord()</code></a>
and then <a class="reference internal" href="urllib.html#urllib.urlencode" title="urllib.urlencode"><code class="xref py py-func docutils literal notranslate">urllib.urlencode()</code></a> to encode the dictionary in a form
suitable for sending to a Web server.
</div>
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt>Module <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate">logging</code></a></dt><dd>API reference for the logging module.
</dd>
<dt>Module <a class="reference internal" href="logging.config.html#module-logging.config" title="logging.config: Configuration of the logging module."><code class="xref py py-mod docutils literal notranslate">logging.config</code></a></dt><dd>Configuration API for the logging module.
</dd>
</dl>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">15.9. <code class="xref py py-mod docutils literal notranslate">logging.handlers</code> — Logging handlers</a><ul>
<li><a class="reference internal" href="#streamhandler">15.9.1. StreamHandler</a></li>
<li><a class="reference internal" href="#filehandler">15.9.2. FileHandler</a></li>
<li><a class="reference internal" href="#nullhandler">15.9.3. NullHandler</a></li>
<li><a class="reference internal" href="#watchedfilehandler">15.9.4. WatchedFileHandler</a></li>
<li><a class="reference internal" href="#rotatingfilehandler">15.9.5. RotatingFileHandler</a></li>
<li><a class="reference internal" href="#timedrotatingfilehandler">15.9.6. TimedRotatingFileHandler</a></li>
<li><a class="reference internal" href="#sockethandler">15.9.7. SocketHandler</a></li>
<li><a class="reference internal" href="#datagramhandler">15.9.8. DatagramHandler</a></li>
<li><a class="reference internal" href="#sysloghandler">15.9.9. SysLogHandler</a></li>
<li><a class="reference internal" href="#nteventloghandler">15.9.10. NTEventLogHandler</a></li>
<li><a class="reference internal" href="#smtphandler">15.9.11. SMTPHandler</a></li>
<li><a class="reference internal" href="#memoryhandler">15.9.12. MemoryHandler</a></li>
<li><a class="reference internal" href="#httphandler">15.9.13. HTTPHandler</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="logging.config.html"
 title="previous chapter">15.8. <code class="xref py py-mod docutils literal notranslate">logging.config</code> — Logging configuration</a>
 <h4>Next topic</h4>
 <a href="getpass.html"
 title="next chapter">15.10. <code class="xref py py-mod docutils literal notranslate">getpass</code> — Portable password input</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/logging.handlers.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="getpass.html" title="15.10. getpass — Portable password input"
 >next</a> |</li>
 <li class="right" >
 <a href="logging.config.html" title="15.8. logging.config — Logging configuration"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="allos.html" >15. Generic Operating System Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">15.9. <code class="xref py py-mod docutils literal notranslate">logging.handlers</code> — Logging handlers</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : logging.handlers.html