[Python-checkins] r86712 - python/branches/py3k-urllib/Lib/urllib/request.py

senthil.kumaran python-checkins at python.org
Tue Nov 23 11:34:59 CET 2010


Author: senthil.kumaran
Date: Tue Nov 23 11:34:58 2010
New Revision: 86712

Log:
simple formatting and removing incomplete definitions

Modified:
   python/branches/py3k-urllib/Lib/urllib/request.py

Modified: python/branches/py3k-urllib/Lib/urllib/request.py
==============================================================================
--- python/branches/py3k-urllib/Lib/urllib/request.py	(original)
+++ python/branches/py3k-urllib/Lib/urllib/request.py	Tue Nov 23 11:34:58 2010
@@ -1,50 +1,40 @@
 """An extensible library for opening URLs using a variety of protocols
 
-The simplest way to use this module is to call the urlopen function,
-which accepts a string containing a URL or a Request object (described
-below).  It opens the URL and returns the results as file-like
-object; the returned object has some extra methods described below.
-
-The OpenerDirector manages a collection of Handler objects that do
-all the actual work.  Each Handler implements a particular protocol or
-option.  The OpenerDirector is a composite object that invokes the
-Handlers needed to open the requested URL.  For example, the
-HTTPHandler performs HTTP GET and POST requests and deals with
-non-error returns.  The HTTPRedirectHandler automatically deals with
-HTTP 301, 302, 303 and 307 redirect errors, and the HTTPDigestAuthHandler
-deals with digest authentication.
-
-urlopen(url, data=None) -- Basic usage is the same as original
-urllib.  pass the url and optionally data to post to an HTTP URL, and
-get a file-like object back.  One difference is that you can also pass
-a Request instance instead of URL.  Raises a URLError (subclass of
-IOError); for HTTP errors, raises an HTTPError, which can also be
-treated as a valid response.
-
-build_opener -- Function that creates a new OpenerDirector instance.
-Will install the default handlers.  Accepts one or more Handlers as
-arguments, either instances or Handler classes that it will
-instantiate.  If one of the argument is a subclass of the default
-handler, the argument will be installed instead of the default.
+The simplest way to use this module is to call the urlopen function, which
+accepts a string containing a URL or a Request object (described below).  It
+opens the URL and returns the results as file-like object; the returned object
+has some extra methods described below.
+
+The OpenerDirector manages a collection of Handler objects that do all the
+actual work.  Each Handler implements a particular protocol or option.  The
+OpenerDirector is a composite object that invokes the Handlers needed to open
+the requested URL.  For example, the HTTPHandler performs HTTP GET and POST
+requests and deals with non-error returns.  The HTTPRedirectHandler
+automatically deals with HTTP 301, 302, 303 and 307 redirect errors, and the
+HTTPDigestAuthHandler deals with digest authentication.
+
+urlopen(url, data=None) -- Basic usage is the same as original urllib.  pass
+the url and optionally data to post to an HTTP URL, and get a file-like object
+back.  One difference is that you can also pass a Request instance instead of
+URL.  Raises a URLError (subclass of IOError); for HTTP errors, raises an
+HTTPError, which can also be treated as a valid response.
+
+build_opener -- Function that creates a new OpenerDirector instance.  Will
+install the default handlers.  Accepts one or more Handlers as arguments,
+either instances or Handler classes that it will instantiate.  If one of the
+argument is a subclass of the default handler, the argument will be installed
+instead of the default.
 
 install_opener -- Installs a new opener as the default opener.
 
 objects of interest:
 
-OpenerDirector -- Sets up the User Agent as the Python-urllib client and manages
-the Handler classes, while dealing with requests and responses.
+OpenerDirector -- Sets up the User Agent as the Python-urllib client and
+manages the Handler classes, while dealing with requests and responses.
 
-Request -- An object that encapsulates the state of a request.  The
-state can be as simple as the URL.  It can also include extra HTTP
-headers, e.g. a User-Agent.
-
-BaseHandler --
-
-internals:
-BaseHandler and parent
-_call_chain conventions
-
-Example usage:
+Request -- An object that encapsulates the state of a request.  The state can
+be as simple as the URL.  It can also include extra HTTP headers, e.g. a
+User-Agent.
 
 import urllib.request
 


More information about the Python-checkins mailing list