summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/email-examples.rst11
-rw-r--r--Doc/library/queue.rst2
-rw-r--r--Doc/library/socket.rst2
-rw-r--r--Doc/library/urllib2.rst39
4 files changed, 40 insertions, 14 deletions
diff --git a/Doc/library/email-examples.rst b/Doc/library/email-examples.rst
index 64a9944..f606f9b 100644
--- a/Doc/library/email-examples.rst
+++ b/Doc/library/email-examples.rst
@@ -16,18 +16,23 @@ pictures that may be residing in a directory:
Here's an example of how to send the entire contents of a directory as an email
-message: [1]_
+message: [1]_
.. literalinclude:: ../includes/email-dir.py
-And finally, here's an example of how to unpack a MIME message like the one
+Here's an example of how to unpack a MIME message like the one
above, into a directory of files:
.. literalinclude:: ../includes/email-unpack.py
+Here's an example of how to create an HTML message with an alternative plain
+text version: [2]_
+
+.. literalinclude:: ../includes/email-alternative.py
+
.. rubric:: Footnotes
.. [1] Thanks to Matthew Dixon Cowles for the original inspiration and examples.
-
+.. [2] Contributed by Martin Matejek.
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst
index 582f2cd..b5ba24d 100644
--- a/Doc/library/queue.rst
+++ b/Doc/library/queue.rst
@@ -71,7 +71,7 @@ The :mod:`Queue` module defines the following classes and exceptions:
Queue Objects
-------------
-Queue objects (:class:``Queue``, :class:``LifoQueue``, or :class:``PriorityQueue``
+Queue objects (:class:`Queue`, :class:`LifoQueue`, or :class:`PriorityQueue`)
provide the public methods described below.
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 7d2dea0..cb1b87c 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -23,7 +23,7 @@ PS1:7 and PS1:8). The platform-specific reference material for the various
socket-related system calls are also a valuable source of information on the
details of socket semantics. For Unix, refer to the manual pages; for Windows,
see the WinSock (or Winsock 2) specification. For IPv6-ready APIs, readers may
-want to refer to :rfc:`2553` titled Basic Socket Interface Extensions for IPv6.
+want to refer to :rfc:`3493` titled Basic Socket Interface Extensions for IPv6.
.. index:: object: socket
diff --git a/Doc/library/urllib2.rst b/Doc/library/urllib2.rst
index b3e5485..d77712f 100644
--- a/Doc/library/urllib2.rst
+++ b/Doc/library/urllib2.rst
@@ -33,10 +33,12 @@ The :mod:`urllib2` module defines the following functions:
This function returns a file-like object with two additional methods:
- * :meth:`geturl` --- return the URL of the resource retrieved
+ * :meth:`geturl` --- return the URL of the resource retrieved, commonly used to
+ determine if a redirect was followed
- * :meth:`info` --- return the meta-information of the page, as a dictionary-like
- object
+ * :meth:`info` --- return the meta-information of the page, such as headers, in
+ the form of an ``httplib.HTTPMessage`` instance
+ (see `Quick Reference to HTTP Headers <http://www.cs.tut.fi/~jkorpela/http.html>`_)
Raises :exc:`URLError` on errors.
@@ -81,18 +83,32 @@ The following exceptions are raised as appropriate:
The handlers raise this exception (or derived exceptions) when they run into a
problem. It is a subclass of :exc:`IOError`.
+ .. attribute:: reason
+
+ The reason for this error. It can be a message string or another exception
+ instance (:exc:`socket.error` for remote URLs, :exc:`OSError` for local
+ URLs).
+
.. exception:: HTTPError
- A subclass of :exc:`URLError`, it can also function as a non-exceptional
- file-like return value (the same thing that :func:`urlopen` returns). This
- is useful when handling exotic HTTP errors, such as requests for
- authentication.
+ Though being an exception (a subclass of :exc:`URLError`), an :exc:`HTTPError`
+ can also function as a non-exceptional file-like return value (the same thing
+ that :func:`urlopen` returns). This is useful when handling exotic HTTP
+ errors, such as requests for authentication.
+
+ .. attribute:: code
+
+ An HTTP status code as defined in `RFC 2616 <http://www.faqs.org/rfcs/rfc2616.html>`_.
+ This numeric value corresponds to a value found in the dictionary of
+ codes as found in :attr:`BaseHTTPServer.BaseHTTPRequestHandler.responses`.
+
+
The following classes are provided:
-.. class:: Request(url[, data][, headers] [, origin_req_host][, unverifiable])
+.. class:: Request(url[, data][, headers][, origin_req_host][, unverifiable])
This class is an abstraction of a URL request.
@@ -107,7 +123,12 @@ The following classes are provided:
returns a string in this format.
*headers* should be a dictionary, and will be treated as if :meth:`add_header`
- was called with each key and value as arguments.
+ was called with each key and value as arguments. This is often used to "spoof"
+ the ``User-Agent`` header, which is used by a browser to identify itself --
+ some HTTP servers only allow requests coming from common browsers as opposed
+ to scripts. For example, Mozilla Firefox may identify itself as ``"Mozilla/5.0
+ (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"``, while :mod:`urllib2`'s
+ default user agent string is ``"Python-urllib/2.6"`` (on Python 2.6).
The final two arguments are only of interest for correct handling of third-party
HTTP cookies: