summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2010-09-13 20:37:50 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2010-09-13 20:37:50 (GMT)
commit1b5646ac569e493721364856b45629d6e5a46d6a (patch)
tree6361c5308ac5826acfc0f1fe6135bc4a70f2fbe6
parent9907918174976aa5514bd6f035b214949722d386 (diff)
downloadcpython-1b5646ac569e493721364856b45629d6e5a46d6a.zip
cpython-1b5646ac569e493721364856b45629d6e5a46d6a.tar.gz
cpython-1b5646ac569e493721364856b45629d6e5a46d6a.tar.bz2
Enhanced HTTPHandler documentation.
-rw-r--r--Doc/library/logging.rst16
1 files changed, 10 insertions, 6 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index f3d1445..d28d4fa 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -2578,12 +2578,16 @@ supports sending logging messages to a Web server, using either ``GET`` or
``POST`` semantics.
-.. class:: HTTPHandler(host, url, method='GET')
-
- Returns a new instance of the :class:`HTTPHandler` class. The instance is
- initialized with a host address, url and HTTP method. The *host* can be of the
- form ``host:port``, should you need to use a specific port number. If no
- *method* is specified, ``GET`` is used.
+.. class:: HTTPHandler(host, url, method='GET', secure=False, credentials=None)
+
+ Returns a new instance of the :class:`HTTPHandler` class. The *host* can be
+ of the form ``host:port``, should you need to use a specific port number.
+ If no *method* is specified, ``GET`` is used. If *secure* is True, an HTTPS
+ connection will be used. If *credentials* is specified, it should be a
+ 2-tuple consisting of userid and password, which will be placed in an HTTP
+ 'Authorization' header using Basic authentication. If you specify
+ credentials, you should also specify secure=True so that your userid and
+ password are not passed in cleartext across the wire.
.. method:: emit(record)