[Python-checkins] r57197 - sandbox/trunk/urilib/urllib.py

[senthil.kumaran]

Author: senthil.kumaran
Date: Sun Aug 19 20:24:42 2007
New Revision: 57197

Modified:
   sandbox/trunk/urilib/urllib.py
Log:
Comment Header

Modified: sandbox/trunk/urilib/urllib.py
==============================================================================
--- sandbox/trunk/urilib/urllib.py	(original)
+++ sandbox/trunk/urilib/urllib.py	Sun Aug 19 20:24:42 2007
@@ -1,7 +1,31 @@
-"""Parse (absolute and relative) URLs.
+"""Unified Module: urlparse and urllib. G-SoC Task.
 
+urlparse: Parse (absolute and relative) URLs.
 See RFC 1808: "Relative Uniform Resource Locators", by R. Fielding,
 UC Irvine, June 1995.
+
+urllib:Open an arbitrary URL.
+See the following document for more info on URLs:
+"Names and Addresses, URIs, URLs, URNs, URCs", at
+http://www.w3.org/pub/WWW/Addressing/Overview.html
+
+See also the HTTP spec (from which the error codes are derived):
+"HTTP - Hypertext Transfer Protocol", at
+http://www.w3.org/pub/WWW/Protocols/
+
+Related standards and specs:
+- RFC1808: the "relative URL" spec. (authoritative status)
+- RFC1738 - the "URL standard". (authoritative status)
+- RFC1630 - the "URI spec". (informational status)
+
+The object returned by URLopener().open(file) will differ per
+protocol.  All you know is that is has methods read(), readline(),
+readlines(), fileno(), close() and info().  The read*(), fileno()
+and close() methods work like those of open files.
+The info() method returns a mimetools.Message object which can be
+used to query various info about the object, if available.
+(mimetools.Message objects are queried with the getheader() method.)
+
 """
 
 import string