summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-01-01 15:05:06 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-01-01 15:05:06 (GMT)
commit75edad0502c648148c6139b2d81a128559573c0d (patch)
treefe8dc37189c0d6b147fa7a9a02c75cf1e969a602 /Doc
parentda10d3b7a5b4c3be5b3bbf0c4cfcd18110a0decd (diff)
downloadcpython-75edad0502c648148c6139b2d81a128559573c0d.zip
cpython-75edad0502c648148c6139b2d81a128559573c0d.tar.gz
cpython-75edad0502c648148c6139b2d81a128559573c0d.tar.bz2
Merged revisions 68116-68119,68121,68123-68127 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r68116 | georg.brandl | 2009-01-01 05:46:51 -0600 (Thu, 01 Jan 2009) | 2 lines #4100: note that element children are not necessarily present on "start" events. ........ r68117 | georg.brandl | 2009-01-01 05:53:55 -0600 (Thu, 01 Jan 2009) | 2 lines #4156: make clear that "protocol" is to be replaced with the protocol name. ........ r68118 | georg.brandl | 2009-01-01 06:00:19 -0600 (Thu, 01 Jan 2009) | 2 lines #4185: clarify escape behavior of replacement strings. ........ r68119 | georg.brandl | 2009-01-01 06:09:40 -0600 (Thu, 01 Jan 2009) | 3 lines #4222: document dis.findlabels() and dis.findlinestarts() and put them into dis.__all__. ........ r68121 | georg.brandl | 2009-01-01 06:43:33 -0600 (Thu, 01 Jan 2009) | 2 lines Point to types module in new module deprecation notice. ........ r68123 | georg.brandl | 2009-01-01 06:52:29 -0600 (Thu, 01 Jan 2009) | 2 lines #4784: ... on three counts ... ........ r68124 | georg.brandl | 2009-01-01 06:53:19 -0600 (Thu, 01 Jan 2009) | 2 lines #4782: Fix markup error that hid load() and loads(). ........ r68125 | georg.brandl | 2009-01-01 07:02:09 -0600 (Thu, 01 Jan 2009) | 2 lines #4776: add data_files and package_dir arguments. ........ r68126 | georg.brandl | 2009-01-01 07:05:13 -0600 (Thu, 01 Jan 2009) | 2 lines Handlers are in the `logging.handlers` module. ........ r68127 | georg.brandl | 2009-01-01 07:14:49 -0600 (Thu, 01 Jan 2009) | 2 lines #4767: Use correct submodules for all MIME classes. ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/distutils/apiref.rst11
-rw-r--r--Doc/library/dis.rst17
-rw-r--r--Doc/library/email.mime.rst15
-rw-r--r--Doc/library/json.rst4
-rw-r--r--Doc/library/logging.rst4
-rw-r--r--Doc/library/webbrowser.rst2
-rw-r--r--Doc/library/xml.etree.elementtree.rst10
7 files changed, 56 insertions, 7 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index c3148a6..aec68c0 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -88,9 +88,9 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
| *options* | default options for the setup | a string |
| | script | |
+--------------------+--------------------------------+-------------------------------------------------------------+
- | *license* | The license for the package | |
+ | *license* | The license for the package | a string |
+--------------------+--------------------------------+-------------------------------------------------------------+
- | *keywords* | Descriptive meta-data. See | |
+ | *keywords* | Descriptive meta-data, see | |
| | :pep:`314` | |
+--------------------+--------------------------------+-------------------------------------------------------------+
| *platforms* | | |
@@ -98,6 +98,13 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
| *cmdclass* | A mapping of command names to | a dictionary |
| | :class:`Command` subclasses | |
+--------------------+--------------------------------+-------------------------------------------------------------+
+ | *data_files* | A list of data files to | a list |
+ | | install | |
+ +--------------------+--------------------------------+-------------------------------------------------------------+
+ | *package_dir* | A mapping of package to | a dictionary |
+ | | directory names | |
+ +--------------------+--------------------------------+-------------------------------------------------------------+
+
.. function:: run_setup(script_name[, script_args=None, stop_after='run'])
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index ab06542..39d37df 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -64,10 +64,23 @@ The :mod:`dis` module defines the following functions and constants:
.. function:: disco(code[, lasti])
- A synonym for disassemble. It is more convenient to type, and kept for
- compatibility with earlier Python releases.
+ A synonym for :func:`disassemble`. It is more convenient to type, and kept
+ for compatibility with earlier Python releases.
+.. function:: findlinestarts(code)
+
+ This generator function uses the ``co_firstlineno`` and ``co_lnotab``
+ attributes of the code object *code* to find the offsets which are starts of
+ lines in the source code. They are generated as ``(offset, lineno)`` pairs.
+
+
+.. function:: findlabels(code)
+
+ Detect all offsets in the code object *code* which are jump targets, and
+ return a list of these offsets.
+
+
.. data:: opname
Sequence of operation names, indexable using the bytecode.
diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst
index 13bd100..b0d2adc 100644
--- a/Doc/library/email.mime.rst
+++ b/Doc/library/email.mime.rst
@@ -19,6 +19,7 @@ things easier.
Here are the classes:
+.. currentmodule:: email.mime.base
.. class:: MIMEBase(_maintype, _subtype, **_params)
@@ -39,6 +40,8 @@ Here are the classes:
:mailheader:`MIME-Version` header (always set to ``1.0``).
+.. currentmodule:: email.mime.nonmultipart
+
.. class:: MIMENonMultipart()
Module: :mod:`email.mime.nonmultipart`
@@ -50,6 +53,8 @@ Here are the classes:
:exc:`MultipartConversionError` exception is raised.
+.. currentmodule:: email.mime.multipart
+
.. class:: MIMEMultipart([subtype[, boundary[, _subparts[, _params]]]])
Module: :mod:`email.mime.multipart`
@@ -73,6 +78,8 @@ Here are the classes:
dictionary.
+.. currentmodule:: email.mime.application
+
.. class:: MIMEApplication(_data[, _subtype[, _encoder[, **_params]]])
Module: :mod:`email.mime.application`
@@ -93,6 +100,8 @@ Here are the classes:
*_params* are passed straight through to the base class constructor.
+.. currentmodule:: email.mime.audio
+
.. class:: MIMEAudio(_audiodata[, _subtype[, _encoder[, **_params]]])
Module: :mod:`email.mime.audio`
@@ -116,6 +125,8 @@ Here are the classes:
*_params* are passed straight through to the base class constructor.
+.. currentmodule:: email.mime.image
+
.. class:: MIMEImage(_imagedata[, _subtype[, _encoder[, **_params]]])
Module: :mod:`email.mime.image`
@@ -139,6 +150,8 @@ Here are the classes:
*_params* are passed straight through to the :class:`MIMEBase` constructor.
+.. currentmodule:: email.mime.message
+
.. class:: MIMEMessage(_msg[, _subtype])
Module: :mod:`email.mime.message`
@@ -152,6 +165,8 @@ Here are the classes:
:mimetype:`rfc822`.
+.. currentmodule:: email.mime.text
+
.. class:: MIMEText(_text[, _subtype[, _charset]])
Module: :mod:`email.mime.text`
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index b67d724..cad841e 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -165,7 +165,7 @@ Basic Usage
:func:`dump`.
-.. function load(fp[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])
+.. function:: load(fp[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])
Deserialize *fp* (a ``.read()``-supporting file-like object containing a JSON
document) to a Python object.
@@ -201,7 +201,7 @@ Basic Usage
class.
-.. function loads(s[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])
+.. function:: loads(s[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])
Deserialize *s* (a :class:`str` or :class:`unicode` instance containing a JSON
document) to a Python object.
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index d1e4f76..df857b1 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1534,6 +1534,8 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
StreamHandler
^^^^^^^^^^^^^
+.. module:: logging.handlers
+
The :class:`StreamHandler` class, located in the core :mod:`logging` package,
sends logging output to streams such as *sys.stdout*, *sys.stderr* or any
file-like object (or, more precisely, any object which supports :meth:`write`
@@ -2035,6 +2037,8 @@ supports sending logging messages to a Web server, using either ``GET`` or
Formatter Objects
-----------------
+.. currentmodule:: logging
+
:class:`Formatter`\ s have the following attributes and methods. They are
responsible for converting a :class:`LogRecord` to (usually) a string which can
be interpreted by either a human or an external system. The base
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst
index 95e21b1..410fa48 100644
--- a/Doc/library/webbrowser.rst
+++ b/Doc/library/webbrowser.rst
@@ -167,7 +167,7 @@ Here are some simple examples::
Browser Controller Objects
--------------------------
-Browser controllers provide two methods which parallel two of the module-level
+Browser controllers provide these methods which parallel two of the module-level
convenience functions:
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index fde4fa6..d411c24 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -94,6 +94,16 @@ Functions
*events* is a list of events to report back. If omitted, only "end" events are
reported. Returns an :term:`iterator` providing ``(event, elem)`` pairs.
+ .. note::
+
+ :func:`iterparse` only guarantees that it has seen the ">"
+ character of a starting tag when it emits a "start" event, so the
+ attributes are defined, but the contents of the text and tail attributes
+ are undefined at that point. The same applies to the element children;
+ they may or may not be present.
+
+ If you need a fully populated element, look for "end" events instead.
+
.. function:: parse(source[, parser])