]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Enhanced HTTPHandler documentation.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Mon, 13 Sep 2010 20:37:50 +0000 (20:37 +0000)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Mon, 13 Sep 2010 20:37:50 +0000 (20:37 +0000)
Doc/library/logging.rst

index f3d144557d1beb75cde2a179c1499f97bbe62f8b..d28d4fae782367f296e4f2c48b147e0e5fe79f1d 100644 (file)
@@ -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)