]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Fill in missing docs and other minor doc updates.
authorBen Darnell <ben@bendarnell.com>
Mon, 27 Aug 2012 21:49:20 +0000 (17:49 -0400)
committerBen Darnell <ben@bendarnell.com>
Mon, 27 Aug 2012 21:57:08 +0000 (17:57 -0400)
tornado/httputil.py
website/sphinx/releases/next.rst
website/sphinx/testing.rst
website/sphinx/web.rst

index 6f5d07a689b3ccbaf21c118beedb081367fd0ed5..0f8a8438d43582ac32a47cadf6e24fc0a2765ae3 100644 (file)
@@ -207,6 +207,13 @@ class HTTPFile(ObjectDict):
 
 
 def parse_body_arguments(content_type, body, arguments, files):
+    """Parses a form request body.
+
+    Supports "application/x-www-form-urlencoded" and "multipart/form-data".
+    The content_type parameter should be a string and body should be
+    a byte string.  The arguments and files parameters are dictionaries
+    that will be updated with the parsed contents.
+    """
     if content_type.startswith("application/x-www-form-urlencoded"):
         uri_arguments = parse_qs_bytes(native_str(body))
         for name, values in uri_arguments.iteritems():
index 01e7d4584d235336b52c87e5bf01eba07ded7180..383a2004272f7a8fa3ceb6c0abbf560a5dd1b102 100644 (file)
@@ -36,9 +36,8 @@ In progress
 * `SSLIOStream.get_ssl_certificate` now has a ``binary_form`` argument
   which is passed to ``SSLSocket.getpeercert``.
 * `SSLIOStream.write` can now be called while the connection is in progress,
-  same as non-SSL `IOStream`.
-* tornado.util.GzipDecompressor, tornado.httputil.parse_body_arguments (TODO
-  are these public?)
+  same as non-SSL `IOStream` (but be careful not to send sensitive data until
+  the connection has completed and the certificate has been verified).
 * `OpenIDMixin` now also returns the ``claimed_id`` field for the user.
 * New method `RequestHandler.get_template_namespace` can be overridden to
   add additional variables without modifying keyword arguments to
index 5b8758c3847593aea73b7c05744a5d7928b8b7f1..38738085b2384caca9ef4f53d8f62bdbb655e70d 100644 (file)
 
    .. autoclass:: AsyncHTTPTestCase
       :members:
-   
+
+   .. autoclass:: AsyncHTTPSTestCase
+      :members:
+
    Controlling log output
    ----------------------
 
index e8c1cd33e259a428fbf5ce0c82e4de6c9775263b..2e1b8a46463ee86a06b86b88b417b45b24ac3b21 100644 (file)
@@ -41,6 +41,7 @@
    .. automethod:: RequestHandler.set_status
    .. automethod:: RequestHandler.set_header
    .. automethod:: RequestHandler.add_header
+   .. automethod:: RequestHandler.clear_header
    .. automethod:: RequestHandler.set_default_headers
    .. automethod:: RequestHandler.write
    .. automethod:: RequestHandler.flush