Correct documentation for s* z* and w*, the argument that should be passed
[python.git] / Doc / library / urllib2.rst
blobcf889cc63f70b2b54c79bcf7486598718fd4a1a6
1 :mod:`urllib2` --- extensible library for opening URLs
2 ======================================================
4 .. module:: urllib2
5    :synopsis: Next generation URL opening library.
6 .. moduleauthor:: Jeremy Hylton <jhylton@users.sourceforge.net>
7 .. sectionauthor:: Moshe Zadka <moshez@users.sourceforge.net>
10 .. note::
11    The :mod:`urllib2` module has been split across several modules in
12    Python 3.0 named :mod:`urllib.request` and :mod:`urllib.error`.
13    The :term:`2to3` tool will automatically adapt imports when converting
14    your sources to 3.0.
17 The :mod:`urllib2` module defines functions and classes which help in opening
18 URLs (mostly HTTP) in a complex world --- basic and digest authentication,
19 redirections, cookies and more.
21 The :mod:`urllib2` module defines the following functions:
24 .. function:: urlopen(url[, data][, timeout])
26    Open the URL *url*, which can be either a string or a :class:`Request` object.
28    *data* may be a string specifying additional data to send to the server, or
29    ``None`` if no such data is needed.  Currently HTTP requests are the only ones
30    that use *data*; the HTTP request will be a POST instead of a GET when the
31    *data* parameter is provided.  *data* should be a buffer in the standard
32    :mimetype:`application/x-www-form-urlencoded` format.  The
33    :func:`urllib.urlencode` function takes a mapping or sequence of 2-tuples and
34    returns a string in this format.
36    The optional *timeout* parameter specifies a timeout in seconds for blocking
37    operations like the connection attempt (if not specified, the global default
38    timeout setting will be used).  This actually only works for HTTP, HTTPS,
39    FTP and FTPS connections.
41    This function returns a file-like object with two additional methods:
43    * :meth:`geturl` --- return the URL of the resource retrieved, commonly used to
44      determine if a redirect was followed
46    * :meth:`info` --- return the meta-information of the page, such as headers, in
47      the form of an ``httplib.HTTPMessage`` instance
48      (see `Quick Reference to HTTP Headers <http://www.cs.tut.fi/~jkorpela/http.html>`_)
50    Raises :exc:`URLError` on errors.
52    Note that ``None`` may be returned if no handler handles the request (though the
53    default installed global :class:`OpenerDirector` uses :class:`UnknownHandler` to
54    ensure this never happens).
56    In addition, default installed :class:`ProxyHandler` makes sure the requests
57    are handled through the proxy when they are set.
59    .. versionchanged:: 2.6
60       *timeout* was added.
63 .. function:: install_opener(opener)
65    Install an :class:`OpenerDirector` instance as the default global opener.
66    Installing an opener is only necessary if you want urlopen to use that opener;
67    otherwise, simply call :meth:`OpenerDirector.open` instead of :func:`urlopen`.
68    The code does not check for a real :class:`OpenerDirector`, and any class with
69    the appropriate interface will work.
72 .. function:: build_opener([handler, ...])
74    Return an :class:`OpenerDirector` instance, which chains the handlers in the
75    order given. *handler*\s can be either instances of :class:`BaseHandler`, or
76    subclasses of :class:`BaseHandler` (in which case it must be possible to call
77    the constructor without any parameters).  Instances of the following classes
78    will be in front of the *handler*\s, unless the *handler*\s contain them,
79    instances of them or subclasses of them: :class:`ProxyHandler`,
80    :class:`UnknownHandler`, :class:`HTTPHandler`, :class:`HTTPDefaultErrorHandler`,
81    :class:`HTTPRedirectHandler`, :class:`FTPHandler`, :class:`FileHandler`,
82    :class:`HTTPErrorProcessor`.
84    If the Python installation has SSL support (i.e., if the :mod:`ssl` module can be imported),
85    :class:`HTTPSHandler` will also be added.
87    Beginning in Python 2.3, a :class:`BaseHandler` subclass may also change its
88    :attr:`handler_order` member variable to modify its position in the handlers
89    list.
91 The following exceptions are raised as appropriate:
94 .. exception:: URLError
96    The handlers raise this exception (or derived exceptions) when they run into a
97    problem.  It is a subclass of :exc:`IOError`.
99    .. attribute:: reason
101       The reason for this error.  It can be a message string or another exception
102       instance (:exc:`socket.error` for remote URLs, :exc:`OSError` for local
103       URLs).
106 .. exception:: HTTPError
108    Though being an exception (a subclass of :exc:`URLError`), an :exc:`HTTPError`
109    can also function as a non-exceptional file-like return value (the same thing
110    that :func:`urlopen` returns).  This is useful when handling exotic HTTP
111    errors, such as requests for authentication.
113    .. attribute:: code
115       An HTTP status code as defined in `RFC 2616 <http://www.faqs.org/rfcs/rfc2616.html>`_.
116       This numeric value corresponds to a value found in the dictionary of
117       codes as found in :attr:`BaseHTTPServer.BaseHTTPRequestHandler.responses`.
121 The following classes are provided:
124 .. class:: Request(url[, data][, headers][, origin_req_host][, unverifiable])
126    This class is an abstraction of a URL request.
128    *url* should be a string containing a valid URL.
130    *data* may be a string specifying additional data to send to the server, or
131    ``None`` if no such data is needed.  Currently HTTP requests are the only ones
132    that use *data*; the HTTP request will be a POST instead of a GET when the
133    *data* parameter is provided.  *data* should be a buffer in the standard
134    :mimetype:`application/x-www-form-urlencoded` format.  The
135    :func:`urllib.urlencode` function takes a mapping or sequence of 2-tuples and
136    returns a string in this format.
138    *headers* should be a dictionary, and will be treated as if :meth:`add_header`
139    was called with each key and value as arguments.  This is often used to "spoof"
140    the ``User-Agent`` header, which is used by a browser to identify itself --
141    some HTTP servers only allow requests coming from common browsers as opposed
142    to scripts.  For example, Mozilla Firefox may identify itself as ``"Mozilla/5.0
143    (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"``, while :mod:`urllib2`'s
144    default user agent string is ``"Python-urllib/2.6"`` (on Python 2.6).
146    The final two arguments are only of interest for correct handling of third-party
147    HTTP cookies:
149    *origin_req_host* should be the request-host of the origin transaction, as
150    defined by :rfc:`2965`.  It defaults to ``cookielib.request_host(self)``.  This
151    is the host name or IP address of the original request that was initiated by the
152    user.  For example, if the request is for an image in an HTML document, this
153    should be the request-host of the request for the page containing the image.
155    *unverifiable* should indicate whether the request is unverifiable, as defined
156    by RFC 2965.  It defaults to False.  An unverifiable request is one whose URL
157    the user did not have the option to approve.  For example, if the request is for
158    an image in an HTML document, and the user had no option to approve the
159    automatic fetching of the image, this should be true.
162 .. class:: OpenerDirector()
164    The :class:`OpenerDirector` class opens URLs via :class:`BaseHandler`\ s chained
165    together. It manages the chaining of handlers, and recovery from errors.
168 .. class:: BaseHandler()
170    This is the base class for all registered handlers --- and handles only the
171    simple mechanics of registration.
174 .. class:: HTTPDefaultErrorHandler()
176    A class which defines a default handler for HTTP error responses; all responses
177    are turned into :exc:`HTTPError` exceptions.
180 .. class:: HTTPRedirectHandler()
182    A class to handle redirections.
185 .. class:: HTTPCookieProcessor([cookiejar])
187    A class to handle HTTP Cookies.
190 .. class:: ProxyHandler([proxies])
192    Cause requests to go through a proxy. If *proxies* is given, it must be a
193    dictionary mapping protocol names to URLs of proxies. The default is to read
194    the list of proxies from the environment variables
195    :envvar:`<protocol>_proxy`.  If no proxy environment variables are set, in a
196    Windows environment, proxy settings are obtained from the registry's
197    Internet Settings section and in a Mac OS X  environment, proxy information
198    is retrieved from the OS X System Configuration Framework.
200    To disable autodetected proxy pass an empty dictionary.
203 .. class:: HTTPPasswordMgr()
205    Keep a database of  ``(realm, uri) -> (user, password)`` mappings.
208 .. class:: HTTPPasswordMgrWithDefaultRealm()
210    Keep a database of  ``(realm, uri) -> (user, password)`` mappings. A realm of
211    ``None`` is considered a catch-all realm, which is searched if no other realm
212    fits.
215 .. class:: AbstractBasicAuthHandler([password_mgr])
217    This is a mixin class that helps with HTTP authentication, both to the remote
218    host and to a proxy. *password_mgr*, if given, should be something that is
219    compatible with :class:`HTTPPasswordMgr`; refer to section
220    :ref:`http-password-mgr` for information on the interface that must be
221    supported.
224 .. class:: HTTPBasicAuthHandler([password_mgr])
226    Handle authentication with the remote host. *password_mgr*, if given, should be
227    something that is compatible with :class:`HTTPPasswordMgr`; refer to section
228    :ref:`http-password-mgr` for information on the interface that must be
229    supported.
232 .. class:: ProxyBasicAuthHandler([password_mgr])
234    Handle authentication with the proxy. *password_mgr*, if given, should be
235    something that is compatible with :class:`HTTPPasswordMgr`; refer to section
236    :ref:`http-password-mgr` for information on the interface that must be
237    supported.
240 .. class:: AbstractDigestAuthHandler([password_mgr])
242    This is a mixin class that helps with HTTP authentication, both to the remote
243    host and to a proxy. *password_mgr*, if given, should be something that is
244    compatible with :class:`HTTPPasswordMgr`; refer to section
245    :ref:`http-password-mgr` for information on the interface that must be
246    supported.
249 .. class:: HTTPDigestAuthHandler([password_mgr])
251    Handle authentication with the remote host. *password_mgr*, if given, should be
252    something that is compatible with :class:`HTTPPasswordMgr`; refer to section
253    :ref:`http-password-mgr` for information on the interface that must be
254    supported.
257 .. class:: ProxyDigestAuthHandler([password_mgr])
259    Handle authentication with the proxy. *password_mgr*, if given, should be
260    something that is compatible with :class:`HTTPPasswordMgr`; refer to section
261    :ref:`http-password-mgr` for information on the interface that must be
262    supported.
265 .. class:: HTTPHandler()
267    A class to handle opening of HTTP URLs.
270 .. class:: HTTPSHandler()
272    A class to handle opening of HTTPS URLs.
275 .. class:: FileHandler()
277    Open local files.
280 .. class:: FTPHandler()
282    Open FTP URLs.
285 .. class:: CacheFTPHandler()
287    Open FTP URLs, keeping a cache of open FTP connections to minimize delays.
290 .. class:: UnknownHandler()
292    A catch-all class to handle unknown URLs.
295 .. _request-objects:
297 Request Objects
298 ---------------
300 The following methods describe all of :class:`Request`'s public interface, and
301 so all must be overridden in subclasses.
304 .. method:: Request.add_data(data)
306    Set the :class:`Request` data to *data*.  This is ignored by all handlers except
307    HTTP handlers --- and there it should be a byte string, and will change the
308    request to be ``POST`` rather than ``GET``.
311 .. method:: Request.get_method()
313    Return a string indicating the HTTP request method.  This is only meaningful for
314    HTTP requests, and currently always returns ``'GET'`` or ``'POST'``.
317 .. method:: Request.has_data()
319    Return whether the instance has a non-\ ``None`` data.
322 .. method:: Request.get_data()
324    Return the instance's data.
327 .. method:: Request.add_header(key, val)
329    Add another header to the request.  Headers are currently ignored by all
330    handlers except HTTP handlers, where they are added to the list of headers sent
331    to the server.  Note that there cannot be more than one header with the same
332    name, and later calls will overwrite previous calls in case the *key* collides.
333    Currently, this is no loss of HTTP functionality, since all headers which have
334    meaning when used more than once have a (header-specific) way of gaining the
335    same functionality using only one header.
338 .. method:: Request.add_unredirected_header(key, header)
340    Add a header that will not be added to a redirected request.
342    .. versionadded:: 2.4
345 .. method:: Request.has_header(header)
347    Return whether the instance has the named header (checks both regular and
348    unredirected).
350    .. versionadded:: 2.4
353 .. method:: Request.get_full_url()
355    Return the URL given in the constructor.
358 .. method:: Request.get_type()
360    Return the type of the URL --- also known as the scheme.
363 .. method:: Request.get_host()
365    Return the host to which a connection will be made.
368 .. method:: Request.get_selector()
370    Return the selector --- the part of the URL that is sent to the server.
373 .. method:: Request.set_proxy(host, type)
375    Prepare the request by connecting to a proxy server. The *host* and *type* will
376    replace those of the instance, and the instance's selector will be the original
377    URL given in the constructor.
380 .. method:: Request.get_origin_req_host()
382    Return the request-host of the origin transaction, as defined by :rfc:`2965`.
383    See the documentation for the :class:`Request` constructor.
386 .. method:: Request.is_unverifiable()
388    Return whether the request is unverifiable, as defined by RFC 2965. See the
389    documentation for the :class:`Request` constructor.
392 .. _opener-director-objects:
394 OpenerDirector Objects
395 ----------------------
397 :class:`OpenerDirector` instances have the following methods:
400 .. method:: OpenerDirector.add_handler(handler)
402    *handler* should be an instance of :class:`BaseHandler`.  The following
403    methods are searched, and added to the possible chains (note that HTTP errors
404    are a special case).
406    * :samp:`{protocol}_open` --- signal that the handler knows how to open
407      *protocol* URLs.
409    * :samp:`http_error_{type}` --- signal that the handler knows how to handle
410      HTTP errors with HTTP error code *type*.
412    * :samp:`{protocol}_error` --- signal that the handler knows how to handle
413      errors from (non-\ ``http``) *protocol*.
415    * :samp:`{protocol}_request` --- signal that the handler knows how to
416      pre-process *protocol* requests.
418    * :samp:`{protocol}_response` --- signal that the handler knows how to
419      post-process *protocol* responses.
422 .. method:: OpenerDirector.open(url[, data][, timeout])
424    Open the given *url* (which can be a request object or a string), optionally
425    passing the given *data*. Arguments, return values and exceptions raised are
426    the same as those of :func:`urlopen` (which simply calls the :meth:`open`
427    method on the currently installed global :class:`OpenerDirector`).  The
428    optional *timeout* parameter specifies a timeout in seconds for blocking
429    operations like the connection attempt (if not specified, the global default
430    timeout setting will be usedi). The timeout feature actually works only for
431    HTTP, HTTPS, FTP and FTPS connections).
433    .. versionchanged:: 2.6
434       *timeout* was added.
437 .. method:: OpenerDirector.error(proto[, arg[, ...]])
439    Handle an error of the given protocol.  This will call the registered error
440    handlers for the given protocol with the given arguments (which are protocol
441    specific).  The HTTP protocol is a special case which uses the HTTP response
442    code to determine the specific error handler; refer to the :meth:`http_error_\*`
443    methods of the handler classes.
445    Return values and exceptions raised are the same as those of :func:`urlopen`.
447 OpenerDirector objects open URLs in three stages:
449 The order in which these methods are called within each stage is determined by
450 sorting the handler instances.
452 #. Every handler with a method named like :samp:`{protocol}_request` has that
453    method called to pre-process the request.
455 #. Handlers with a method named like :samp:`{protocol}_open` are called to handle
456    the request. This stage ends when a handler either returns a non-\ :const:`None`
457    value (ie. a response), or raises an exception (usually :exc:`URLError`).
458    Exceptions are allowed to propagate.
460    In fact, the above algorithm is first tried for methods named
461    :meth:`default_open`.  If all such methods return :const:`None`, the
462    algorithm is repeated for methods named like :samp:`{protocol}_open`.  If all
463    such methods return :const:`None`, the algorithm is repeated for methods
464    named :meth:`unknown_open`.
466    Note that the implementation of these methods may involve calls of the parent
467    :class:`OpenerDirector` instance's :meth:`.open` and :meth:`.error` methods.
469 #. Every handler with a method named like :samp:`{protocol}_response` has that
470    method called to post-process the response.
473 .. _base-handler-objects:
475 BaseHandler Objects
476 -------------------
478 :class:`BaseHandler` objects provide a couple of methods that are directly
479 useful, and others that are meant to be used by derived classes.  These are
480 intended for direct use:
483 .. method:: BaseHandler.add_parent(director)
485    Add a director as parent.
488 .. method:: BaseHandler.close()
490    Remove any parents.
492 The following members and methods should only be used by classes derived from
493 :class:`BaseHandler`.
495 .. note::
497    The convention has been adopted that subclasses defining
498    :meth:`protocol_request` or :meth:`protocol_response` methods are named
499    :class:`\*Processor`; all others are named :class:`\*Handler`.
502 .. attribute:: BaseHandler.parent
504    A valid :class:`OpenerDirector`, which can be used to open using a different
505    protocol, or handle errors.
508 .. method:: BaseHandler.default_open(req)
510    This method is *not* defined in :class:`BaseHandler`, but subclasses should
511    define it if they want to catch all URLs.
513    This method, if implemented, will be called by the parent
514    :class:`OpenerDirector`.  It should return a file-like object as described in
515    the return value of the :meth:`open` of :class:`OpenerDirector`, or ``None``.
516    It should raise :exc:`URLError`, unless a truly exceptional thing happens (for
517    example, :exc:`MemoryError` should not be mapped to :exc:`URLError`).
519    This method will be called before any protocol-specific open method.
522 .. method:: BaseHandler.protocol_open(req)
523    :noindex:
525    ("protocol" is to be replaced by the protocol name.)
527    This method is *not* defined in :class:`BaseHandler`, but subclasses should
528    define it if they want to handle URLs with the given *protocol*.
530    This method, if defined, will be called by the parent :class:`OpenerDirector`.
531    Return values should be the same as for  :meth:`default_open`.
534 .. method:: BaseHandler.unknown_open(req)
536    This method is *not* defined in :class:`BaseHandler`, but subclasses should
537    define it if they want to catch all URLs with no specific registered handler to
538    open it.
540    This method, if implemented, will be called by the :attr:`parent`
541    :class:`OpenerDirector`.  Return values should be the same as for
542    :meth:`default_open`.
545 .. method:: BaseHandler.http_error_default(req, fp, code, msg, hdrs)
547    This method is *not* defined in :class:`BaseHandler`, but subclasses should
548    override it if they intend to provide a catch-all for otherwise unhandled HTTP
549    errors.  It will be called automatically by the  :class:`OpenerDirector` getting
550    the error, and should not normally be called in other circumstances.
552    *req* will be a :class:`Request` object, *fp* will be a file-like object with
553    the HTTP error body, *code* will be the three-digit code of the error, *msg*
554    will be the user-visible explanation of the code and *hdrs* will be a mapping
555    object with the headers of the error.
557    Return values and exceptions raised should be the same as those of
558    :func:`urlopen`.
561 .. method:: BaseHandler.http_error_nnn(req, fp, code, msg, hdrs)
563    *nnn* should be a three-digit HTTP error code.  This method is also not defined
564    in :class:`BaseHandler`, but will be called, if it exists, on an instance of a
565    subclass, when an HTTP error with code *nnn* occurs.
567    Subclasses should override this method to handle specific HTTP errors.
569    Arguments, return values and exceptions raised should be the same as for
570    :meth:`http_error_default`.
573 .. method:: BaseHandler.protocol_request(req)
574    :noindex:
576    ("protocol" is to be replaced by the protocol name.)
578    This method is *not* defined in :class:`BaseHandler`, but subclasses should
579    define it if they want to pre-process requests of the given *protocol*.
581    This method, if defined, will be called by the parent :class:`OpenerDirector`.
582    *req* will be a :class:`Request` object. The return value should be a
583    :class:`Request` object.
586 .. method:: BaseHandler.protocol_response(req, response)
587    :noindex:
589    ("protocol" is to be replaced by the protocol name.)
591    This method is *not* defined in :class:`BaseHandler`, but subclasses should
592    define it if they want to post-process responses of the given *protocol*.
594    This method, if defined, will be called by the parent :class:`OpenerDirector`.
595    *req* will be a :class:`Request` object. *response* will be an object
596    implementing the same interface as the return value of :func:`urlopen`.  The
597    return value should implement the same interface as the return value of
598    :func:`urlopen`.
601 .. _http-redirect-handler:
603 HTTPRedirectHandler Objects
604 ---------------------------
606 .. note::
608    Some HTTP redirections require action from this module's client code.  If this
609    is the case, :exc:`HTTPError` is raised.  See :rfc:`2616` for details of the
610    precise meanings of the various redirection codes.
613 .. method:: HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)
615    Return a :class:`Request` or ``None`` in response to a redirect. This is called
616    by the default implementations of the :meth:`http_error_30\*` methods when a
617    redirection is received from the server.  If a redirection should take place,
618    return a new :class:`Request` to allow :meth:`http_error_30\*` to perform the
619    redirect to *newurl*.  Otherwise, raise :exc:`HTTPError` if no other handler
620    should try to handle this URL, or return ``None`` if you can't but another
621    handler might.
623    .. note::
625       The default implementation of this method does not strictly follow :rfc:`2616`,
626       which says that 301 and 302 responses to ``POST`` requests must not be
627       automatically redirected without confirmation by the user.  In reality, browsers
628       do allow automatic redirection of these responses, changing the POST to a
629       ``GET``, and the default implementation reproduces this behavior.
632 .. method:: HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)
634    Redirect to the ``Location:`` or ``URI:`` URL.  This method is called by the
635    parent :class:`OpenerDirector` when getting an HTTP 'moved permanently' response.
638 .. method:: HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)
640    The same as :meth:`http_error_301`, but called for the 'found' response.
643 .. method:: HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)
645    The same as :meth:`http_error_301`, but called for the 'see other' response.
648 .. method:: HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)
650    The same as :meth:`http_error_301`, but called for the 'temporary redirect'
651    response.
654 .. _http-cookie-processor:
656 HTTPCookieProcessor Objects
657 ---------------------------
659 .. versionadded:: 2.4
661 :class:`HTTPCookieProcessor` instances have one attribute:
664 .. attribute:: HTTPCookieProcessor.cookiejar
666    The :class:`cookielib.CookieJar` in which cookies are stored.
669 .. _proxy-handler:
671 ProxyHandler Objects
672 --------------------
675 .. method:: ProxyHandler.protocol_open(request)
676    :noindex:
678    ("protocol" is to be replaced by the protocol name.)
680    The :class:`ProxyHandler` will have a method :samp:`{protocol}_open` for every
681    *protocol* which has a proxy in the *proxies* dictionary given in the
682    constructor.  The method will modify requests to go through the proxy, by
683    calling ``request.set_proxy()``, and call the next handler in the chain to
684    actually execute the protocol.
687 .. _http-password-mgr:
689 HTTPPasswordMgr Objects
690 -----------------------
692 These methods are available on :class:`HTTPPasswordMgr` and
693 :class:`HTTPPasswordMgrWithDefaultRealm` objects.
696 .. method:: HTTPPasswordMgr.add_password(realm, uri, user, passwd)
698    *uri* can be either a single URI, or a sequence of URIs. *realm*, *user* and
699    *passwd* must be strings. This causes ``(user, passwd)`` to be used as
700    authentication tokens when authentication for *realm* and a super-URI of any of
701    the given URIs is given.
704 .. method:: HTTPPasswordMgr.find_user_password(realm, authuri)
706    Get user/password for given realm and URI, if any.  This method will return
707    ``(None, None)`` if there is no matching user/password.
709    For :class:`HTTPPasswordMgrWithDefaultRealm` objects, the realm ``None`` will be
710    searched if the given *realm* has no matching user/password.
713 .. _abstract-basic-auth-handler:
715 AbstractBasicAuthHandler Objects
716 --------------------------------
719 .. method:: AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)
721    Handle an authentication request by getting a user/password pair, and re-trying
722    the request.  *authreq* should be the name of the header where the information
723    about the realm is included in the request, *host* specifies the URL and path to
724    authenticate for, *req* should be the (failed) :class:`Request` object, and
725    *headers* should be the error headers.
727    *host* is either an authority (e.g. ``"python.org"``) or a URL containing an
728    authority component (e.g. ``"http://python.org/"``). In either case, the
729    authority must not contain a userinfo component (so, ``"python.org"`` and
730    ``"python.org:80"`` are fine, ``"joe:password@python.org"`` is not).
733 .. _http-basic-auth-handler:
735 HTTPBasicAuthHandler Objects
736 ----------------------------
739 .. method:: HTTPBasicAuthHandler.http_error_401(req, fp, code,  msg, hdrs)
741    Retry the request with authentication information, if available.
744 .. _proxy-basic-auth-handler:
746 ProxyBasicAuthHandler Objects
747 -----------------------------
750 .. method:: ProxyBasicAuthHandler.http_error_407(req, fp, code,  msg, hdrs)
752    Retry the request with authentication information, if available.
755 .. _abstract-digest-auth-handler:
757 AbstractDigestAuthHandler Objects
758 ---------------------------------
761 .. method:: AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)
763    *authreq* should be the name of the header where the information about the realm
764    is included in the request, *host* should be the host to authenticate to, *req*
765    should be the (failed) :class:`Request` object, and *headers* should be the
766    error headers.
769 .. _http-digest-auth-handler:
771 HTTPDigestAuthHandler Objects
772 -----------------------------
775 .. method:: HTTPDigestAuthHandler.http_error_401(req, fp, code,  msg, hdrs)
777    Retry the request with authentication information, if available.
780 .. _proxy-digest-auth-handler:
782 ProxyDigestAuthHandler Objects
783 ------------------------------
786 .. method:: ProxyDigestAuthHandler.http_error_407(req, fp, code,  msg, hdrs)
788    Retry the request with authentication information, if available.
791 .. _http-handler-objects:
793 HTTPHandler Objects
794 -------------------
797 .. method:: HTTPHandler.http_open(req)
799    Send an HTTP request, which can be either GET or POST, depending on
800    ``req.has_data()``.
803 .. _https-handler-objects:
805 HTTPSHandler Objects
806 --------------------
809 .. method:: HTTPSHandler.https_open(req)
811    Send an HTTPS request, which can be either GET or POST, depending on
812    ``req.has_data()``.
815 .. _file-handler-objects:
817 FileHandler Objects
818 -------------------
821 .. method:: FileHandler.file_open(req)
823    Open the file locally, if there is no host name, or the host name is
824    ``'localhost'``. Change the protocol to ``ftp`` otherwise, and retry opening it
825    using :attr:`parent`.
828 .. _ftp-handler-objects:
830 FTPHandler Objects
831 ------------------
834 .. method:: FTPHandler.ftp_open(req)
836    Open the FTP file indicated by *req*. The login is always done with empty
837    username and password.
840 .. _cacheftp-handler-objects:
842 CacheFTPHandler Objects
843 -----------------------
845 :class:`CacheFTPHandler` objects are :class:`FTPHandler` objects with the
846 following additional methods:
849 .. method:: CacheFTPHandler.setTimeout(t)
851    Set timeout of connections to *t* seconds.
854 .. method:: CacheFTPHandler.setMaxConns(m)
856    Set maximum number of cached connections to *m*.
859 .. _unknown-handler-objects:
861 UnknownHandler Objects
862 ----------------------
865 .. method:: UnknownHandler.unknown_open()
867    Raise a :exc:`URLError` exception.
870 .. _http-error-processor-objects:
872 HTTPErrorProcessor Objects
873 --------------------------
875 .. versionadded:: 2.4
878 .. method:: HTTPErrorProcessor.unknown_open()
880    Process HTTP error responses.
882    For 200 error codes, the response object is returned immediately.
884    For non-200 error codes, this simply passes the job on to the
885    :samp:`{protocol}_error_code` handler methods, via
886    :meth:`OpenerDirector.error`.  Eventually,
887    :class:`urllib2.HTTPDefaultErrorHandler` will raise an :exc:`HTTPError` if no
888    other handler handles the error.
891 .. _urllib2-examples:
893 Examples
894 --------
896 This example gets the python.org main page and displays the first 100 bytes of
897 it::
899    >>> import urllib2
900    >>> f = urllib2.urlopen('http://www.python.org/')
901    >>> print f.read(100)
902    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
903    <?xml-stylesheet href="./css/ht2html
905 Here we are sending a data-stream to the stdin of a CGI and reading the data it
906 returns to us. Note that this example will only work when the Python
907 installation supports SSL. ::
909    >>> import urllib2
910    >>> req = urllib2.Request(url='https://localhost/cgi-bin/test.cgi',
911    ...                       data='This data is passed to stdin of the CGI')
912    >>> f = urllib2.urlopen(req)
913    >>> print f.read()
914    Got Data: "This data is passed to stdin of the CGI"
916 The code for the sample CGI used in the above example is::
918    #!/usr/bin/env python
919    import sys
920    data = sys.stdin.read()
921    print 'Content-type: text-plain\n\nGot Data: "%s"' % data
923 Use of Basic HTTP Authentication::
925    import urllib2
926    # Create an OpenerDirector with support for Basic HTTP Authentication...
927    auth_handler = urllib2.HTTPBasicAuthHandler()
928    auth_handler.add_password(realm='PDQ Application',
929                              uri='https://mahler:8092/site-updates.py',
930                              user='klem',
931                              passwd='kadidd!ehopper')
932    opener = urllib2.build_opener(auth_handler)
933    # ...and install it globally so it can be used with urlopen.
934    urllib2.install_opener(opener)
935    urllib2.urlopen('http://www.example.com/login.html')
937 :func:`build_opener` provides many handlers by default, including a
938 :class:`ProxyHandler`.  By default, :class:`ProxyHandler` uses the environment
939 variables named ``<scheme>_proxy``, where ``<scheme>`` is the URL scheme
940 involved.  For example, the :envvar:`http_proxy` environment variable is read to
941 obtain the HTTP proxy's URL.
943 This example replaces the default :class:`ProxyHandler` with one that uses
944 programmatically-supplied proxy URLs, and adds proxy authorization support with
945 :class:`ProxyBasicAuthHandler`. ::
947    proxy_handler = urllib2.ProxyHandler({'http': 'http://www.example.com:3128/'})
948    proxy_auth_handler = urllib2.ProxyBasicAuthHandler()
949    proxy_auth_handler.add_password('realm', 'host', 'username', 'password')
951    opener = urllib2.build_opener(proxy_handler, proxy_auth_handler)
952    # This time, rather than install the OpenerDirector, we use it directly:
953    opener.open('http://www.example.com/login.html')
955 Adding HTTP headers:
957 Use the *headers* argument to the :class:`Request` constructor, or::
959    import urllib2
960    req = urllib2.Request('http://www.example.com/')
961    req.add_header('Referer', 'http://www.python.org/')
962    r = urllib2.urlopen(req)
964 :class:`OpenerDirector` automatically adds a :mailheader:`User-Agent` header to
965 every :class:`Request`.  To change this::
967    import urllib2
968    opener = urllib2.build_opener()
969    opener.addheaders = [('User-agent', 'Mozilla/5.0')]
970    opener.open('http://www.example.com/')
972 Also, remember that a few standard headers (:mailheader:`Content-Length`,
973 :mailheader:`Content-Type` and :mailheader:`Host`) are added when the
974 :class:`Request` is passed to :func:`urlopen` (or :meth:`OpenerDirector.open`).