#4894: document "newurl" parameter to redirect_request().

This commit is contained in:
Georg Brandl 2009-02-13 10:40:43 +00:00
parent 76cb7edc80
commit 9617a593e7

View file

@ -741,14 +741,15 @@ HTTPRedirectHandler Objects
precise meanings of the various redirection codes. precise meanings of the various redirection codes.
.. method:: HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs) .. method:: HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)
Return a :class:`Request` or ``None`` in response to a redirect. This is called Return a :class:`Request` or ``None`` in response to a redirect. This is called
by the default implementations of the :meth:`http_error_30\*` methods when a by the default implementations of the :meth:`http_error_30\*` methods when a
redirection is received from the server. If a redirection should take place, redirection is received from the server. If a redirection should take place,
return a new :class:`Request` to allow :meth:`http_error_30\*` to perform the return a new :class:`Request` to allow :meth:`http_error_30\*` to perform the
redirect. Otherwise, raise :exc:`HTTPError` if no other handler should try to redirect to *newurl*. Otherwise, raise :exc:`HTTPError` if no other handler
handle this URL, or return ``None`` if you can't but another handler might. should try to handle this URL, or return ``None`` if you can't but another
handler might.
.. note:: .. note::
@ -761,8 +762,8 @@ HTTPRedirectHandler Objects
.. method:: HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs) .. method:: HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)
Redirect to the ``Location:`` URL. This method is called by the parent Redirect to the ``Location:`` or ``URI:`` URL. This method is called by the
:class:`OpenerDirector` when getting an HTTP 'moved permanently' response. parent :class:`OpenerDirector` when getting an HTTP 'moved permanently' response.
.. method:: HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs) .. method:: HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)