traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some cleanup in the docs.

This commit is contained in:
Georg Brandl 2007-12-29 10:57:00 +00:00
parent 28c7bcf38e
commit b19be571e0
126 changed files with 804 additions and 1181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/Makefile
View File

@ -16,10 +16,11 @@ ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
help: help:
@echo "Please use \`make <target>' where <target> is one of" @echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files" @echo " html to make standalone HTML files"
@echo " web to make file usable by Sphinx.web" @echo " web to make file usable by Sphinx.web"
@echo " htmlhelp to make HTML files and a HTML help project" @echo " htmlhelp to make HTML files and a HTML help project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview over all changed/added/deprecated items"
checkout: checkout:
@if [ ! -d tools/sphinx ]; then \ @if [ ! -d tools/sphinx ]; then \
@ -66,6 +67,10 @@ latex: build
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex." "run these through (pdf)latex."
changes: BUILDER = changes
changes: build
@echo "The overview file is in build/changes."
clean: clean:
-rm -rf build/* -rm -rf build/*
-rm -rf tools/sphinx -rm -rf tools/sphinx

4
Doc/README.txt
View File

@ -51,6 +51,10 @@ Available make targets are:
* "latex", which builds LaTeX source files that can be run with "pdflatex" * "latex", which builds LaTeX source files that can be run with "pdflatex"
to produce PDF documents. to produce PDF documents.
* "changes", which builds an overview over all versionadded/versionchanged/
deprecated items in the current version. This is meant as a help for the
writer of the "What's New" document.
A "make update" updates the Subversion checkouts in `tools/`. A "make update" updates the Subversion checkouts in `tools/`.

4
Doc/c-api/exceptions.rst
View File

@ -37,8 +37,8 @@ Python variables ``sys.exc_type``, ``sys.exc_value`` and ``sys.exc_traceback``.
API functions exist to interact with the error indicator in various ways. There API functions exist to interact with the error indicator in various ways. There
is a separate error indicator for each thread. is a separate error indicator for each thread.
.. % XXX Order of these should be more thoughtful. .. XXX Order of these should be more thoughtful.
.. % Either alphabetical or some kind of structure. Either alphabetical or some kind of structure.
.. cfunction:: void PyErr_Print() .. cfunction:: void PyErr_Print()

6
Doc/c-api/init.rst
View File

@ -266,7 +266,7 @@ Initialization, Finalization, and Threads
as the list ``sys.path``, which may be modified to change the future search path as the list ``sys.path``, which may be modified to change the future search path
for loaded modules. for loaded modules.
.. % XXX should give the exact rules .. XXX should give the exact rules
.. cfunction:: const char* Py_GetVersion() .. cfunction:: const char* Py_GetVersion()
@ -361,8 +361,8 @@ Initialization, Finalization, and Threads
to initialize ``sys.argv``, a fatal condition is signalled using to initialize ``sys.argv``, a fatal condition is signalled using
:cfunc:`Py_FatalError`. :cfunc:`Py_FatalError`.
.. % XXX impl. doesn't seem consistent in allowing 0/NULL for the params; .. XXX impl. doesn't seem consistent in allowing 0/NULL for the params;
.. % check w/ Guido. check w/ Guido.
.. _threads: .. _threads:

2
Doc/c-api/intro.rst
View File

@ -489,7 +489,7 @@ Here is the corresponding C code, in all its glory::
single: PyErr_Clear() single: PyErr_Clear()
single: Py_XDECREF() single: Py_XDECREF()
This example represents an endorsed use of the :keyword:`goto` statement in C! This example represents an endorsed use of the ``goto`` statement in C!
It illustrates the use of :cfunc:`PyErr_ExceptionMatches` and It illustrates the use of :cfunc:`PyErr_ExceptionMatches` and
:cfunc:`PyErr_Clear` to handle specific exceptions, and the use of :cfunc:`PyErr_Clear` to handle specific exceptions, and the use of
:cfunc:`Py_XDECREF` to dispose of owned references that may be *NULL* (note the :cfunc:`Py_XDECREF` to dispose of owned references that may be *NULL* (note the

13
Doc/c-api/newtypes.rst
View File

@ -476,7 +476,7 @@ type objects) *must* have the :attr:`ob_size` field.
declare the instance struct) and this in turn includes the :attr:`_ob_prev` and declare the instance struct) and this in turn includes the :attr:`_ob_prev` and
:attr:`_ob_next` fields if they are present. This means that the only correct :attr:`_ob_next` fields if they are present. This means that the only correct
way to get an initializer for the :attr:`tp_basicsize` is to use the way to get an initializer for the :attr:`tp_basicsize` is to use the
:keyword:`sizeof` operator on the struct used to declare the instance layout. ``sizeof`` operator on the struct used to declare the instance layout.
The basic size does not include the GC header size (this is new in Python 2.2; The basic size does not include the GC header size (this is new in Python 2.2;
in 2.1 and 2.0, the GC header size was included in :attr:`tp_basicsize`). in 2.1 and 2.0, the GC header size was included in :attr:`tp_basicsize`).
@ -1175,7 +1175,7 @@ The next fields, up to and including :attr:`tp_weaklist`, only exist if the
PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type); PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
XXX blah, blah. XXX explain.
This field is inherited by subtypes. This field is inherited by subtypes.
@ -1190,7 +1190,7 @@ The next fields, up to and including :attr:`tp_weaklist`, only exist if the
This field is inherited by subtypes. This field is inherited by subtypes.
XXX blah, blah. XXX explain.
.. cmember:: long PyTypeObject.tp_dictoffset .. cmember:: long PyTypeObject.tp_dictoffset
@ -1734,10 +1734,9 @@ member in the :ctype:`PyTypeObject` structure should be *NULL*. Otherwise, the
and :exc:`SystemError` should be raised when *segment* specifies a segment that and :exc:`SystemError` should be raised when *segment* specifies a segment that
doesn't exist. doesn't exist.
.. % Why doesn't it raise ValueError for this one? .. Why doesn't it raise ValueError for this one?
.. % GJS: because you shouldn't be calling it with an invalid GJS: because you shouldn't be calling it with an invalid
.. % segment. That indicates a blatant programming error in the C segment. That indicates a blatant programming error in the C code.
.. % code.
.. ctype:: Py_ssize_t (*segcountproc) (PyObject *self, Py_ssize_t *lenp) .. ctype:: Py_ssize_t (*segcountproc) (PyObject *self, Py_ssize_t *lenp)

2
Doc/distutils/setupscript.rst
View File

@ -137,7 +137,7 @@ the Distutils to go out and find the right files; you have to specify the
extension name, source file(s), and any compile/link requirements (include extension name, source file(s), and any compile/link requirements (include
directories, libraries to link with, etc.). directories, libraries to link with, etc.).
.. % XXX read over this section .. XXX read over this section
All of this is done through another keyword argument to :func:`setup`, the All of this is done through another keyword argument to :func:`setup`, the
:option:`ext_modules` option. :option:`ext_modules` is just a list of :option:`ext_modules` option. :option:`ext_modules` is just a list of

30
Doc/documenting/fromlatex.rst
View File

@ -154,25 +154,35 @@ These changes to information units should be noted:
Description. Description.
* **New information unit** * **New information units**
There is a new generic information unit called "describe" which can be used There are new generic information units: One is called "describe" and can be
to document things that are not covered by the other units:: used to document things that are not covered by the other units::
.. describe:: a == b .. describe:: a == b
The equals operator. The equals operator.
The others are::
.. cmdoption:: -O
Describes a command-line option.
.. envvar:: PYTHONINSPECT
Describes an environment variable.
Structure Structure
--------- ---------
The LaTeX docs were split in several toplevel manuals. Now, all files The LaTeX docs were split in several toplevel manuals. Now, all files are part
are part of the same documentation tree, as indicated by the *toctree* of the same documentation tree, as indicated by the *toctree* directives in the
directives in the sources. Every *toctree* directive embeds other files sources (though individual output formats may choose to split them up into parts
as subdocuments of the current file (this structure is not necessarily again). Every *toctree* directive embeds other files as subdocuments of the
mirrored in the filesystem layout). The toplevel file is current file (this structure is not necessarily mirrored in the filesystem
:file:`contents.rst`. layout). The toplevel file is :file:`contents.rst`.
However, most of the old directory structure has been kept, with the However, most of the old directory structure has been kept, with the
directories renamed as follows: directories renamed as follows:
@ -184,7 +194,7 @@ directories renamed as follows:
* :file:`inst` -> :file:`installing` * :file:`inst` -> :file:`installing`
* :file:`lib` -> :file:`library` * :file:`lib` -> :file:`library`
* :file:`mac` -> merged into :file:`library`, with :file:`mac/using.tex` * :file:`mac` -> merged into :file:`library`, with :file:`mac/using.tex`
moved to :file:`howto/pythonmac.rst` moved to :file:`using/mac.rst`
* :file:`ref` -> :file:`reference` * :file:`ref` -> :file:`reference`
* :file:`tut` -> :file:`tutorial`, with the single TeX file split up * :file:`tut` -> :file:`tutorial`, with the single TeX file split up

2
Doc/documenting/markup.rst
View File

@ -455,7 +455,7 @@ in a different style:
.. describe:: keyword .. describe:: keyword
The name of a keyword in a programming language. The name of a keyword in Python.
.. describe:: mailheader .. describe:: mailheader

26
Doc/documenting/sphinx.rst
View File

@ -47,14 +47,30 @@ unused_files : list of strings
could be docs for temporarily disabled modules or documentation that's not could be docs for temporarily disabled modules or documentation that's not
yet ready for public consumption. yet ready for public consumption.
last_updated_format : string add_function_parentheses : bool
If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and
``:cfunc:`` cross-references.
add_module_names : bool
If true, the current module name will be prepended to all description unit
titles (such as ``.. function::``).
Builder-specific variables
^^^^^^^^^^^^^^^^^^^^^^^^^^
html_download_base_url : string
The base URL for download links on the download page.
html_last_updated_fmt : string
If this is not an empty string, it will be given to ``time.strftime()`` and If this is not an empty string, it will be given to ``time.strftime()`` and
written to each generated output file after "last updated on:". written to each generated output file after "last updated on:".
use_smartypants : bool html_use_smartypants : bool
If true, use SmartyPants to convert quotes and dashes to the typographically If true, use SmartyPants to convert quotes and dashes to the typographically
correct entities. correct entities.
add_function_parentheses : bool latex_paper_size : "letter" or "a4"
If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and The paper size option for the LaTeX document class.
``:cfunc:`` cross-references.
latex_font_size : "10pt", "11pt" or "12pt"
The font size option for the LaTeX document class.

17
Doc/extending/embedding.rst
View File

@ -155,11 +155,7 @@ then the result should be::
Although the program is quite large for its functionality, most of the code is Although the program is quite large for its functionality, most of the code is
for data conversion between Python and C, and for error reporting. The for data conversion between Python and C, and for error reporting. The
interesting part with respect to embedding Python starts with interesting part with respect to embedding Python starts with ::
.. % $
::
Py_Initialize(); Py_Initialize();
pName = PyString_FromString(argv[1]); pName = PyString_FromString(argv[1]);
@ -239,15 +235,8 @@ With these extensions, the Python script can do things like ::
In a real application, the methods will expose an API of the application to In a real application, the methods will expose an API of the application to
Python. Python.
.. % \section{For the future} .. TODO: threads, code examples do not really behave well if errors happen
.. % (what to watch out for)
.. % You don't happen to have a nice library to get textual
.. % equivalents of numeric values do you :-) ?
.. % Callbacks here ? (I may be using information from that section
.. % ?!)
.. % threads
.. % code examples do not really behave well if errors happen
.. % (what to watch out for)
.. _embeddingincplusplus: .. _embeddingincplusplus:

29
Doc/extending/extending.rst
View File

@ -307,7 +307,7 @@ function.
The method table must be passed to the interpreter in the module's The method table must be passed to the interpreter in the module's
initialization function. The initialization function must be named initialization function. The initialization function must be named
:cfunc:`initname`, where *name* is the name of the module, and should be the :cfunc:`initname`, where *name* is the name of the module, and should be the
only non-\ :keyword:`static` item defined in the module file:: only non-\ ``static`` item defined in the module file::
PyMODINIT_FUNC PyMODINIT_FUNC
initspam(void) initspam(void)
@ -665,11 +665,7 @@ it returns false and raises an appropriate exception.
.. index:: single: Philbrick, Geoff .. index:: single: Philbrick, Geoff
Here is an example module which uses keywords, based on an example by Geoff Here is an example module which uses keywords, based on an example by Geoff
Philbrick (philbrick@hks.com): Philbrick (philbrick@hks.com)::
.. %
::
#include "Python.h" #include "Python.h"
@ -765,8 +761,8 @@ Reference Counts
In languages like C or C++, the programmer is responsible for dynamic allocation In languages like C or C++, the programmer is responsible for dynamic allocation
and deallocation of memory on the heap. In C, this is done using the functions and deallocation of memory on the heap. In C, this is done using the functions
:cfunc:`malloc` and :cfunc:`free`. In C++, the operators :keyword:`new` and :cfunc:`malloc` and :cfunc:`free`. In C++, the operators ``new`` and
:keyword:`delete` are used with essentially the same meaning and we'll restrict ``delete`` are used with essentially the same meaning and we'll restrict
the following discussion to the C case. the following discussion to the C case.
Every block of memory allocated with :cfunc:`malloc` should eventually be Every block of memory allocated with :cfunc:`malloc` should eventually be
@ -1039,11 +1035,10 @@ that it is always a tuple. [#]_
It is a severe error to ever let a *NULL* pointer "escape" to the Python user. It is a severe error to ever let a *NULL* pointer "escape" to the Python user.
.. % Frank Stajano: .. Frank Stajano:
.. % A pedagogically buggy example, along the lines of the previous listing, A pedagogically buggy example, along the lines of the previous listing, would
.. % would be helpful here -- showing in more concrete terms what sort of be helpful here -- showing in more concrete terms what sort of actions could
.. % actions could cause the problem. I can't very well imagine it from the cause the problem. I can't very well imagine it from the description.
.. % description.
.. _cplusplus: .. _cplusplus:
@ -1079,7 +1074,7 @@ lists, this new collection type should have a set of C functions for direct
manipulation from other extension modules. manipulation from other extension modules.
At first sight this seems easy: just write the functions (without declaring them At first sight this seems easy: just write the functions (without declaring them
:keyword:`static`, of course), provide an appropriate header file, and document ``static``, of course), provide an appropriate header file, and document
the C API. And in fact this would work if all extension modules were always the C API. And in fact this would work if all extension modules were always
linked statically with the Python interpreter. When modules are used as shared linked statically with the Python interpreter. When modules are used as shared
libraries, however, the symbols defined in one module may not be visible to libraries, however, the symbols defined in one module may not be visible to
@ -1092,7 +1087,7 @@ the module whose functions one wishes to call might not have been loaded yet!
Portability therefore requires not to make any assumptions about symbol Portability therefore requires not to make any assumptions about symbol
visibility. This means that all symbols in extension modules should be declared visibility. This means that all symbols in extension modules should be declared
:keyword:`static`, except for the module's initialization function, in order to ``static``, except for the module's initialization function, in order to
avoid name clashes with other extension modules (as discussed in section avoid name clashes with other extension modules (as discussed in section
:ref:`methodtable`). And it means that symbols that *should* be accessible from :ref:`methodtable`). And it means that symbols that *should* be accessible from
other extension modules must be exported in a different way. other extension modules must be exported in a different way.
@ -1127,7 +1122,7 @@ reality (such as adding "spam" to every command). This function
:cfunc:`PySpam_System` is also exported to other extension modules. :cfunc:`PySpam_System` is also exported to other extension modules.
The function :cfunc:`PySpam_System` is a plain C function, declared The function :cfunc:`PySpam_System` is a plain C function, declared
:keyword:`static` like everything else:: ``static`` like everything else::
static int static int
PySpam_System(const char *command) PySpam_System(const char *command)
@ -1183,7 +1178,7 @@ function must take care of initializing the C API pointer array::
PyModule_AddObject(m, "_C_API", c_api_object); PyModule_AddObject(m, "_C_API", c_api_object);
} }
Note that ``PySpam_API`` is declared :keyword:`static`; otherwise the pointer Note that ``PySpam_API`` is declared ``static``; otherwise the pointer
array would disappear when :func:`initspam` terminates! array would disappear when :func:`initspam` terminates!
The bulk of the work is in the header file :file:`spammodule.h`, which looks The bulk of the work is in the header file :file:`spammodule.h`, which looks

20
Doc/extending/newtypes.rst
View File

@ -232,8 +232,6 @@ at a shell should produce a file :file:`noddy.so` in a subdirectory; move to
that directory and fire up Python --- you should be able to ``import noddy`` and that directory and fire up Python --- you should be able to ``import noddy`` and
play around with Noddy objects. play around with Noddy objects.
.. % $ <-- bow to font-lock ;-(
That wasn't so hard, was it? That wasn't so hard, was it?
Of course, the current Noddy type is pretty uninteresting. It has no data and Of course, the current Noddy type is pretty uninteresting. It has no data and
@ -1235,16 +1233,14 @@ class object, and get the doc string using its :attr:`__doc__` attribute.
As with the :attr:`tp_methods` table, a sentinel entry with a :attr:`name` value As with the :attr:`tp_methods` table, a sentinel entry with a :attr:`name` value
of *NULL* is required. of *NULL* is required.
.. % XXX Descriptors need to be explained in more detail somewhere, but .. XXX Descriptors need to be explained in more detail somewhere, but not here.
.. % not here.
.. % Descriptor objects have two handler functions which correspond to the
.. % Descriptor objects have two handler functions which correspond to \member{tp_getattro} and \member{tp_setattro} handlers. The
.. % the \member{tp_getattro} and \member{tp_setattro} handlers. The \method{__get__()} handler is a function which is passed the descriptor,
.. % \method{__get__()} handler is a function which is passed the instance, and type objects, and returns the value of the attribute, or it
.. % descriptor, instance, and type objects, and returns the value of the returns \NULL{} and sets an exception. The \method{__set__()} handler is
.. % attribute, or it returns \NULL{} and sets an exception. The passed the descriptor, instance, type, and new value;
.. % \method{__set__()} handler is passed the descriptor, instance, type,
.. % and new value;
Type-specific Attribute Management Type-specific Attribute Management

2
Doc/extending/windows.rst
View File

@ -7,8 +7,6 @@
Building C and C++ Extensions on Windows Building C and C++ Extensions on Windows
**************************************** ****************************************
.. %
This chapter briefly explains how to create a Windows extension module for This chapter briefly explains how to create a Windows extension module for
Python using Microsoft Visual C++, and follows with more detailed background Python using Microsoft Visual C++, and follows with more detailed background
information on how it works. The explanatory material is useful for both the information on how it works. The explanatory material is useful for both the

16
Doc/howto/advocacy.rst
View File

@ -302,11 +302,11 @@ http://www.pythonology.com/success
The Python Success Stories are a collection of stories from successful users of The Python Success Stories are a collection of stories from successful users of
Python, with the emphasis on business and corporate users. Python, with the emphasis on business and corporate users.
.. % \term{\url{http://www.fsbassociates.com/books/pythonchpt1.htm}} .. http://www.fsbassociates.com/books/pythonchpt1.htm
.. % The first chapter of \emph{Internet Programming with Python} also The first chapter of \emph{Internet Programming with Python} also
.. % examines some of the reasons for using Python. The book is well worth examines some of the reasons for using Python. The book is well worth
.. % buying, but the publishers have made the first chapter available on buying, but the publishers have made the first chapter available on
.. % the Web. the Web.
http://home.pacbell.net/ouster/scripting.html http://home.pacbell.net/ouster/scripting.html
John Ousterhout's white paper on scripting is a good argument for the utility of John Ousterhout's white paper on scripting is a good argument for the utility of
@ -333,9 +333,9 @@ http://pythonjournal.cognizor.com/pyj1/Everitt-Feit_interview98-V1.html
to show that choosing Python didn't introduce any difficulties into a company's to show that choosing Python didn't introduce any difficulties into a company's
development process, and provided some substantial benefits. development process, and provided some substantial benefits.
.. % \term{\url{http://www.python.org/psa/Commercial.html}} .. http://www.python.org/psa/Commercial.html
.. % Robin Friedrich wrote this document on how to support Python's use in Robin Friedrich wrote this document on how to support Python's use in
.. % commercial projects. commercial projects.
http://www.python.org/workshops/1997-10/proceedings/stein.ps http://www.python.org/workshops/1997-10/proceedings/stein.ps
For the 6th Python conference, Greg Stein presented a paper that traced Python's For the 6th Python conference, Greg Stein presented a paper that traced Python's

2
Doc/howto/doanddont.rst
View File

@ -290,7 +290,7 @@ are often more then is comfortable to put in one line, many people do::
calculate_number(10, 20) != forbulate(500, 360): calculate_number(10, 20) != forbulate(500, 360):
pass pass
You should realize that this is dangerous: a stray space after the ``XXX`` would You should realize that this is dangerous: a stray space after the ``\`` would
make this line wrong, and stray spaces are notoriously hard to see in editors. make this line wrong, and stray spaces are notoriously hard to see in editors.
In this case, at least it would be a syntax error, but if the code was:: In this case, at least it would be a syntax error, but if the code was::

34
Doc/howto/regex.rst
View File

@ -5,11 +5,11 @@
:Author: A.M. Kuchling :Author: A.M. Kuchling
:Release: 0.05 :Release: 0.05
.. % TODO: .. TODO:
.. % Document lookbehind assertions Document lookbehind assertions
.. % Better way of displaying a RE, a string, and what it matches Better way of displaying a RE, a string, and what it matches
.. % Mention optional argument to match.groups() Mention optional argument to match.groups()
.. % Unicode (at least a reference) Unicode (at least a reference)
.. topic:: Abstract .. topic:: Abstract
@ -91,8 +91,6 @@ is the same as ``[a-c]``, which uses a range to express the same set of
characters. If you wanted to match only lowercase letters, your RE would be characters. If you wanted to match only lowercase letters, your RE would be
``[a-z]``. ``[a-z]``.
.. % $
Metacharacters are not active inside classes. For example, ``[akm$]`` will Metacharacters are not active inside classes. For example, ``[akm$]`` will
match any of the characters ``'a'``, ``'k'``, ``'m'``, or ``'$'``; ``'$'`` is match any of the characters ``'a'``, ``'k'``, ``'m'``, or ``'$'``; ``'$'`` is
usually a metacharacter, but inside a character class it's stripped of its usually a metacharacter, but inside a character class it's stripped of its
@ -679,8 +677,8 @@ given location, they can obviously be matched an infinite number of times.
>>> print re.search('^From', 'Reciting From Memory') >>> print re.search('^From', 'Reciting From Memory')
None None
.. % To match a literal \character{\^}, use \regexp{\e\^} or enclose it .. To match a literal \character{\^}, use \regexp{\e\^} or enclose it
.. % inside a character class, as in \regexp{[{\e}\^]}. .. inside a character class, as in \regexp{[{\e}\^]}.
``$`` ``$``
Matches at the end of a line, which is defined as either the end of the string, Matches at the end of a line, which is defined as either the end of the string,
@ -696,8 +694,6 @@ given location, they can obviously be matched an infinite number of times.
To match a literal ``'$'``, use ``\$`` or enclose it inside a character class, To match a literal ``'$'``, use ``\$`` or enclose it inside a character class,
as in ``[$]``. as in ``[$]``.
.. % $
``\A`` ``\A``
Matches only at the start of the string. When not in :const:`MULTILINE` mode, Matches only at the start of the string. When not in :const:`MULTILINE` mode,
``\A`` and ``^`` are effectively the same. In :const:`MULTILINE` mode, they're ``\A`` and ``^`` are effectively the same. In :const:`MULTILINE` mode, they're
@ -980,12 +976,8 @@ filenames where the extension is not ``bat``? Some incorrect attempts:
that the first character of the extension is not a ``b``. This is wrong, that the first character of the extension is not a ``b``. This is wrong,
because the pattern also doesn't match ``foo.bar``. because the pattern also doesn't match ``foo.bar``.
.. % $
``.*[.]([^b]..|.[^a].|..[^t])$`` ``.*[.]([^b]..|.[^a].|..[^t])$``
.. % Messes up the HTML without the curly braces around \^
The expression gets messier when you try to patch up the first solution by The expression gets messier when you try to patch up the first solution by
requiring one of the following cases to match: the first character of the requiring one of the following cases to match: the first character of the
extension isn't ``b``; the second character isn't ``a``; or the third character extension isn't ``b``; the second character isn't ``a``; or the third character
@ -1013,16 +1005,12 @@ match, the whole pattern will fail. The trailing ``$`` is required to ensure
that something like ``sample.batch``, where the extension only starts with that something like ``sample.batch``, where the extension only starts with
``bat``, will be allowed. ``bat``, will be allowed.
.. % $
Excluding another filename extension is now easy; simply add it as an Excluding another filename extension is now easy; simply add it as an
alternative inside the assertion. The following pattern excludes filenames that alternative inside the assertion. The following pattern excludes filenames that
end in either ``bat`` or ``exe``: end in either ``bat`` or ``exe``:
``.*[.](?!bat$|exe$).*$`` ``.*[.](?!bat$|exe$).*$``
.. % $
Modifying Strings Modifying Strings
================= =================
@ -1343,16 +1331,10 @@ enables REs to be formatted more neatly::
\s*$ # Trailing whitespace to end-of-line \s*$ # Trailing whitespace to end-of-line
""", re.VERBOSE) """, re.VERBOSE)
This is far more readable than: This is far more readable than::
.. % $
::
pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$") pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
.. % $
Feedback Feedback
======== ========

43
Doc/install/index.rst
View File

@ -10,18 +10,17 @@
:Release: |version| :Release: |version|
:Date: |today| :Date: |today|
.. % TODO: .. TODO: Fill in XXX comments
.. % Fill in XXX comments
.. % The audience for this document includes people who don't know anything .. The audience for this document includes people who don't know anything
.. % about Python and aren't about to learn the language just in order to about Python and aren't about to learn the language just in order to
.. % install and maintain it for their users, i.e. system administrators. install and maintain it for their users, i.e. system administrators.
.. % Thus, I have to be sure to explain the basics at some point: Thus, I have to be sure to explain the basics at some point:
.. % sys.path and PYTHONPATH at least. Should probably give pointers to sys.path and PYTHONPATH at least. Should probably give pointers to
.. % other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc. other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc.
.. %
.. % Finally, it might be useful to include all the material from my "Care Finally, it might be useful to include all the material from my "Care
.. % and Feeding of a Python Installation" talk in here somewhere. Yow! and Feeding of a Python Installation" talk in here somewhere. Yow!
.. topic:: Abstract .. topic:: Abstract
@ -517,11 +516,7 @@ might define the following installation scheme::
--install-scripts=python/scripts --install-scripts=python/scripts
--install-data=python/data --install-data=python/data
or, equivalently, or, equivalently, ::
.. % $ % -- bow to font-lock
::
python setup.py install --home=~/python \ python setup.py install --home=~/python \
--install-purelib=lib \ --install-purelib=lib \
@ -533,8 +528,6 @@ or, equivalently,
the Distutils as it parses your command line options, just as it does when the Distutils as it parses your command line options, just as it does when
parsing your configuration file(s). parsing your configuration file(s).
.. % $ % -- bow to font-lock
Obviously, specifying the entire installation scheme every time you install a Obviously, specifying the entire installation scheme every time you install a
new module distribution would be very tedious. Thus, you can put these options new module distribution would be very tedious. Thus, you can put these options
into your Distutils config file (see section :ref:`inst-config-files`):: into your Distutils config file (see section :ref:`inst-config-files`)::
@ -574,11 +567,11 @@ environment variables, such as Mac OS 9, the configuration variables supplied by
the Distutils are the only ones you can use.) See section :ref:`inst-config-files` the Distutils are the only ones you can use.) See section :ref:`inst-config-files`
for details. for details.
.. % XXX need some Windows examples---when would custom .. XXX need some Windows examples---when would custom installation schemes be
.. % installation schemes be needed on those platforms? needed on those platforms?
.. % XXX I'm not sure where this section should go.
.. XXX I'm not sure where this section should go.
.. _inst-search-path: .. _inst-search-path:
@ -890,8 +883,8 @@ Microsoft Visual C++, which uses COFF as the object file format.) For this
reason you have to convert Python's library :file:`python25.lib` into the reason you have to convert Python's library :file:`python25.lib` into the
Borland format. You can do this as follows: Borland format. You can do this as follows:
.. % Should we mention that users have to create cfg-files for the compiler? .. Should we mention that users have to create cfg-files for the compiler?
.. % see also http://community.borland.com/article/0,1410,21205,00.html .. see also http://community.borland.com/article/0,1410,21205,00.html
:: ::
@ -949,8 +942,8 @@ a good program for this task at
http://starship.python.net/crew/kernr/mingw32/Notes.html, see at PExports 0.42h http://starship.python.net/crew/kernr/mingw32/Notes.html, see at PExports 0.42h
there.) there.)
.. % I don't understand what the next line means. --amk .. I don't understand what the next line means. --amk
.. % (inclusive the references on data structures.) .. (inclusive the references on data structures.)
:: ::

4
Doc/library/aepack.rst
View File

@ -6,9 +6,7 @@
:platform: Mac :platform: Mac
:synopsis: Conversion between Python variables and AppleEvent data containers. :synopsis: Conversion between Python variables and AppleEvent data containers.
.. sectionauthor:: Vincent Marchetti <vincem@en.com> .. sectionauthor:: Vincent Marchetti <vincem@en.com>
.. moduleauthor:: Jack Jansen
.. % \moduleauthor{Jack Jansen?}{email}
The :mod:`aepack` module defines functions for converting (packing) Python The :mod:`aepack` module defines functions for converting (packing) Python
variables to AppleEvent descriptors and back (unpacking). Within Python the variables to AppleEvent descriptors and back (unpacking). Within Python the

4
Doc/library/aetools.rst
View File

@ -6,9 +6,7 @@
:platform: Mac :platform: Mac
:synopsis: Basic support for sending Apple Events :synopsis: Basic support for sending Apple Events
.. sectionauthor:: Jack Jansen <Jack.Jansen@cwi.nl> .. sectionauthor:: Jack Jansen <Jack.Jansen@cwi.nl>
.. moduleauthor:: Jack Jansen
.. % \moduleauthor{Jack Jansen?}{email}
The :mod:`aetools` module contains the basic functionality on which Python The :mod:`aetools` module contains the basic functionality on which Python
AppleScript client support is built. It also imports and re-exports the core AppleScript client support is built. It also imports and re-exports the core

4
Doc/library/aetypes.rst
View File

@ -6,9 +6,7 @@
:platform: Mac :platform: Mac
:synopsis: Python representation of the Apple Event Object Model. :synopsis: Python representation of the Apple Event Object Model.
.. sectionauthor:: Vincent Marchetti <vincem@en.com> .. sectionauthor:: Vincent Marchetti <vincem@en.com>
.. moduleauthor:: Jack Jansen
.. % \moduleauthor{Jack Jansen?}{email}
The :mod:`aetypes` defines classes used to represent Apple Event data The :mod:`aetypes` defines classes used to represent Apple Event data
descriptors and Apple Event object specifiers. descriptors and Apple Event object specifiers.

3
Doc/library/asyncore.rst
View File

@ -8,13 +8,12 @@
.. moduleauthor:: Sam Rushing <rushing@nightmare.com> .. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Christopher Petrilli <petrilli@amber.org> .. sectionauthor:: Christopher Petrilli <petrilli@amber.org>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com> .. sectionauthor:: Steve Holden <sholden@holdenweb.com>
.. heavily adapted from original documentation by Sam Rushing
This module provides the basic infrastructure for writing asynchronous socket This module provides the basic infrastructure for writing asynchronous socket
service clients and servers. service clients and servers.
.. % Heavily adapted from original documentation by Sam Rushing.
There are only two ways to have a program on a single processor do "more than There are only two ways to have a program on a single processor do "more than
one thing at a time." Multi-threaded programming is the simplest and most one thing at a time." Multi-threaded programming is the simplest and most
popular way to do it, but there is another very different technique, that lets popular way to do it, but there is another very different technique, that lets

2
Doc/library/audioop.rst
View File

@ -20,7 +20,7 @@ specified otherwise.
This module provides support for a-LAW, u-LAW and Intel/DVI ADPCM encodings. This module provides support for a-LAW, u-LAW and Intel/DVI ADPCM encodings.
.. % This para is mostly here to provide an excuse for the index entries... .. This para is mostly here to provide an excuse for the index entries...
A few of the more complicated operations only take 16-bit samples, otherwise the A few of the more complicated operations only take 16-bit samples, otherwise the
sample size (in bytes) is always a parameter of the operation. sample size (in bytes) is always a parameter of the operation.

8
Doc/library/bastion.rst
View File

@ -22,11 +22,11 @@ object. It must always be used with the :mod:`rexec` module, in order to allow
restricted-mode programs access to certain safe attributes of an object, while restricted-mode programs access to certain safe attributes of an object, while
denying access to other, unsafe attributes. denying access to other, unsafe attributes.
.. % I'm concerned that the word 'bastion' won't be understood by people .. I'm concerned that the word 'bastion' won't be understood by people
.. % for whom English is a second language, making the module name .. for whom English is a second language, making the module name
.. % somewhat mysterious. Thus, the brief definition... --amk .. somewhat mysterious. Thus, the brief definition... --amk
.. % I've punted on the issue of documenting keyword arguments for now. .. I've punted on the issue of documenting keyword arguments for now.
.. function:: Bastion(object[, filter[, name[, class]]]) .. function:: Bastion(object[, filter[, name[, class]]])

6
Doc/library/bisect.rst
View File

@ -5,11 +5,7 @@
.. module:: bisect .. module:: bisect
:synopsis: Array bisection algorithms for binary searching. :synopsis: Array bisection algorithms for binary searching.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. example based on the PyModules FAQ entry by Aaron Watters <arw@pythonpros.com>
.. % LaTeX produced by Fred L. Drake, Jr. <fdrake@acm.org>, with an
.. % example based on the PyModules FAQ entry by Aaron Watters
.. % <arw@pythonpros.com>.
This module provides support for maintaining a list in sorted order without This module provides support for maintaining a list in sorted order without
having to sort the list after each insertion. For long lists of items with having to sort the list after each insertion. For long lists of items with

2
Doc/library/cgi.rst
View File

@ -178,7 +178,7 @@ intuitive way. The interface doesn't make the techniques described in previous
sections obsolete --- they are still useful to process file uploads efficiently, sections obsolete --- they are still useful to process file uploads efficiently,
for example. for example.
.. % XXX: Is this true ? .. XXX: Is this true ?
The interface consists of two simple methods. Using the methods you can process The interface consists of two simple methods. Using the methods you can process
form data in a generic way, without the need to worry whether only one or more form data in a generic way, without the need to worry whether only one or more

4
Doc/library/codeop.rst
View File

@ -7,9 +7,6 @@
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Michael Hudson <mwh@python.net> .. sectionauthor:: Michael Hudson <mwh@python.net>
.. % LaTeXed from excellent doc-string.
The :mod:`codeop` module provides utilities upon which the Python The :mod:`codeop` module provides utilities upon which the Python
read-eval-print loop can be emulated, as is done in the :mod:`code` module. As read-eval-print loop can be emulated, as is done in the :mod:`code` module. As
a result, you probably don't want to use the module directly; if you want to a result, you probably don't want to use the module directly; if you want to
@ -29,7 +26,6 @@ of doing them both.
To do just the former: To do just the former:
.. function:: compile_command(source[, filename[, symbol]]) .. function:: compile_command(source[, filename[, symbol]])
Tries to compile *source*, which should be a string of Python code and return a Tries to compile *source*, which should be a string of Python code and return a

2
Doc/library/collections.rst
View File

@ -60,7 +60,7 @@ ordered dictionaries.
where only the most recent activity is of interest. where only the most recent activity is of interest.
.. versionchanged:: 2.6 .. versionchanged:: 2.6
Added *maxlen* Added *maxlen* parameter.
Deque objects support the following methods: Deque objects support the following methods:

2
Doc/library/configparser.rst
View File

@ -92,7 +92,7 @@ write-back, as will be the keys within each section.
well. New applications should prefer this version if they don't need to be well. New applications should prefer this version if they don't need to be
compatible with older versions of Python. compatible with older versions of Python.
.. % XXX Need to explain what's safer/more predictable about it. .. XXX Need to explain what's safer/more predictable about it.
.. versionadded:: 2.3 .. versionadded:: 2.3

11
Doc/library/constants.rst
View File

@ -25,6 +25,9 @@ A small number of constants live in the built-in namespace. They are:
represent the absence of a value, as when default arguments are not passed to a represent the absence of a value, as when default arguments are not passed to a
function. function.
.. versionchanged:: 2.4
Assignments to ``None`` are illegal and raise a :exc:`SyntaxError`.
.. data:: NotImplemented .. data:: NotImplemented
@ -37,5 +40,11 @@ A small number of constants live in the built-in namespace. They are:
Special value used in conjunction with extended slicing syntax. Special value used in conjunction with extended slicing syntax.
.. % XXX Someone who understands extended slicing should fill in here. .. XXX Someone who understands extended slicing should fill in here.
.. data:: __debug__
This constant is true if Python was not started with an :option:`-O` option.
Assignments to :const:`__debug__` are illegal and raise a :exc:`SyntaxError`.
See also the :keyword:`assert` statement.

2
Doc/library/copy.rst
View File

@ -21,8 +21,6 @@ Interface summary::
For module specific errors, :exc:`copy.error` is raised. For module specific errors, :exc:`copy.error` is raised.
.. %
The difference between shallow and deep copying is only relevant for compound The difference between shallow and deep copying is only relevant for compound
objects (objects that contain other objects, like lists or class instances): objects (objects that contain other objects, like lists or class instances):

6
Doc/library/ctypes.rst
View File

@ -71,7 +71,7 @@ the library by creating an instance of CDLL by calling the constructor::
<CDLL 'libc.so.6', handle ... at ...> <CDLL 'libc.so.6', handle ... at ...>
>>> >>>
.. % XXX Add section for Mac OS X. .. XXX Add section for Mac OS X.
.. _ctypes-accessing-functions-from-loaded-dlls: .. _ctypes-accessing-functions-from-loaded-dlls:
@ -1258,10 +1258,6 @@ Enumeration types are not implemented. You can do it easily yourself, using
``long double`` is not implemented. ``long double`` is not implemented.
.. % Local Variables:
.. % compile-command: "make.bat"
.. % End:
.. _ctypes-ctypes-reference: .. _ctypes-ctypes-reference:

3
Doc/library/curses.rst
View File

@ -1170,8 +1170,7 @@ Several constants are available to specify character cell attributes:
Keys are referred to by integer constants with names starting with ``KEY_``. Keys are referred to by integer constants with names starting with ``KEY_``.
The exact keycaps available are system dependent. The exact keycaps available are system dependent.
.. % XXX this table is far too large! .. XXX this table is far too large! should it be alphabetized?
.. % XXX should this table be alphabetized?
+-------------------+--------------------------------------------+ +-------------------+--------------------------------------------+
| Key constant | Key | | Key constant | Key |

6
Doc/library/datetime.rst
View File

@ -1,6 +1,3 @@
.. % XXX what order should the types be discussed in?
:mod:`datetime` --- Basic date and time types :mod:`datetime` --- Basic date and time types
============================================= =============================================
@ -10,6 +7,7 @@
.. sectionauthor:: Tim Peters <tim@zope.com> .. sectionauthor:: Tim Peters <tim@zope.com>
.. sectionauthor:: A.M. Kuchling <amk@amk.ca> .. sectionauthor:: A.M. Kuchling <amk@amk.ca>
.. XXX what order should the types be discussed in?
.. versionadded:: 2.3 .. versionadded:: 2.3
@ -204,7 +202,7 @@ Instance attributes (read-only):
Supported operations: Supported operations:
.. % XXX this table is too wide! .. XXX this table is too wide!
+--------------------------------+-----------------------------------------------+ +--------------------------------+-----------------------------------------------+
| Operation | Result | | Operation | Result |

34
Doc/library/decimal.rst
View File

@ -93,7 +93,7 @@ reset them before monitoring a calculation.
* IEEE standard 854-1987, `Unofficial IEEE 854 Text * IEEE standard 854-1987, `Unofficial IEEE 854 Text
<http://www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html>`_. <http://www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html>`_.
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-tutorial: .. _decimal-tutorial:
@ -268,7 +268,7 @@ a single cast inside a loop. With context set and decimals created, the bulk of
the program manipulates the data no differently than with other Python numeric the program manipulates the data no differently than with other Python numeric
types. types.
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-decimal: .. _decimal-decimal:
@ -279,7 +279,7 @@ Decimal objects
.. class:: Decimal([value [, context]]) .. class:: Decimal([value [, context]])
Constructs a new :class:`Decimal` object based from *value*. Construct a new :class:`Decimal` object based from *value*.
*value* can be an integer, string, tuple, or another :class:`Decimal` object. If *value* can be an integer, string, tuple, or another :class:`Decimal` object. If
no *value* is given, returns ``Decimal("0")``. If *value* is a string, it no *value* is given, returns ``Decimal("0")``. If *value* is a string, it
@ -538,7 +538,7 @@ also have a number of specialized methods:
.. versionadded:: 2.6 .. versionadded:: 2.6
.. method: Decimal.logb([context]) .. method:: Decimal.logb([context])
For a nonzero number, return the adjusted exponent of its operand For a nonzero number, return the adjusted exponent of its operand
as a :class:`Decimal` instance. If the operand is a zero then as a :class:`Decimal` instance. If the operand is a zero then
@ -659,7 +659,7 @@ also have a number of specialized methods:
.. method:: Decimal.quantize(exp[, rounding[, context[, watchexp]]]) .. method:: Decimal.quantize(exp[, rounding[, context[, watchexp]]])
Returns a value equal to the first operand after rounding and Return a value equal to the first operand after rounding and
having the exponent of the second operand. having the exponent of the second operand.
>>> Decimal("1.41421356").quantize(Decimal("1.000")) >>> Decimal("1.41421356").quantize(Decimal("1.000"))
@ -680,8 +680,8 @@ also have a number of specialized methods:
the given ``context`` argument; if neither argument is given the the given ``context`` argument; if neither argument is given the
rounding mode of the current thread's context is used. rounding mode of the current thread's context is used.
If watchexp is set (default), then an error is returned whenever If *watchexp* is set (default), then an error is returned whenever the
the resulting exponent is greater than Emax or less than Etiny. resulting exponent is greater than :attr:`Emax` or less than :attr:`Etiny`.
.. method:: Decimal.radix() .. method:: Decimal.radix()
@ -693,7 +693,7 @@ also have a number of specialized methods:
.. method:: Decimal.remainder_near(other[, context]) .. method:: Decimal.remainder_near(other[, context])
Computes the modulo as either a positive or negative value depending on which is Compute the modulo as either a positive or negative value depending on which is
closest to zero. For instance, ``Decimal(10).remainder_near(6)`` returns closest to zero. For instance, ``Decimal(10).remainder_near(6)`` returns
``Decimal("-2")`` which is closer to zero than ``Decimal("4")``. ``Decimal("-2")`` which is closer to zero than ``Decimal("4")``.
@ -759,7 +759,7 @@ also have a number of specialized methods:
.. method:: Decimal.to_integral_exact([rounding[, context]]) .. method:: Decimal.to_integral_exact([rounding[, context]])
Round the argument to the nearest integer, signaling Round to the nearest integer, signaling
:const:`Inexact` or :const:`Rounded` as appropriate if rounding :const:`Inexact` or :const:`Rounded` as appropriate if rounding
occurs. The rounding mode is determined by the ``rounding`` occurs. The rounding mode is determined by the ``rounding``
parameter if given, else by the given ``context``. If neither parameter if given, else by the given ``context``. If neither
@ -770,7 +770,7 @@ also have a number of specialized methods:
.. method:: Decimal.to_integral_value([rounding[, context]]) .. method:: Decimal.to_integral_value([rounding[, context]])
Rounds to the nearest integer without signaling :const:`Inexact` or Round to the nearest integer without signaling :const:`Inexact` or
:const:`Rounded`. If given, applies *rounding*; otherwise, uses the rounding :const:`Rounded`. If given, applies *rounding*; otherwise, uses the rounding
method in either the supplied *context* or the current context. method in either the supplied *context* or the current context.
@ -780,7 +780,7 @@ also have a number of specialized methods:
.. method:: Decimal.trim() .. method:: Decimal.trim()
Returns its argument with *insignificant* trailing zeros removed. Return the decimal with *insignificant* trailing zeros removed.
Here, a trailing zero is considered insignificant either if it Here, a trailing zero is considered insignificant either if it
follows the decimal point, or if the exponent of the argument (that follows the decimal point, or if the exponent of the argument (that
is, the last element of the :meth:`as_tuple` representation) is is, the last element of the :meth:`as_tuple` representation) is
@ -799,7 +799,7 @@ operands*. A *logical operand* is a :class:`Decimal` instance whose
exponent and sign are both zero, and whose digits are all either exponent and sign are both zero, and whose digits are all either
:const:`0` or :const:`1`. :const:`0` or :const:`1`.
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-context: .. _decimal-context:
@ -1075,7 +1075,7 @@ those for the :class:`Decimal` class and are only briefly recounted here.
Converts a number to a string using scientific notation. Converts a number to a string using scientific notation.
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-signals: .. _decimal-signals:
@ -1196,7 +1196,7 @@ The following table summarizes the hierarchy of signals::
Rounded Rounded
Subnormal Subnormal
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-notes: .. _decimal-notes:
@ -1293,7 +1293,7 @@ the following calculation returns a value equal to zero::
>>> 1 / Decimal('Infinity') >>> 1 / Decimal('Infinity')
Decimal("0E-1000000026") Decimal("0E-1000000026")
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-threads: .. _decimal-threads:
@ -1331,7 +1331,7 @@ threads calling :func:`getcontext`. For example::
t3.start() t3.start()
. . . . . .
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-recipes: .. _decimal-recipes:
@ -1487,7 +1487,7 @@ to work with the :class:`Decimal` class::
return +s return +s
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. _decimal-faq: .. _decimal-faq:

4
Doc/library/difflib.rst
View File

@ -6,9 +6,9 @@
:synopsis: Helpers for computing differences between objects. :synopsis: Helpers for computing differences between objects.
.. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net> .. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. Markup by Fred L. Drake, Jr. <fdrake@acm.org>
.. % LaTeXification by Fred L. Drake, Jr. <fdrake@acm.org>.
.. versionadded:: 2.1 .. versionadded:: 2.1
@ -386,7 +386,7 @@ use :meth:`set_seq2` to set the commonly used sequence once and call
then ``i+n != i'`` or ``j+n != j'``; in other words, adjacent triples always then ``i+n != i'`` or ``j+n != j'``; in other words, adjacent triples always
describe non-adjacent equal blocks. describe non-adjacent equal blocks.
.. % Explain why a dummy is used! .. XXX Explain why a dummy is used!
.. versionchanged:: 2.5 .. versionchanged:: 2.5
The guarantee that adjacent triples always describe non-adjacent blocks was The guarantee that adjacent triples always describe non-adjacent blocks was

24
Doc/library/dis.rst
View File

@ -559,13 +559,6 @@ the more significant byte last.
Unpacks TOS into *count* individual values, which are put onto the stack Unpacks TOS into *count* individual values, which are put onto the stack
right-to-left. right-to-left.
.. % \begin{opcodedesc}{UNPACK_LIST}{count}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. % \begin{opcodedesc}{UNPACK_ARG}{count}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. opcode:: DUP_TOPX (count) .. opcode:: DUP_TOPX (count)
@ -593,10 +586,6 @@ the more significant byte last.
Works as ``DELETE_NAME``, but deletes a global name. Works as ``DELETE_NAME``, but deletes a global name.
.. % \begin{opcodedesc}{UNPACK_VARARG}{argc}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. opcode:: LOAD_CONST (consti) .. opcode:: LOAD_CONST (consti)
@ -679,22 +668,11 @@ the more significant byte last.
the iterator indicates it is exhausted ``TOS`` is popped, and the bytecode the iterator indicates it is exhausted ``TOS`` is popped, and the bytecode
counter is incremented by *delta*. counter is incremented by *delta*.
.. % \begin{opcodedesc}{FOR_LOOP}{delta}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. % \begin{opcodedesc}{LOAD_LOCAL}{namei}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. opcode:: LOAD_GLOBAL (namei) .. opcode:: LOAD_GLOBAL (namei)
Loads the global named ``co_names[namei]`` onto the stack. Loads the global named ``co_names[namei]`` onto the stack.
.. % \begin{opcodedesc}{SET_FUNC_ARGS}{argc}
.. % This opcode is obsolete.
.. % \end{opcodedesc}
.. opcode:: SETUP_LOOP (delta) .. opcode:: SETUP_LOOP (delta)
@ -792,7 +770,7 @@ the more significant byte last.
Pushes a slice object on the stack. *argc* must be 2 or 3. If it is 2, Pushes a slice object on the stack. *argc* must be 2 or 3. If it is 2,
``slice(TOS1, TOS)`` is pushed; if it is 3, ``slice(TOS2, TOS1, TOS)`` is ``slice(TOS1, TOS)`` is pushed; if it is 3, ``slice(TOS2, TOS1, TOS)`` is
pushed. See the ``slice()`` built-in function for more information. pushed. See the :func:`slice` built-in function for more information.
.. opcode:: EXTENDED_ARG (ext) .. opcode:: EXTENDED_ARG (ext)

3
Doc/library/dl.rst
View File

@ -7,9 +7,6 @@
:synopsis: Call C functions in shared objects. :synopsis: Call C functions in shared objects.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. % ?????????? Anyone????????????
The :mod:`dl` module defines an interface to the :cfunc:`dlopen` function, which The :mod:`dl` module defines an interface to the :cfunc:`dlopen` function, which
is the most common interface on Unix platforms for handling dynamically linked is the most common interface on Unix platforms for handling dynamically linked
libraries. It allows the program to call arbitrary functions in such a library. libraries. It allows the program to call arbitrary functions in such a library.

7
Doc/library/doctest.rst
View File

@ -731,12 +731,7 @@ even a single character doesn't match, the test fails. This will probably
surprise you a few times, as you learn exactly what Python does and doesn't surprise you a few times, as you learn exactly what Python does and doesn't
guarantee about output. For example, when printing a dict, Python doesn't guarantee about output. For example, when printing a dict, Python doesn't
guarantee that the key-value pairs will be printed in any particular order, so a guarantee that the key-value pairs will be printed in any particular order, so a
test like test like ::
.. % Hey! What happened to Monty Python examples?
.. % Tim: ask Guido -- it's his example!
::
>>> foo() >>> foo()
{"Hermione": "hippogryph", "Harry": "broomstick"} {"Hermione": "hippogryph", "Harry": "broomstick"}

5
Doc/library/email.rst
View File

@ -1,7 +1,3 @@
.. % Copyright (C) 2001-2007 Python Software Foundation
.. % Author: barry@python.org (Barry Warsaw)
:mod:`email` --- An email and MIME handling package :mod:`email` --- An email and MIME handling package
=================================================== ===================================================
@ -10,6 +6,7 @@
including MIME documents. including MIME documents.
.. moduleauthor:: Barry A. Warsaw <barry@python.org> .. moduleauthor:: Barry A. Warsaw <barry@python.org>
.. sectionauthor:: Barry A. Warsaw <barry@python.org> .. sectionauthor:: Barry A. Warsaw <barry@python.org>
.. Copyright (C) 2001-2007 Python Software Foundation
.. versionadded:: 2.2 .. versionadded:: 2.2

31
Doc/library/exceptions.rst
View File

@ -124,23 +124,18 @@ The following exceptions are the exceptions that are actually raised.
.. exception:: AttributeError .. exception:: AttributeError
Raised when an attribute reference or assignment fails. (When an object does Raised when an attribute reference (see :ref:`attribute-references`) or
not support attribute references or attribute assignments at all, assignment fails. (When an object does not support attribute references or
:exc:`TypeError` is raised.) attribute assignments at all, :exc:`TypeError` is raised.)
.. % xref to attribute reference?
.. exception:: EOFError .. exception:: EOFError
Raised when one of the built-in functions (:func:`input` or :func:`raw_input`) Raised when one of the built-in functions (:func:`input` or :func:`raw_input`)
hits an end-of-file condition (EOF) without reading any data. (N.B.: the hits an end-of-file condition (EOF) without reading any data. (N.B.: the
:meth:`read` and :meth:`readline` methods of file objects return an empty string :meth:`file.read` and :meth:`file.readline` methods return an empty string
when they hit EOF.) when they hit EOF.)
.. % XXXJH xrefs here
.. % XXXJH xrefs here
.. exception:: FloatingPointError .. exception:: FloatingPointError
@ -167,8 +162,6 @@ The following exceptions are the exceptions that are actually raised.
:func:`open` function or a method of a file object) fails for an I/O-related :func:`open` function or a method of a file object) fails for an I/O-related
reason, e.g., "file not found" or "disk full". reason, e.g., "file not found" or "disk full".
.. % XXXJH xrefs here
This class is derived from :exc:`EnvironmentError`. See the discussion above This class is derived from :exc:`EnvironmentError`. See the discussion above
for more information on exception instance attributes. for more information on exception instance attributes.
@ -181,8 +174,6 @@ The following exceptions are the exceptions that are actually raised.
Raised when an :keyword:`import` statement fails to find the module definition Raised when an :keyword:`import` statement fails to find the module definition
or when a ``from ... import`` fails to find a name that is to be imported. or when a ``from ... import`` fails to find a name that is to be imported.
.. % XXXJH xref to import statement?
.. exception:: IndexError .. exception:: IndexError
@ -190,14 +181,14 @@ The following exceptions are the exceptions that are actually raised.
truncated to fall in the allowed range; if an index is not a plain integer, truncated to fall in the allowed range; if an index is not a plain integer,
:exc:`TypeError` is raised.) :exc:`TypeError` is raised.)
.. % XXXJH xref to sequences .. XXX xref to sequences
.. exception:: KeyError .. exception:: KeyError
Raised when a mapping (dictionary) key is not found in the set of existing keys. Raised when a mapping (dictionary) key is not found in the set of existing keys.
.. % XXXJH xref to mapping objects? .. XXX xref to mapping objects?
.. exception:: KeyboardInterrupt .. exception:: KeyboardInterrupt
@ -209,8 +200,6 @@ The following exceptions are the exceptions that are actually raised.
:exc:`BaseException` so as to not be accidentally caught by code that catches :exc:`BaseException` so as to not be accidentally caught by code that catches
:exc:`Exception` and thus prevent the interpreter from exiting. :exc:`Exception` and thus prevent the interpreter from exiting.
.. % XXX(hylton) xrefs here
.. versionchanged:: 2.5 .. versionchanged:: 2.5
Changed to inherit from :exc:`BaseException`. Changed to inherit from :exc:`BaseException`.
@ -248,8 +237,6 @@ The following exceptions are the exceptions that are actually raised.
:mod:`os` module's ``os.error`` exception. See :exc:`EnvironmentError` above for :mod:`os` module's ``os.error`` exception. See :exc:`EnvironmentError` above for
a description of the possible associated values. a description of the possible associated values.
.. % xref for os module
.. versionadded:: 1.5.2 .. versionadded:: 1.5.2
@ -263,8 +250,6 @@ The following exceptions are the exceptions that are actually raised.
checked except left shift, where typical applications prefer to drop bits than checked except left shift, where typical applications prefer to drop bits than
raise an exception. raise an exception.
.. % XXXJH reference to long's and/or int's?
.. exception:: ReferenceError .. exception:: ReferenceError
@ -302,8 +287,6 @@ The following exceptions are the exceptions that are actually raised.
built-in function :func:`eval` or :func:`input`, or when reading the initial built-in function :func:`eval` or :func:`input`, or when reading the initial
script or standard input (also interactively). script or standard input (also interactively).
.. % XXXJH xref to these functions?
Instances of this class have attributes :attr:`filename`, :attr:`lineno`, Instances of this class have attributes :attr:`filename`, :attr:`lineno`,
:attr:`offset` and :attr:`text` for easier access to the details. :func:`str` :attr:`offset` and :attr:`text` for easier access to the details. :func:`str`
of the exception instance returns only the message. of the exception instance returns only the message.
@ -331,8 +314,6 @@ The following exceptions are the exceptions that are actually raised.
it has another type (such as a string), the object's value is printed and the it has another type (such as a string), the object's value is printed and the
exit status is one. exit status is one.
.. % XXX(hylton) xref to module sys?
Instances have an attribute :attr:`code` which is set to the proposed exit Instances have an attribute :attr:`code` which is set to the proposed exit
status or error message (defaulting to ``None``). Also, this exception derives status or error message (defaulting to ``None``). Also, this exception derives
directly from :exc:`BaseException` and not :exc:`StandardError`, since it is not directly from :exc:`BaseException` and not :exc:`StandardError`, since it is not

28
Doc/library/fl.rst
View File

@ -141,7 +141,7 @@ documentation:
call :func:`fl.qread` to read the event from the queue. Don't use the call :func:`fl.qread` to read the event from the queue. Don't use the
equivalent GL functions! equivalent GL functions!
.. % \funcline{blkqread}{?} .. \funcline{blkqread}{?}
.. function:: color() .. function:: color()
@ -227,8 +227,6 @@ here.
Find the last object in the form. Find the last object in the form.
.. % ---
.. method:: form.add_box(type, x, y, w, h, name) .. method:: form.add_box(type, x, y, w, h, name)
@ -239,17 +237,15 @@ here.
Add a text object to the form. No extra methods. Add a text object to the form. No extra methods.
.. % \begin{methoddesc}[form]{add_bitmap}{type, x, y, w, h, name} .. \begin{methoddesc}[form]{add_bitmap}{type, x, y, w, h, name}
.. % Add a bitmap object to the form. .. Add a bitmap object to the form.
.. % \end{methoddesc} .. \end{methoddesc}
.. method:: form.add_clock(type, x, y, w, h, name) .. method:: form.add_clock(type, x, y, w, h, name)
Add a clock object to the form. --- Method: :meth:`get_clock`. Add a clock object to the form. --- Method: :meth:`get_clock`.
.. % ---
.. method:: form.add_button(type, x, y, w, h, name) .. method:: form.add_button(type, x, y, w, h, name)
@ -268,8 +264,6 @@ here.
Add a roundbutton object to the form. --- Methods: :meth:`get_button`, Add a roundbutton object to the form. --- Methods: :meth:`get_button`,
:meth:`set_button`. :meth:`set_button`.
.. % ---
.. method:: form.add_slider(type, x, y, w, h, name) .. method:: form.add_slider(type, x, y, w, h, name)
@ -308,16 +302,12 @@ here.
:meth:`get_counter_value`, :meth:`set_counter_bounds`, :meth:`set_counter_step`, :meth:`get_counter_value`, :meth:`set_counter_bounds`, :meth:`set_counter_step`,
:meth:`set_counter_precision`, :meth:`set_counter_return`. :meth:`set_counter_precision`, :meth:`set_counter_return`.
.. % ---
.. method:: form.add_input(type, x, y, w, h, name) .. method:: form.add_input(type, x, y, w, h, name)
Add a input object to the form. --- Methods: :meth:`set_input`, Add a input object to the form. --- Methods: :meth:`set_input`,
:meth:`get_input`, :meth:`set_input_color`, :meth:`set_input_return`. :meth:`get_input`, :meth:`set_input_color`, :meth:`set_input_return`.
.. % ---
.. method:: form.add_menu(type, x, y, w, h, name) .. method:: form.add_menu(type, x, y, w, h, name)
@ -345,8 +335,6 @@ here.
:meth:`set_browser_fontsize`, :meth:`set_browser_fontstyle`, :meth:`set_browser_fontsize`, :meth:`set_browser_fontstyle`,
:meth:`set_browser_specialkey`. :meth:`set_browser_specialkey`.
.. % ---
.. method:: form.add_timer(type, x, y, w, h, name) .. method:: form.add_timer(type, x, y, w, h, name)
@ -428,10 +416,10 @@ also have the following methods:
FORMS objects have these data attributes; see the FORMS documentation: FORMS objects have these data attributes; see the FORMS documentation:
.. % \begin{methoddesc}[FORMS object]{handle_object}{} XXX .. \begin{methoddesc}[FORMS object]{handle_object}{} XXX
.. % \end{methoddesc} .. \end{methoddesc}
.. % \begin{methoddesc}[FORMS object]{handle_object_direct}{} XXX .. \begin{methoddesc}[FORMS object]{handle_object_direct}{} XXX
.. % \end{methoddesc} .. \end{methoddesc}
+--------------------+-----------------+------------------+ +--------------------+-----------------+------------------+
| Name | C Type | Meaning | | Name | C Type | Meaning |

6
Doc/library/functions.rst
View File

@ -30,7 +30,7 @@ available. They are listed here in alphabetical order.
:func:`__import__` function. :func:`__import__` function.
For example, the statement ``import spam`` results in the following call: For example, the statement ``import spam`` results in the following call:
``__import__('spam',`` ``globals(),`` ``locals(), [], -1)``; the statement ``__import__('spam', globals(), locals(), [], -1)``; the statement
``from spam.ham import eggs`` results in ``__import__('spam.ham', globals(), ``from spam.ham import eggs`` results in ``__import__('spam.ham', globals(),
locals(), ['eggs'], -1)``. Note that even though ``locals()`` and ``['eggs']`` locals(), ['eggs'], -1)``. Note that even though ``locals()`` and ``['eggs']``
are passed in as arguments, the :func:`__import__` function does not set the are passed in as arguments, the :func:`__import__` function does not set the
@ -356,7 +356,7 @@ available. They are listed here in alphabetical order.
access to the standard :mod:`__builtin__` module and restricted environments are access to the standard :mod:`__builtin__` module and restricted environments are
propagated. If the *locals* dictionary is omitted it defaults to the *globals* propagated. If the *locals* dictionary is omitted it defaults to the *globals*
dictionary. If both dictionaries are omitted, the expression is executed in the dictionary. If both dictionaries are omitted, the expression is executed in the
environment where :keyword:`eval` is called. The return value is the result of environment where :func:`eval` is called. The return value is the result of
the evaluated expression. Syntax errors are reported as exceptions. Example:: the evaluated expression. Syntax errors are reported as exceptions. Example::
>>> x = 1 >>> x = 1
@ -635,7 +635,7 @@ available. They are listed here in alphabetical order.
The contents of this dictionary should not be modified; changes may not affect The contents of this dictionary should not be modified; changes may not affect
the values of local variables used by the interpreter. the values of local variables used by the interpreter.
Free variables are returned by *locals* when it is called in a function block. Free variables are returned by :func:`locals` when it is called in a function block.
Modifications of free variables may not affect the values used by the Modifications of free variables may not affect the values used by the
interpreter. Free variables are not returned in class blocks. interpreter. Free variables are not returned in class blocks.

4
Doc/library/gensuitemodule.rst
View File

@ -6,9 +6,7 @@
:platform: Mac :platform: Mac
:synopsis: Create a stub package from an OSA dictionary :synopsis: Create a stub package from an OSA dictionary
.. sectionauthor:: Jack Jansen <Jack.Jansen@cwi.nl> .. sectionauthor:: Jack Jansen <Jack.Jansen@cwi.nl>
.. moduleauthor:: Jack Jansen
.. % \moduleauthor{Jack Jansen?}{email}
The :mod:`gensuitemodule` module creates a Python package implementing stub code The :mod:`gensuitemodule` module creates a Python package implementing stub code
for the AppleScript suites that are implemented by a specific application, for the AppleScript suites that are implemented by a specific application,

4
Doc/library/getopt.rst
View File

@ -9,13 +9,11 @@
This module helps scripts to parse the command line arguments in ``sys.argv``. This module helps scripts to parse the command line arguments in ``sys.argv``.
It supports the same conventions as the Unix :cfunc:`getopt` function (including It supports the same conventions as the Unix :cfunc:`getopt` function (including
the special meanings of arguments of the form '``-``' and '``-``\ ``-``'). Long the special meanings of arguments of the form '``-``' and '``--``'). Long
options similar to those supported by GNU software may be used as well via an options similar to those supported by GNU software may be used as well via an
optional third argument. This module provides a single function and an optional third argument. This module provides a single function and an
exception: exception:
.. % That's to fool latex2html into leaving the two hyphens alone!
.. function:: getopt(args, options[, long_options]) .. function:: getopt(args, options[, long_options])

5
Doc/library/getpass.rst
View File

@ -1,4 +1,3 @@
:mod:`getpass` --- Portable password input :mod:`getpass` --- Portable password input
========================================== ==========================================
@ -6,9 +5,7 @@
:synopsis: Portable reading of passwords and retrieval of the userid. :synopsis: Portable reading of passwords and retrieval of the userid.
.. moduleauthor:: Piers Lauder <piers@cs.su.oz.au> .. moduleauthor:: Piers Lauder <piers@cs.su.oz.au>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. Windows (& Mac?) support by Guido van Rossum.
.. % Windows (& Mac?) support by Guido van Rossum.
The :mod:`getpass` module provides two functions: The :mod:`getpass` module provides two functions:

4
Doc/library/gl.rst
View File

@ -65,7 +65,7 @@ The following functions are non-standard or have special argument conventions:
converted to 3D double precision points by assuming ``z = 0.0`` if necessary (as converted to 3D double precision points by assuming ``z = 0.0`` if necessary (as
indicated in the man page), and for each point ``v3d()`` is called. indicated in the man page), and for each point ``v3d()`` is called.
.. % JHXXX the argument-argument added .. XXX the argument-argument added
.. function:: nvarray() .. function:: nvarray()
@ -89,7 +89,7 @@ The following functions are non-standard or have special argument conventions:
Defines a nurbs surface. The dimensions of ``ctl[][]`` are computed as follows: Defines a nurbs surface. The dimensions of ``ctl[][]`` are computed as follows:
``[len(s_k) - s_ord]``, ``[len(t_k) - t_ord]``. ``[len(s_k) - s_ord]``, ``[len(t_k) - t_ord]``.
.. % XXX s_k[], t_k[], ctl[][] .. XXX s_k[], t_k[], ctl[][]
.. function:: nurbscurve(knots, ctlpoints, order, type) .. function:: nurbscurve(knots, ctlpoints, order, type)

4
Doc/library/heapq.rst
View File

@ -1,4 +1,3 @@
:mod:`heapq` --- Heap queue algorithm :mod:`heapq` --- Heap queue algorithm
===================================== =====================================
@ -8,9 +7,6 @@
.. sectionauthor:: Guido van Rossum <guido@python.org> .. sectionauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: François Pinard .. sectionauthor:: François Pinard
.. % Theoretical explanation:
.. versionadded:: 2.3 .. versionadded:: 2.3
This module provides an implementation of the heap queue algorithm, also known This module provides an implementation of the heap queue algorithm, also known

10
Doc/library/idle.rst
View File

@ -1,20 +1,16 @@
.. _idle: .. _idle:
Idle IDLE
==== ====
.. moduleauthor:: Guido van Rossum <guido@Python.org> .. moduleauthor:: Guido van Rossum <guido@Python.org>
.. % \declaremodule{standard}{idle}
.. % \modulesynopsis{A Python Integrated Development Environment}
.. index:: .. index::
single: Idle single: IDLE
single: Python Editor single: Python Editor
single: Integrated Development Environment single: Integrated Development Environment
Idle is the Python IDE built with the :mod:`Tkinter` GUI toolkit. IDLE is the Python IDE built with the :mod:`Tkinter` GUI toolkit.
IDLE has the following features: IDLE has the following features:

13
Doc/library/imaplib.rst
View File

@ -1,4 +1,3 @@
:mod:`imaplib` --- IMAP4 protocol client :mod:`imaplib` --- IMAP4 protocol client
======================================== ========================================
@ -6,6 +5,10 @@
:synopsis: IMAP4 protocol client (requires sockets). :synopsis: IMAP4 protocol client (requires sockets).
.. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au> .. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au> .. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. revised by ESR, January 2000
.. changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002
.. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
November 2002
.. index:: .. index::
@ -13,14 +16,6 @@
pair: IMAP4_SSL; protocol pair: IMAP4_SSL; protocol
pair: IMAP4_stream; protocol pair: IMAP4_stream; protocol
.. % Based on HTML documentation by Piers Lauder
.. % <piers@communitysolutions.com.au>;
.. % converted by Fred L. Drake, Jr. <fdrake@acm.org>.
.. % Revised by ESR, January 2000.
.. % Changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002
.. % Changes for IMAP4_stream by Piers Lauder
.. % <piers@communitysolutions.com.au>, November 2002
This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and
:class:`IMAP4_stream`, which encapsulate a connection to an IMAP4 server and :class:`IMAP4_stream`, which encapsulate a connection to an IMAP4 server and
implement a large subset of the IMAP4rev1 client protocol as defined in implement a large subset of the IMAP4rev1 client protocol as defined in

7
Doc/library/jpeg.rst
View File

@ -78,16 +78,11 @@ The :mod:`jpeg` module defines an exception and some functions.
| | decompression. | | | decompression. |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
.. %
.. %
.. %
.. %
.. seealso:: .. seealso::
JPEG Still Image Data Compression Standard JPEG Still Image Data Compression Standard
The canonical reference for the JPEG image format, by Pennebaker and Mitchell. The canonical reference for the JPEG image format, by Pennebaker and Mitchell.
`Information Technology - Digital Compression and Coding of Continuous-tone Still Images - Requirements and Guidelines <http://www.w3.org/Graphics/JPEG/itu-t81.pdf>`_ `Information Technology - Digital Compression and Coding of Continuous-tone Still Images - Requirements and Guidelines <http://www.w3.org/Graphics/JPEG/itu-t81.pdf>`_
The ISO standard for JPEG is also published as ITU T.81. This is available The ISO standard for JPEG is also published as ITU T.81. This is available

15
Doc/library/logging.rst
View File

@ -2049,8 +2049,6 @@ Configuration
Configuration functions Configuration functions
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
.. %
The following functions configure the logging module. They are located in the The following functions configure the logging module. They are located in the
:mod:`logging.config` module. Their use is optional --- you can configure the :mod:`logging.config` module. Their use is optional --- you can configure the
logging module using these functions or by making calls to the main API (defined logging module using these functions or by making calls to the main API (defined
@ -2234,13 +2232,12 @@ Sections which specify formatter configuration are typified by the following. ::
class=logging.Formatter class=logging.Formatter
The ``format`` entry is the overall format string, and the ``datefmt`` entry is The ``format`` entry is the overall format string, and the ``datefmt`` entry is
the :func:`strftime`\ -compatible date/time format string. If empty, the package the :func:`strftime`\ -compatible date/time format string. If empty, the
substitutes ISO8601 format date/times, which is almost equivalent to specifying package substitutes ISO8601 format date/times, which is almost equivalent to
the date format string "The ISO8601 format also specifies milliseconds, which specifying the date format string ``"%Y-%m-%d %H:%M:%S"``. The ISO8601 format
are appended to the result of using the above format string, with a comma also specifies milliseconds, which are appended to the result of using the above
separator. An example time in ISO8601 format is ``2003-01-23 00:29:50,411``. format string, with a comma separator. An example time in ISO8601 format is
``2003-01-23 00:29:50,411``.
.. % Y-%m-%d %H:%M:%S".
The ``class`` entry is optional. It indicates the name of the formatter's class The ``class`` entry is optional. It indicates the name of the formatter's class
(as a dotted module and class name.) This option is useful for instantiating a (as a dotted module and class name.) This option is useful for instantiating a

6
Doc/library/mhlib.rst
View File

@ -1,13 +1,9 @@
:mod:`mhlib` --- Access to MH mailboxes :mod:`mhlib` --- Access to MH mailboxes
======================================= =======================================
.. module:: mhlib .. module:: mhlib
:synopsis: Manipulate MH mailboxes from Python. :synopsis: Manipulate MH mailboxes from Python.
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
.. % LaTeX'ized from the comments in the module by Skip Montanaro
.. % <skip@pobox.com>.
The :mod:`mhlib` module provides a Python interface to MH folders and their The :mod:`mhlib` module provides a Python interface to MH folders and their
contents. contents.

2
Doc/library/netrc.rst
View File

@ -8,8 +8,6 @@
.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>
.. % Note the \protect needed for \file... ;-(
.. versionadded:: 1.5.2 .. versionadded:: 1.5.2
The :class:`netrc` class parses and encapsulates the netrc file format used by The :class:`netrc` class parses and encapsulates the netrc file format used by

2
Doc/library/new.rst
View File

@ -45,7 +45,7 @@ The :mod:`new` module defines the following functions:
This function is an interface to the :cfunc:`PyCode_New` C function. This function is an interface to the :cfunc:`PyCode_New` C function.
.. % XXX This is still undocumented!!!!!!!!!!! .. XXX This is still undocumented!
.. function:: module(name[, doc]) .. function:: module(name[, doc])

2
Doc/library/nntplib.rst
View File

@ -316,8 +316,6 @@ indicates an error, the method raises one of the above exceptions.
is supplied, then the returned *list* is an empty list. This is an optional NNTP is supplied, then the returned *list* is an empty list. This is an optional NNTP
extension, and may not be supported by all servers. extension, and may not be supported by all servers.
.. % XXX huh? Should that be name, description?
RFC2980 says "It is suggested that this extension be deprecated". Use RFC2980 says "It is suggested that this extension be deprecated". Use
:meth:`descriptions` or :meth:`description` instead. :meth:`descriptions` or :meth:`description` instead.

20
Doc/library/optparse.rst
View File

@ -1,7 +1,3 @@
.. % THIS FILE IS AUTO-GENERATED! DO NOT EDIT!
.. % (Your changes will be lost the next time it is generated.)
:mod:`optparse` --- More powerful command line option parser :mod:`optparse` --- More powerful command line option parser
============================================================ ============================================================
@ -22,9 +18,6 @@ populate it with options, and parse the command line. ``optparse`` allows users
to specify options in the conventional GNU/POSIX syntax, and additionally to specify options in the conventional GNU/POSIX syntax, and additionally
generates usage and help messages for you. generates usage and help messages for you.
.. % An intro blurb used only when generating LaTeX docs for the Python
.. % manual (based on README.txt).
Here's an example of using ``optparse`` in a simple script:: Here's an example of using ``optparse`` in a simple script::
from optparse import OptionParser from optparse import OptionParser
@ -74,8 +67,6 @@ and ``optparse`` will print out a brief summary of your script's options::
where the value of *yourscript* is determined at runtime (normally from where the value of *yourscript* is determined at runtime (normally from
``sys.argv[0]``). ``sys.argv[0]``).
.. % $Id: intro.txt 413 2004-09-28 00:59:13Z greg $
.. _optparse-background: .. _optparse-background:
@ -237,8 +228,6 @@ you implement, the more flexible your program is, and the more complicated its
implementation becomes. Too much flexibility has drawbacks as well, of course; implementation becomes. Too much flexibility has drawbacks as well, of course;
too many options can overwhelm users and make your code much harder to maintain. too many options can overwhelm users and make your code much harder to maintain.
.. % $Id: tao.txt 413 2004-09-28 00:59:13Z greg $
.. _optparse-tutorial: .. _optparse-tutorial:
@ -656,8 +645,6 @@ Here's what :mod:`optparse`\ -based scripts usually look like::
if __name__ == "__main__": if __name__ == "__main__":
main() main()
.. % $Id: tutorial.txt 515 2006-06-10 15:37:45Z gward $
.. _optparse-reference-guide: .. _optparse-reference-guide:
@ -1333,8 +1320,6 @@ OptionParser supports several other public methods:
parser.add_option("--novice", action="store_const", parser.add_option("--novice", action="store_const",
dest="mode", const="novice") dest="mode", const="novice")
.. % $Id: reference.txt 519 2006-06-11 14:39:11Z gward $
.. _optparse-option-callbacks: .. _optparse-option-callbacks:
@ -1630,8 +1615,6 @@ in the arguments following ``"-c"`` will be interpreted as further options
(probably causing an error), rather than as arguments to ``"-c"``. Fixing this (probably causing an error), rather than as arguments to ``"-c"``. Fixing this
is left as an exercise for the reader. is left as an exercise for the reader.
.. % $Id: callbacks.txt 415 2004-09-30 02:26:17Z greg $
.. _optparse-extending-optparse: .. _optparse-extending-optparse:
@ -1822,6 +1805,3 @@ Features of note:
about setting a default value for the option destinations in question; they can about setting a default value for the option destinations in question; they can
just leave the default as None and :meth:`ensure_value` will take care of just leave the default as None and :meth:`ensure_value` will take care of
getting it right when it's needed. getting it right when it's needed.
.. % $Id: extending.txt 517 2006-06-10 16:18:11Z gward $

10
Doc/library/os.rst
View File

@ -35,13 +35,6 @@ The :mod:`os` module contains many functions and data values. The items below
and in the following sub-sections are all available directly from the :mod:`os` and in the following sub-sections are all available directly from the :mod:`os`
module. module.
.. % Frank Stajano <fstajano@uk.research.att.com> complained that it
.. % wasn't clear that the entries described in the subsections were all
.. % available at the module level (most uses of subsections are
.. % different); I think this is only a problem for the HTML version,
.. % where the relationship may not be as clear.
.. %
.. exception:: error .. exception:: error
@ -309,9 +302,8 @@ process and user.
Set the current process' user id. Availability: Unix. Set the current process' user id. Availability: Unix.
.. % placed in this section since it relates to errno.... a little weak
.. placed in this section since it relates to errno.... a little weak
.. function:: strerror(code) .. function:: strerror(code)
Return the error message corresponding to the error code in *code*. Return the error message corresponding to the error code in *code*.

60
Doc/library/ossaudiodev.rst
View File

@ -13,33 +13,33 @@ This module allows you to access the OSS (Open Sound System) audio interface.
OSS is available for a wide range of open-source and commercial Unices, and is OSS is available for a wide range of open-source and commercial Unices, and is
the standard audio interface for Linux and recent versions of FreeBSD. the standard audio interface for Linux and recent versions of FreeBSD.
.. % Things will get more complicated for future Linux versions, since .. Things will get more complicated for future Linux versions, since
.. % ALSA is in the standard kernel as of 2.5.x. Presumably if you ALSA is in the standard kernel as of 2.5.x. Presumably if you
.. % use ALSA, you'll have to make sure its OSS compatibility layer use ALSA, you'll have to make sure its OSS compatibility layer
.. % is active to use ossaudiodev, but you're gonna need it for the vast is active to use ossaudiodev, but you're gonna need it for the vast
.. % majority of Linux audio apps anyways. majority of Linux audio apps anyways.
.. %
.. % Sounds like things are also complicated for other BSDs. In response Sounds like things are also complicated for other BSDs. In response
.. % to my python-dev query, Thomas Wouters said: to my python-dev query, Thomas Wouters said:
.. %
.. % > Likewise, googling shows OpenBSD also uses OSS/Free -- the commercial > Likewise, googling shows OpenBSD also uses OSS/Free -- the commercial
.. % > OSS installation manual tells you to remove references to OSS/Free from the > OSS installation manual tells you to remove references to OSS/Free from the
.. % > kernel :) > kernel :)
.. %
.. % but Aleksander Piotrowsk actually has an OpenBSD box, and he quotes but Aleksander Piotrowsk actually has an OpenBSD box, and he quotes
.. % from its <soundcard.h>: from its <soundcard.h>:
.. % > * WARNING! WARNING! > * WARNING! WARNING!
.. % > * This is an OSS (Linux) audio emulator. > * This is an OSS (Linux) audio emulator.
.. % > * Use the Native NetBSD API for developing new code, and this > * Use the Native NetBSD API for developing new code, and this
.. % > * only for compiling Linux programs. > * only for compiling Linux programs.
.. %
.. % There's also an ossaudio manpage on OpenBSD that explains things There's also an ossaudio manpage on OpenBSD that explains things
.. % further. Presumably NetBSD and OpenBSD have a different standard further. Presumably NetBSD and OpenBSD have a different standard
.. % audio interface. That's the great thing about standards, there are so audio interface. That's the great thing about standards, there are so
.. % many to choose from ... ;-) many to choose from ... ;-)
.. %
.. % This probably all warrants a footnote or two, but I don't understand This probably all warrants a footnote or two, but I don't understand
.. % things well enough right now to write it! --GPW things well enough right now to write it! --GPW
.. seealso:: .. seealso::
@ -89,9 +89,9 @@ the standard audio interface for Linux and recent versions of FreeBSD.
second is required. This is a historical artifact for compatibility with the second is required. This is a historical artifact for compatibility with the
older :mod:`linuxaudiodev` module which :mod:`ossaudiodev` supersedes. older :mod:`linuxaudiodev` module which :mod:`ossaudiodev` supersedes.
.. % XXX it might also be motivated .. XXX it might also be motivated
.. % by my unfounded-but-still-possibly-true belief that the default by my unfounded-but-still-possibly-true belief that the default
.. % audio device varies unpredictably across operating systems. -GW audio device varies unpredictably across operating systems. -GW
.. function:: openmixer([device]) .. function:: openmixer([device])

3
Doc/library/othergui.rst
View File

@ -5,7 +5,6 @@ Other Graphical User Interface Packages
There are an number of extension widget sets to :mod:`Tkinter`. There are an number of extension widget sets to :mod:`Tkinter`.
.. seealso:: .. seealso::
`Python megawidgets <http://pmw.sourceforge.net/>`_ `Python megawidgets <http://pmw.sourceforge.net/>`_
@ -29,12 +28,10 @@ There are an number of extension widget sets to :mod:`Tkinter`.
since they can operate directly on Python data structures, without having to since they can operate directly on Python data structures, without having to
transfer data through the Tk/Tcl layer. transfer data through the Tk/Tcl layer.
.. %
The major cross-platform (Windows, Mac OS X, Unix-like) GUI toolkits that are The major cross-platform (Windows, Mac OS X, Unix-like) GUI toolkits that are
also available for Python: also available for Python:
.. seealso:: .. seealso::
`PyGTK <http://www.pygtk.org/>`_ `PyGTK <http://www.pygtk.org/>`_

13
Doc/library/parser.rst
View File

@ -8,13 +8,12 @@
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. % Copyright 1995 Virginia Polytechnic Institute and State University .. Copyright 1995 Virginia Polytechnic Institute and State University and Fred
.. % and Fred L. Drake, Jr. This copyright notice must be distributed on L. Drake, Jr. This copyright notice must be distributed on all copies, but
.. % all copies, but this document otherwise may be distributed as part this document otherwise may be distributed as part of the Python
.. % of the Python distribution. No fee may be charged for this document distribution. No fee may be charged for this document in any representation,
.. % in any representation, either on paper or electronically. This either on paper or electronically. This restriction does not affect other
.. % restriction does not affect other elements in a distributed package elements in a distributed package in any way.
.. % in any way.
.. index:: single: parsing; Python source code .. index:: single: parsing; Python source code

15
Doc/library/pickle.rst
View File

@ -1,4 +1,3 @@
:mod:`pickle` --- Python object serialization :mod:`pickle` --- Python object serialization
============================================= =============================================
@ -12,10 +11,8 @@
.. module:: pickle .. module:: pickle
:synopsis: Convert Python objects to streams of bytes and back. :synopsis: Convert Python objects to streams of bytes and back.
.. sectionauthor:: Jim Kerr <jbkerr@sr.hp.com>.
.. sectionauthor:: Barry Warsaw <barry@zope.com>
.. % Substantial improvements by Jim Kerr <jbkerr@sr.hp.com>.
.. % Rewritten by Barry Warsaw <barry@zope.com>
The :mod:`pickle` module implements a fundamental, but powerful algorithm for The :mod:`pickle` module implements a fundamental, but powerful algorithm for
serializing and de-serializing a Python object structure. "Pickling" is the serializing and de-serializing a Python object structure. "Pickling" is the
@ -622,10 +619,10 @@ object references without actually instantiating all the objects in a pickle.
[#]_ Setting :attr:`persistent_load` to a list is usually used in conjunction [#]_ Setting :attr:`persistent_load` to a list is usually used in conjunction
with the :meth:`noload` method on the Unpickler. with the :meth:`noload` method on the Unpickler.
.. % BAW: Both pickle and cPickle support something called .. BAW: Both pickle and cPickle support something called inst_persistent_id()
.. % inst_persistent_id() which appears to give unknown types a second which appears to give unknown types a second shot at producing a persistent
.. % shot at producing a persistent id. Since Jim Fulton can't remember id. Since Jim Fulton can't remember why it was added or what it's for, I'm
.. % why it was added or what it's for, I'm leaving it undocumented. leaving it undocumented.
.. _pickle-sub: .. _pickle-sub:

6
Doc/library/platform.rst
View File

@ -202,16 +202,12 @@ Windows Platform
Win95/98 specific Win95/98 specific
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
.. function:: popen(cmd, mode='r', bufsize=None) .. function:: popen(cmd, mode='r', bufsize=None)
Portable :func:`popen` interface. Find a working popen implementation Portable :func:`popen` interface. Find a working popen implementation
preferring :func:`win32pipe.popen`. On Windows NT, :func:`win32pipe.popen` preferring :func:`win32pipe.popen`. On Windows NT, :func:`win32pipe.popen`
should work; on Windows 9x it hangs due to bugs in the MS C library. should work; on Windows 9x it hangs due to bugs in the MS C library.
.. % This KnowledgeBase article appears to be missing...
.. % See also \ulink{MS KnowledgeBase article Q150956}{}.
Mac OS Platform Mac OS Platform
--------------- ---------------
@ -239,7 +235,7 @@ Unix Platforms
Tries to determine the name of the OS distribution name Returns a tuple Tries to determine the name of the OS distribution name Returns a tuple
``(distname, version, id)`` which defaults to the args given as parameters. ``(distname, version, id)`` which defaults to the args given as parameters.
.. % Document linux_distribution()? .. XXX Document linux_distribution()?
.. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=2048) .. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=2048)

6
Doc/library/popen2.rst
View File

@ -150,9 +150,9 @@ writes. The essential factors are that more than :const:`_PC_PIPE_BUF` bytes
are being written by one process in a blocking fashion, while the other process are being written by one process in a blocking fashion, while the other process
is reading from the other process, also in a blocking fashion. is reading from the other process, also in a blocking fashion.
.. % Example explanation and suggested work-arounds substantially stolen .. Example explanation and suggested work-arounds substantially stolen
.. % from Martin von Löwis: from Martin von Löwis:
.. % http://mail.python.org/pipermail/python-dev/2000-September/009460.html http://mail.python.org/pipermail/python-dev/2000-September/009460.html
There are several ways to deal with this situation. There are several ways to deal with this situation.

9
Doc/library/poplib.rst
View File

@ -4,16 +4,11 @@
.. module:: poplib .. module:: poplib
:synopsis: POP3 protocol client (requires sockets). :synopsis: POP3 protocol client (requires sockets).
.. sectionauthor:: Andrew T. Csillag
.. revised by ESR, January 2000
.. index:: pair: POP3; protocol .. index:: pair: POP3; protocol
.. % By Andrew T. Csillag
.. % Even though I put it into LaTeX, I cannot really claim that I wrote
.. % it since I just stole most of it from the poplib.py source code and
.. % the imaplib ``chapter''.
.. % Revised by ESR, January 2000
This module defines a class, :class:`POP3`, which encapsulates a connection to a This module defines a class, :class:`POP3`, which encapsulates a connection to a
POP3 server and implements the protocol as defined in :rfc:`1725`. The POP3 server and implements the protocol as defined in :rfc:`1725`. The
:class:`POP3` class supports both the minimal and optional command sets. :class:`POP3` class supports both the minimal and optional command sets.

8
Doc/library/posix.rst
View File

@ -60,17 +60,11 @@ of Irix, but with Solaris 2.6 and 2.7 you need to do something like::
CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \ CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
./configure ./configure
On large-file-capable Linux systems, this might work: On large-file-capable Linux systems, this might work::
.. % $ <-- bow to font-lock
::
CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \ CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
./configure ./configure
.. % $ <-- bow to font-lock
.. _posix-contents: .. _posix-contents:

7
Doc/library/posixfile.rst
View File

@ -1,6 +1,3 @@
.. % Manual text and implementation by Jaap Vermeulen
:mod:`posixfile` --- File-like objects with locking support :mod:`posixfile` --- File-like objects with locking support
=========================================================== ===========================================================
@ -15,8 +12,6 @@
.. index:: pair: POSIX; file object .. index:: pair: POSIX; file object
.. deprecated:: 1.5 .. deprecated:: 1.5
.. index:: single: lockf() (in module fcntl)
The locking operation that this module provides is done better and more portably The locking operation that this module provides is done better and more portably
by the :func:`fcntl.lockf` call. by the :func:`fcntl.lockf` call.
@ -29,8 +24,6 @@ new file object, the posixfile object. It has all the standard file object
methods and adds the methods described below. This module only works for methods and adds the methods described below. This module only works for
certain flavors of Unix, since it uses :func:`fcntl.fcntl` for file locking. certain flavors of Unix, since it uses :func:`fcntl.fcntl` for file locking.
.. %
To instantiate a posixfile object, use the :func:`open` function in the To instantiate a posixfile object, use the :func:`open` function in the
:mod:`posixfile` module. The resulting object looks and feels roughly the same :mod:`posixfile` module. The resulting object looks and feels roughly the same
as a standard file object. as a standard file object.

8
Doc/library/pprint.rst
View File

@ -27,7 +27,7 @@ width constraint.
The :mod:`pprint` module defines one class: The :mod:`pprint` module defines one class:
.. % First the implementation class: .. First the implementation class:
.. class:: PrettyPrinter(...) .. class:: PrettyPrinter(...)
@ -68,8 +68,7 @@ The :mod:`pprint` module defines one class:
The :class:`PrettyPrinter` class supports several derivative functions: The :class:`PrettyPrinter` class supports several derivative functions:
.. % Now the derivative functions: .. Now the derivative functions:
.. function:: pformat(object[, indent[, width[, depth]]]) .. function:: pformat(object[, indent[, width[, depth]]])
@ -131,9 +130,6 @@ One more support function is also defined:
recursive reference will be represented as ``<Recursion on typename with recursive reference will be represented as ``<Recursion on typename with
id=number>``. The representation is not otherwise formatted. id=number>``. The representation is not otherwise formatted.
.. % This example is outside the {funcdesc} to keep it from running over
.. % the right margin.
:: ::
>>> pprint.saferepr(stuff) >>> pprint.saferepr(stuff)

91
Doc/library/profile.rst
View File

@ -85,47 +85,47 @@ is not so far as well-tested and might not be available on all systems.
:mod:`_lsprof` module. The :mod:`hotshot` module is reserved to specialized :mod:`_lsprof` module. The :mod:`hotshot` module is reserved to specialized
usages. usages.
.. % \section{How Is This Profiler Different From The Old Profiler?} .. \section{How Is This Profiler Different From The Old Profiler?}
.. % \nodename{Profiler Changes} \nodename{Profiler Changes}
.. %
.. % (This section is of historical importance only; the old profiler (This section is of historical importance only; the old profiler
.. % discussed here was last seen in Python 1.1.) discussed here was last seen in Python 1.1.)
.. %
.. % The big changes from old profiling module are that you get more The big changes from old profiling module are that you get more
.. % information, and you pay less CPU time. It's not a trade-off, it's a information, and you pay less CPU time. It's not a trade-off, it's a
.. % trade-up. trade-up.
.. %
.. % To be specific: To be specific:
.. %
.. % \begin{description} \begin{description}
.. %
.. % \item[Bugs removed:] \item[Bugs removed:]
.. % Local stack frame is no longer molested, execution time is now charged Local stack frame is no longer molested, execution time is now charged
.. % to correct functions. to correct functions.
.. %
.. % \item[Accuracy increased:] \item[Accuracy increased:]
.. % Profiler execution time is no longer charged to user's code, Profiler execution time is no longer charged to user's code,
.. % calibration for platform is supported, file reads are not done \emph{by} calibration for platform is supported, file reads are not done \emph{by}
.. % profiler \emph{during} profiling (and charged to user's code!). profiler \emph{during} profiling (and charged to user's code!).
.. %
.. % \item[Speed increased:] \item[Speed increased:]
.. % Overhead CPU cost was reduced by more than a factor of two (perhaps a Overhead CPU cost was reduced by more than a factor of two (perhaps a
.. % factor of five), lightweight profiler module is all that must be factor of five), lightweight profiler module is all that must be
.. % loaded, and the report generating module (\module{pstats}) is not needed loaded, and the report generating module (\module{pstats}) is not needed
.. % during profiling. during profiling.
.. %
.. % \item[Recursive functions support:] \item[Recursive functions support:]
.. % Cumulative times in recursive functions are correctly calculated; Cumulative times in recursive functions are correctly calculated;
.. % recursive entries are counted. recursive entries are counted.
.. %
.. % \item[Large growth in report generating UI:] \item[Large growth in report generating UI:]
.. % Distinct profiles runs can be added together forming a comprehensive Distinct profiles runs can be added together forming a comprehensive
.. % report; functions that import statistics take arbitrary lists of report; functions that import statistics take arbitrary lists of
.. % files; sorting criteria is now based on keywords (instead of 4 integer files; sorting criteria is now based on keywords (instead of 4 integer
.. % options); reports shows what functions were profiled as well as what options); reports shows what functions were profiled as well as what
.. % profile file was referenced; output format has been improved. profile file was referenced; output format has been improved.
.. %
.. % \end{description} \end{description}
.. _profile-instant: .. _profile-instant:
@ -185,7 +185,7 @@ second method sorted all the entries according to the standard module/line/name
string that is printed. The third method printed out all the statistics. You string that is printed. The third method printed out all the statistics. You
might try the following sort calls: might try the following sort calls:
.. % (this is to comply with the semantics of the old profiler). .. (this is to comply with the semantics of the old profiler).
:: ::
@ -376,7 +376,7 @@ Analysis of the profiler data is done using the :class:`Stats` class.
a single report. If additional files need to be combined with data in an a single report. If additional files need to be combined with data in an
existing :class:`Stats` object, the :meth:`add` method can be used. existing :class:`Stats` object, the :meth:`add` method can be used.
.. % (such as the old system profiler). .. (such as the old system profiler).
.. versionchanged:: 2.5 .. versionchanged:: 2.5
The *stream* parameter was added. The *stream* parameter was added.
@ -477,7 +477,7 @@ The :class:`Stats` Class
(numeric) is used, only one sort key (the numeric key) will be used, and (numeric) is used, only one sort key (the numeric key) will be used, and
additional arguments will be silently ignored. additional arguments will be silently ignored.
.. % For compatibility with the old profiler, .. For compatibility with the old profiler,
.. method:: Stats.reverse_order() .. method:: Stats.reverse_order()
@ -486,8 +486,7 @@ The :class:`Stats` Class
within the object. Note that by default ascending vs descending order is within the object. Note that by default ascending vs descending order is
properly selected based on the sort key of choice. properly selected based on the sort key of choice.
.. % This method is provided primarily for .. This method is provided primarily for compatibility with the old profiler.
.. % compatibility with the old profiler.
.. method:: Stats.print_stats([restriction, ...]) .. method:: Stats.print_stats([restriction, ...])

7
Doc/library/py_compile.rst
View File

@ -3,11 +3,8 @@
.. module:: py_compile .. module:: py_compile
:synopsis: Generate byte-code files from Python source files. :synopsis: Generate byte-code files from Python source files.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. % Documentation based on module docstrings, by Fred L. Drake, Jr. .. documentation based on module docstrings
.. % <fdrake@acm.org>
.. index:: pair: file; byte-code .. index:: pair: file; byte-code

4
Doc/library/pyclbr.rst
View File

@ -24,7 +24,7 @@ in Python, including many standard and optional extension modules.
be a sequence, and is used to augment the value of ``sys.path``, which is be a sequence, and is used to augment the value of ``sys.path``, which is
used to locate module source code. used to locate module source code.
.. % The 'inpackage' parameter appears to be for internal use only.... .. The 'inpackage' parameter appears to be for internal use only....
.. function:: readmodule_ex(module[, path]) .. function:: readmodule_ex(module[, path])
@ -35,7 +35,7 @@ in Python, including many standard and optional extension modules.
the key ``'__path__'`` in the returned dictionary has as its value a list which the key ``'__path__'`` in the returned dictionary has as its value a list which
contains the package search path. contains the package search path.
.. % The 'inpackage' parameter appears to be for internal use only.... .. The 'inpackage' parameter appears to be for internal use only....
.. _pyclbr-class-objects: .. _pyclbr-class-objects:

14
Doc/library/pyexpat.rst
View File

@ -7,14 +7,12 @@
.. moduleauthor:: Paul Prescod <paul@prescod.net> .. moduleauthor:: Paul Prescod <paul@prescod.net>
.. % Markup notes: .. Markup notes:
.. %
.. % Many of the attributes of the XMLParser objects are callbacks. Many of the attributes of the XMLParser objects are callbacks. Since
.. % Since signature information must be presented, these are described signature information must be presented, these are described using the method
.. % using the methoddesc environment. Since they are attributes which directive. Since they are attributes which are set by client code, in-text
.. % are set by client code, in-text references to these attributes references to these attributes should be marked using the :member: role.
.. % should be marked using the \member macro and should not include the
.. % parentheses used when marking functions and methods.
.. versionadded:: 2.0 .. versionadded:: 2.0

22
Doc/library/re.rst
View File

@ -84,8 +84,6 @@ the null byte using the ``\number`` notation, e.g., ``'\x00'``.
The special characters are: The special characters are:
.. %
``'.'`` ``'.'``
(Dot.) In the default mode, this matches any character except a newline. If (Dot.) In the default mode, this matches any character except a newline. If
the :const:`DOTALL` flag has been specified, this matches any character the :const:`DOTALL` flag has been specified, this matches any character
@ -298,8 +296,6 @@ The special sequences consist of ``'\'`` and a character from the list below.
If the ordinary character is not on the list, then the resulting RE will match If the ordinary character is not on the list, then the resulting RE will match
the second character. For example, ``\$`` matches the character ``'$'``. the second character. For example, ``\$`` matches the character ``'$'``.
.. %
``\number`` ``\number``
Matches the contents of the group of the same number. Groups are numbered Matches the contents of the group of the same number. Groups are numbered
starting from 1. For example, ``(.+) \1`` matches ``'the the'`` or ``'55 55'``, starting from 1. For example, ``(.+) \1`` matches ``'the the'`` or ``'55 55'``,
@ -385,9 +381,6 @@ there are three octal digits, it is considered an octal escape. Otherwise, it is
a group reference. As for string literals, octal escapes are always at most a group reference. As for string literals, octal escapes are always at most
three digits in length. three digits in length.
.. % Note the lack of a period in the section title; it causes problems
.. % with readers of the GNU info version. See http://www.python.org/sf/581414.
.. _matching-searching: .. _matching-searching:
@ -407,15 +400,11 @@ beginning with ``'^'``: ``'^'`` matches only at the start of the string, or in
:const:`MULTILINE` mode also immediately following a newline. The "match" :const:`MULTILINE` mode also immediately following a newline. The "match"
operation succeeds only if the pattern matches at the start of the string operation succeeds only if the pattern matches at the start of the string
regardless of mode, or at the starting position given by the optional *pos* regardless of mode, or at the starting position given by the optional *pos*
argument regardless of whether a newline precedes it. argument regardless of whether a newline precedes it. ::
.. % Examples from Tim Peters:
::
>>> re.match("c", "abcdef") # No match >>> re.match("c", "abcdef") # No match
>>> re.search("c", "abcdef") >>> re.search("c", "abcdef")
<_sre.SRE_Match object at 0x827e9c0> # Match <_sre.SRE_Match object at 0x827e9c0> # Match
.. _contents-of-module-re: .. _contents-of-module-re:
@ -451,10 +440,9 @@ form.
but the version using :func:`compile` is more efficient when the expression but the version using :func:`compile` is more efficient when the expression
will be used several times in a single program. will be used several times in a single program.
.. % (The compiled version of the last pattern passed to .. (The compiled version of the last pattern passed to :func:`re.match` or
.. % \function{re.match()} or \function{re.search()} is cached, so :func:`re.search` is cached, so programs that use only a single regular
.. % programs that use only a single regular expression at a time needn't expression at a time needn't worry about compiling regular expressions.)
.. % worry about compiling regular expressions.)
.. data:: I .. data:: I

7
Doc/library/rexec.rst
View File

@ -182,7 +182,7 @@ And their equivalents with access to restricted standard I/O streams:
Unload the module object *module*. Unload the module object *module*.
.. % XXX what are the semantics of this? .. XXX what are the semantics of this?
.. _rexec-extension: .. _rexec-extension:
@ -232,7 +232,7 @@ new values. All these attributes are tuples of strings.
'times', 'uname', 'getpid', 'getppid', 'getcwd', 'getuid', 'getgid', 'geteuid', 'times', 'uname', 'getpid', 'getppid', 'getcwd', 'getuid', 'getgid', 'geteuid',
'getegid')``. 'getegid')``.
.. % Should this be called ok_os_names? .. Should this be called ok_os_names?
.. attribute:: RExec.ok_sys_names .. attribute:: RExec.ok_sys_names
@ -285,6 +285,3 @@ apart the filename and performing various operations on it. In cases where
security is at stake, it may be preferable to write simple code which is security is at stake, it may be preferable to write simple code which is
sometimes overly restrictive, instead of more general code that is also more sometimes overly restrictive, instead of more general code that is also more
complex and may harbor a subtle security hole. complex and may harbor a subtle security hole.
.. %

4
Doc/library/sched.rst
View File

@ -1,4 +1,3 @@
:mod:`sched` --- Event scheduler :mod:`sched` --- Event scheduler
================================ ================================
@ -6,9 +5,6 @@
:synopsis: General purpose event scheduler. :synopsis: General purpose event scheduler.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. % LaTeXed and enhanced from comments in file
.. index:: single: event scheduling .. index:: single: event scheduling
The :mod:`sched` module defines a class which implements a general purpose event The :mod:`sched` module defines a class which implements a general purpose event

2
Doc/library/select.rst
View File

@ -58,8 +58,6 @@ The module defines the following:
class yourself, as long as it has an appropriate :meth:`fileno` method (that class yourself, as long as it has an appropriate :meth:`fileno` method (that
really returns a file descriptor, not just a random integer). really returns a file descriptor, not just a random integer).
.. %
.. note:: .. note::
.. index:: single: WinSock .. index:: single: WinSock

4
Doc/library/shutil.rst
View File

@ -5,9 +5,7 @@
.. module:: shutil .. module:: shutil
:synopsis: High-level file operations, including copying. :synopsis: High-level file operations, including copying.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. partly based on the docstrings
.. % partly based on the docstrings
.. index:: .. index::
single: file; copying single: file; copying

4
Doc/library/sndhdr.rst
View File

@ -5,9 +5,7 @@
.. module:: sndhdr .. module:: sndhdr
:synopsis: Determine type of a sound file. :synopsis: Determine type of a sound file.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. Based on comments in the module source file.
.. % Based on comments in the module source file.
.. index:: .. index::
single: A-LAW single: A-LAW

2
Doc/library/socket.rst
View File

@ -568,7 +568,7 @@ correspond to Unix system calls applicable to sockets.
file object and socket object may be closed or garbage-collected independently. file object and socket object may be closed or garbage-collected independently.
The socket must be in blocking mode (it can not have a timeout). The optional The socket must be in blocking mode (it can not have a timeout). The optional
*mode* and *bufsize* arguments are interpreted the same way as by the built-in *mode* and *bufsize* arguments are interpreted the same way as by the built-in
:func:`file` function; see :ref:`built-in-funcs` for more information. :func:`file` function.
.. method:: socket.recv(bufsize[, flags]) .. method:: socket.recv(bufsize[, flags])

18
Doc/library/socketserver.rst
View File

@ -115,9 +115,8 @@ next (or whether to handle a new incoming request). This is particularly
important for stream services where each client can potentially be connected for important for stream services where each client can potentially be connected for
a long time (if threads or subprocesses cannot be used). a long time (if threads or subprocesses cannot be used).
.. % XXX should data and methods be intermingled, or separate? .. XXX should data and methods be intermingled, or separate?
.. % how should the distinction between class and instance variables be how should the distinction between class and instance variables be drawn?
.. % drawn?
Server Objects Server Objects
@ -171,8 +170,7 @@ Server Objects
The server classes support the following class variables: The server classes support the following class variables:
.. % XXX should class variables be covered before instance variables, or .. XXX should class variables be covered before instance variables, or vice versa?
.. % vice versa?
.. data:: allow_reuse_address .. data:: allow_reuse_address
@ -199,8 +197,8 @@ There are various server methods that can be overridden by subclasses of base
server classes like :class:`TCPServer`; these methods aren't useful to external server classes like :class:`TCPServer`; these methods aren't useful to external
users of the server object. users of the server object.
.. % should the default implementations of these be documented, or should .. XXX should the default implementations of these be documented, or should
.. % it be assumed that the user will look at SocketServer.py? it be assumed that the user will look at SocketServer.py?
.. function:: finish_request() .. function:: finish_request()
@ -230,9 +228,9 @@ users of the server object.
or thread to handle the request; the :class:`ForkingMixIn` and or thread to handle the request; the :class:`ForkingMixIn` and
:class:`ThreadingMixIn` classes do this. :class:`ThreadingMixIn` classes do this.
.. % Is there any point in documenting the following two functions? .. Is there any point in documenting the following two functions?
.. % What would the purpose of overriding them be: initializing server What would the purpose of overriding them be: initializing server
.. % instance variables, adding new network families? instance variables, adding new network families?
.. function:: server_activate() .. function:: server_activate()

2
Doc/library/sqlite3.rst
View File

@ -351,7 +351,7 @@ A :class:`Connection` instance has the following attributes and methods:
memory overhead. It will probably be better than your own custom memory overhead. It will probably be better than your own custom
dictionary-based approach or even a db_row based solution. dictionary-based approach or even a db_row based solution.
.. % XXX what's a db_row-based solution? .. XXX what's a db_row-based solution?
.. attribute:: Connection.text_factory .. attribute:: Connection.text_factory

3
Doc/library/statvfs.rst
View File

@ -1,4 +1,3 @@
:mod:`statvfs` --- Constants used with :func:`os.statvfs` :mod:`statvfs` --- Constants used with :func:`os.statvfs`
========================================================= =========================================================
@ -7,8 +6,6 @@
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. % LaTeX'ed from comments in module
The :mod:`statvfs` module defines constants so interpreting the result if The :mod:`statvfs` module defines constants so interpreting the result if
:func:`os.statvfs`, which returns a tuple, can be made without remembering :func:`os.statvfs`, which returns a tuple, can be made without remembering
"magic numbers." Each of the constants defined in this module is the *index* of "magic numbers." Each of the constants defined in this module is the *index* of

23
Doc/library/stdtypes.rst
View File

@ -162,11 +162,14 @@ This table summarizes the comparison operations:
.. index:: .. index::
pair: operator; comparison pair: operator; comparison
operator: == operator: ==
operator: <
operator: <=
operator: >
operator: >=
operator: !=
operator: is operator: is
operator: is not operator: is not
.. % XXX *All* others have funny characters < ! >
Notes: Notes:
(1) (1)
@ -361,8 +364,8 @@ Notes:
.. versionadded:: 2.6 .. versionadded:: 2.6
.. % XXXJH exceptions: overflow (when? what operations?) zerodivision .. XXXJH exceptions: overflow (when? what operations?) zerodivision
.. _bitstring-ops: .. _bitstring-ops:
@ -1232,7 +1235,7 @@ Notes:
Since Python strings have an explicit length, ``%s`` conversions do not assume Since Python strings have an explicit length, ``%s`` conversions do not assume
that ``'\0'`` is the end of the string. that ``'\0'`` is the end of the string.
.. % XXX Examples? .. XXX Examples?
For safety reasons, floating point precisions are clipped to 50; ``%f`` For safety reasons, floating point precisions are clipped to 50; ``%f``
conversions for numbers whose absolute value is over 1e25 are replaced by ``%g`` conversions for numbers whose absolute value is over 1e25 are replaced by ``%g``
@ -1854,8 +1857,7 @@ File Objects
module: socket module: socket
File objects are implemented using C's ``stdio`` package and can be File objects are implemented using C's ``stdio`` package and can be
created with the built-in :func:`file` and (more usually) :func:`open` created with the built-in :func:`open` function. File
constructors described in the :ref:`built-in-funcs` section. [#]_ File
objects are also returned by some other built-in functions and methods, objects are also returned by some other built-in functions and methods,
such as :func:`os.popen` and :func:`os.fdopen` and the :meth:`makefile` such as :func:`os.popen` and :func:`os.fdopen` and the :meth:`makefile`
method of socket objects. Temporary files can be created using the method of socket objects. Temporary files can be created using the
@ -1879,7 +1881,7 @@ Files have the following methods:
As of Python 2.5, you can avoid having to call this method explicitly if you use As of Python 2.5, you can avoid having to call this method explicitly if you use
the :keyword:`with` statement. For example, the following code will the :keyword:`with` statement. For example, the following code will
automatically close ``f`` when the :keyword:`with` block is exited:: automatically close *f* when the :keyword:`with` block is exited::
from __future__ import with_statement from __future__ import with_statement
@ -2020,7 +2022,7 @@ Files have the following methods:
Note that not all file objects are seekable. Note that not all file objects are seekable.
.. versionchanged:: 2.6 .. versionchanged:: 2.6
Passing float values as offset has been deprecated Passing float values as offset has been deprecated.
.. method:: file.tell() .. method:: file.tell()
@ -2469,9 +2471,6 @@ types, where they are relevant. Some of these are not reported by the
strings of meaningless digits without hampering correct use and without having strings of meaningless digits without hampering correct use and without having
to know the exact precision of floating point values on a particular machine. to know the exact precision of floating point values on a particular machine.
.. [#] :func:`file` is new in Python 2.2. The older built-in :func:`open` is an alias
for :func:`file`.
.. [#] The advantage of leaving the newline on is that returning an empty string is .. [#] The advantage of leaving the newline on is that returning an empty string is
then an unambiguous EOF indication. It is also possible (in cases where it then an unambiguous EOF indication. It is also possible (in cases where it
might matter, for example, if you want to make an exact copy of a file while might matter, for example, if you want to make an exact copy of a file while

2
Doc/library/struct.rst
View File

@ -192,7 +192,7 @@ For example, Motorola and Sun processors are big-endian; Intel and DEC
processors are little-endian. processors are little-endian.
Native size and alignment are determined using the C compiler's Native size and alignment are determined using the C compiler's
:keyword:`sizeof` expression. This is always combined with native byte order. ``sizeof`` expression. This is always combined with native byte order.
Standard size and alignment are as follows: no alignment is required for any Standard size and alignment are as follows: no alignment is required for any
type (so you have to use pad bytes); :ctype:`short` is 2 bytes; :ctype:`int` and type (so you have to use pad bytes); :ctype:`short` is 2 bytes; :ctype:`int` and

5
Doc/library/sys.rst
View File

@ -525,9 +525,8 @@ always available.
implementation and, where needed, by :mod:`sitecustomize`. Once used by the implementation and, where needed, by :mod:`sitecustomize`. Once used by the
:mod:`site` module, it is removed from the :mod:`sys` module's namespace. :mod:`site` module, it is removed from the :mod:`sys` module's namespace.
.. % Note that \refmodule{site} is not imported if .. Note that :mod:`site` is not imported if the :option:`-S` option is passed
.. % the \programopt{-S} option is passed to the interpreter, in which to the interpreter, in which case this function will remain available.
.. % case this function will remain available.
.. versionadded:: 2.0 .. versionadded:: 2.0

13
Doc/library/tabnanny.rst
View File

@ -8,9 +8,7 @@
.. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de>
.. rudimentary documentation based on module comments
.. % rudimentary documentation based on module comments, by Peter Funk
.. % <pf@artcom-gmbh.de>
For the time being this module is intended to be called as a script. However it For the time being this module is intended to be called as a script. However it
is possible to import it into an IDE and use the function :func:`check` is possible to import it into an IDE and use the function :func:`check`
@ -55,16 +53,11 @@ described below.
This function is used by :func:`check` as a callback parameter to the function This function is used by :func:`check` as a callback parameter to the function
:func:`tokenize.tokenize`. :func:`tokenize.tokenize`.
.. % XXX FIXME: Document \function{errprint}, .. XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
.. % \function{format_witnesses} \class{Whitespace} reset_globals
.. % check_equal, indents
.. % \function{reset_globals}
.. seealso:: .. seealso::
Module :mod:`tokenize` Module :mod:`tokenize`
Lexical scanner for Python source code. Lexical scanner for Python source code.
.. % XXX may be add a reference to IDLE?

21
Doc/library/tarfile.rst
View File

@ -210,10 +210,6 @@ details.
`GNU tar manual, Basic Tar Format <http://www.gnu.org/software/tar/manual/html_node/tar_134.html#SEC134>`_ `GNU tar manual, Basic Tar Format <http://www.gnu.org/software/tar/manual/html_node/tar_134.html#SEC134>`_
Documentation for tar archive files, including GNU tar extensions. Documentation for tar archive files, including GNU tar extensions.
.. % -----------------
.. % TarFile Objects
.. % -----------------
.. _tarfile-objects: .. _tarfile-objects:
@ -440,10 +436,6 @@ object, see :ref:`tarinfo-objects` for details.
.. versionadded:: 2.6 .. versionadded:: 2.6
.. % -----------------
.. % TarInfo Objects
.. % -----------------
.. _tarinfo-objects: .. _tarinfo-objects:
@ -599,10 +591,6 @@ A :class:`TarInfo` object also provides some convenient query methods:
Return :const:`True` if it is one of character device, block device or FIFO. Return :const:`True` if it is one of character device, block device or FIFO.
.. % ------------------------
.. % Examples
.. % ------------------------
.. _tar-examples: .. _tar-examples:
@ -660,10 +648,6 @@ The *only* way to extract an uncompressed tar stream from ``sys.stdin``::
tar.extract(tarinfo) tar.extract(tarinfo)
tar.close() tar.close()
.. % ------------
.. % Tar format
.. % ------------
.. _tar-formats: .. _tar-formats:
@ -704,11 +688,6 @@ created:
* The SunOS tar extended format. This format is a variant of the POSIX.1-2001 * The SunOS tar extended format. This format is a variant of the POSIX.1-2001
pax format, but is not compatible. pax format, but is not compatible.
.. % ----------------
.. % Unicode issues
.. % ----------------
.. _tar-unicode: .. _tar-unicode:
Unicode issues Unicode issues

2
Doc/library/test.rst
View File

@ -33,8 +33,6 @@ written using a "traditional" testing style that compares output printed to
Writing Unit Tests for the :mod:`test` package Writing Unit Tests for the :mod:`test` package
---------------------------------------------- ----------------------------------------------
.. %
It is preferred that tests that use the :mod:`unittest` module follow a few It is preferred that tests that use the :mod:`unittest` module follow a few
guidelines. One is to name the test module by starting it with ``test_`` and end guidelines. One is to name the test module by starting it with ``test_`` and end
it with the name of the module being tested. The test methods in the test module it with the name of the module being tested. The test methods in the test module

13
Doc/library/thread.rst
View File

@ -65,12 +65,13 @@ It defines the following constant and functions:
Raise the :exc:`SystemExit` exception. When not caught, this will cause the Raise the :exc:`SystemExit` exception. When not caught, this will cause the
thread to exit silently. thread to exit silently.
.. % \begin{funcdesc}{exit_prog}{status} ..
.. % Exit all threads and report the value of the integer argument function:: exit_prog(status)
.. % \var{status} as the exit status of the entire program.
.. % \strong{Caveat:} code in pending \keyword{finally} clauses, in this thread Exit all threads and report the value of the integer argument
.. % or in other threads, is not executed. *status* as the exit status of the entire program.
.. % \end{funcdesc} **Caveat:** code in pending :keyword:`finally` clauses, in this thread
or in other threads, is not executed.
.. function:: allocate_lock() .. function:: allocate_lock()

183
Doc/library/tix.rst
View File

@ -79,8 +79,6 @@ line::
package ifneeded Tix 8.1 [list load "[file join $dir tix8183.dll]" Tix] package ifneeded Tix 8.1 [list load "[file join $dir tix8183.dll]" Tix]
.. % $ <-- bow to font-lock
Tix Widgets Tix Widgets
----------- -----------
@ -90,7 +88,7 @@ introduces over 40 widget classes to the :mod:`Tkinter` repertoire. There is a
demo of all the :mod:`Tix` widgets in the :file:`Demo/tix` directory of the demo of all the :mod:`Tix` widgets in the :file:`Demo/tix` directory of the
standard distribution. standard distribution.
.. % The Python sample code is still being added to Python, hence commented out .. The Python sample code is still being added to Python, hence commented out
Basic Widgets Basic Widgets
@ -105,8 +103,8 @@ Basic Widgets
widget to which a Balloon widget has been bound, a small pop-up window with a widget to which a Balloon widget has been bound, a small pop-up window with a
descriptive message will be shown on the screen. descriptive message will be shown on the screen.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Balloon}{http://tix.sourceforge.net/dist/current/demos/samples/Balloon.tcl} .. \ulink{Balloon}{http://tix.sourceforge.net/dist/current/demos/samples/Balloon.tcl}
.. class:: ButtonBox() .. class:: ButtonBox()
@ -115,8 +113,8 @@ Basic Widgets
<http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixButtonBox.htm>`_ <http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixButtonBox.htm>`_
widget creates a box of buttons, such as is commonly used for ``Ok Cancel``. widget creates a box of buttons, such as is commonly used for ``Ok Cancel``.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/BtnBox.tcl} .. \ulink{ButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/BtnBox.tcl}
.. class:: ComboBox() .. class:: ComboBox()
@ -127,8 +125,8 @@ Basic Widgets
choice by either typing in the entry subwdget or selecting from the listbox choice by either typing in the entry subwdget or selecting from the listbox
subwidget. subwidget.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ComboBox}{http://tix.sourceforge.net/dist/current/demos/samples/ComboBox.tcl} .. \ulink{ComboBox}{http://tix.sourceforge.net/dist/current/demos/samples/ComboBox.tcl}
.. class:: Control() .. class:: Control()
@ -140,8 +138,8 @@ Basic Widgets
the entry. The new value will be checked against the user-defined upper and the entry. The new value will be checked against the user-defined upper and
lower limits. lower limits.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Control}{http://tix.sourceforge.net/dist/current/demos/samples/Control.tcl} .. \ulink{Control}{http://tix.sourceforge.net/dist/current/demos/samples/Control.tcl}
.. class:: LabelEntry() .. class:: LabelEntry()
@ -151,8 +149,8 @@ Basic Widgets
widget packages an entry widget and a label into one mega widget. It can be used widget packages an entry widget and a label into one mega widget. It can be used
be used to simplify the creation of "entry-form" type of interface. be used to simplify the creation of "entry-form" type of interface.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{LabelEntry}{http://tix.sourceforge.net/dist/current/demos/samples/LabEntry.tcl} .. \ulink{LabelEntry}{http://tix.sourceforge.net/dist/current/demos/samples/LabEntry.tcl}
.. class:: LabelFrame() .. class:: LabelFrame()
@ -163,8 +161,8 @@ Basic Widgets
widgets inside a LabelFrame widget, one creates the new widgets relative to the widgets inside a LabelFrame widget, one creates the new widgets relative to the
:attr:`frame` subwidget and manage them inside the :attr:`frame` subwidget. :attr:`frame` subwidget and manage them inside the :attr:`frame` subwidget.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{LabelFrame}{http://tix.sourceforge.net/dist/current/demos/samples/LabFrame.tcl} .. \ulink{LabelFrame}{http://tix.sourceforge.net/dist/current/demos/samples/LabFrame.tcl}
.. class:: Meter() .. class:: Meter()
@ -174,8 +172,8 @@ Basic Widgets
can be used to show the progress of a background job which may take a long time can be used to show the progress of a background job which may take a long time
to execute. to execute.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Meter}{http://tix.sourceforge.net/dist/current/demos/samples/Meter.tcl} .. \ulink{Meter}{http://tix.sourceforge.net/dist/current/demos/samples/Meter.tcl}
.. class:: OptionMenu() .. class:: OptionMenu()
@ -184,8 +182,8 @@ Basic Widgets
<http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixOptionMenu.htm>`_ <http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixOptionMenu.htm>`_
creates a menu button of options. creates a menu button of options.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{OptionMenu}{http://tix.sourceforge.net/dist/current/demos/samples/OptMenu.tcl} .. \ulink{OptionMenu}{http://tix.sourceforge.net/dist/current/demos/samples/OptMenu.tcl}
.. class:: PopupMenu() .. class:: PopupMenu()
@ -196,8 +194,8 @@ Basic Widgets
of the :mod:`Tix` :class:`PopupMenu` widget is it requires less application code of the :mod:`Tix` :class:`PopupMenu` widget is it requires less application code
to manipulate. to manipulate.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{PopupMenu}{http://tix.sourceforge.net/dist/current/demos/samples/PopMenu.tcl} .. \ulink{PopupMenu}{http://tix.sourceforge.net/dist/current/demos/samples/PopMenu.tcl}
.. class:: Select() .. class:: Select()
@ -207,8 +205,8 @@ Basic Widgets
is a container of button subwidgets. It can be used to provide radio-box or is a container of button subwidgets. It can be used to provide radio-box or
check-box style of selection options for the user. check-box style of selection options for the user.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Select}{http://tix.sourceforge.net/dist/current/demos/samples/Select.tcl} .. \ulink{Select}{http://tix.sourceforge.net/dist/current/demos/samples/Select.tcl}
.. class:: StdButtonBox() .. class:: StdButtonBox()
@ -217,8 +215,8 @@ Basic Widgets
<http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixStdButtonBox.htm>`_ <http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixStdButtonBox.htm>`_
widget is a group of standard buttons for Motif-like dialog boxes. widget is a group of standard buttons for Motif-like dialog boxes.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{StdButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/StdBBox.tcl} .. \ulink{StdButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/StdBBox.tcl}
File Selectors File Selectors
@ -233,8 +231,8 @@ File Selectors
sub-directories. The user can choose one of the directories displayed in the sub-directories. The user can choose one of the directories displayed in the
list or change to another directory. list or change to another directory.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{DirList}{http://tix.sourceforge.net/dist/current/demos/samples/DirList.tcl} .. \ulink{DirList}{http://tix.sourceforge.net/dist/current/demos/samples/DirList.tcl}
.. class:: DirTree() .. class:: DirTree()
@ -245,8 +243,8 @@ File Selectors
sub-directories. The user can choose one of the directories displayed in the sub-directories. The user can choose one of the directories displayed in the
list or change to another directory. list or change to another directory.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{DirTree}{http://tix.sourceforge.net/dist/current/demos/samples/DirTree.tcl} .. \ulink{DirTree}{http://tix.sourceforge.net/dist/current/demos/samples/DirTree.tcl}
.. class:: DirSelectDialog() .. class:: DirSelectDialog()
@ -257,8 +255,8 @@ File Selectors
can use this dialog window to navigate through the file system to select the can use this dialog window to navigate through the file system to select the
desired directory. desired directory.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{DirSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/DirDlg.tcl} .. \ulink{DirSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/DirDlg.tcl}
.. class:: DirSelectBox() .. class:: DirSelectBox()
@ -278,8 +276,8 @@ File Selectors
:class:`ExFileSelectBox` widget is very similar to the standard file dialog on :class:`ExFileSelectBox` widget is very similar to the standard file dialog on
MS Windows 3.1. MS Windows 3.1.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ExFileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/EFileDlg.tcl} .. \ulink{ExFileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/EFileDlg.tcl}
.. class:: FileSelectBox() .. class:: FileSelectBox()
@ -291,8 +289,8 @@ File Selectors
selected into a :class:`ComboBox` widget so that they can be quickly selected selected into a :class:`ComboBox` widget so that they can be quickly selected
again. again.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{FileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/FileDlg.tcl} .. \ulink{FileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/FileDlg.tcl}
.. class:: FileEntry() .. class:: FileEntry()
@ -303,8 +301,8 @@ File Selectors
manually. Alternatively, the user can press the button widget that sits next to manually. Alternatively, the user can press the button widget that sits next to
the entry, which will bring up a file selection dialog. the entry, which will bring up a file selection dialog.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{FileEntry}{http://tix.sourceforge.net/dist/current/demos/samples/FileEnt.tcl} .. \ulink{FileEntry}{http://tix.sourceforge.net/dist/current/demos/samples/FileEnt.tcl}
Hierachical ListBox Hierachical ListBox
@ -319,8 +317,8 @@ Hierachical ListBox
file system directory trees. The list entries are indented and connected by file system directory trees. The list entries are indented and connected by
branch lines according to their places in the hierarchy. branch lines according to their places in the hierarchy.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{HList}{http://tix.sourceforge.net/dist/current/demos/samples/HList1.tcl} .. \ulink{HList}{http://tix.sourceforge.net/dist/current/demos/samples/HList1.tcl}
.. class:: CheckList() .. class:: CheckList()
@ -331,12 +329,12 @@ Hierachical ListBox
similarly to the Tk checkbutton or radiobutton widgets, except it is capable of similarly to the Tk checkbutton or radiobutton widgets, except it is capable of
handling many more items than checkbuttons or radiobuttons. handling many more items than checkbuttons or radiobuttons.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ CheckList}{http://tix.sourceforge.net/dist/current/demos/samples/ChkList.tcl} .. \ulink{ CheckList}{http://tix.sourceforge.net/dist/current/demos/samples/ChkList.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledHList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList.tcl} .. \ulink{ScrolledHList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledHList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList2.tcl} .. \ulink{ScrolledHList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList2.tcl}
.. class:: Tree() .. class:: Tree()
@ -346,10 +344,10 @@ Hierachical ListBox
can be used to display hierarchical data in a tree form. The user can adjust the can be used to display hierarchical data in a tree form. The user can adjust the
view of the tree by opening or closing parts of the tree. view of the tree by opening or closing parts of the tree.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Tree}{http://tix.sourceforge.net/dist/current/demos/samples/Tree.tcl} .. \ulink{Tree}{http://tix.sourceforge.net/dist/current/demos/samples/Tree.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Tree (Dynamic)}{http://tix.sourceforge.net/dist/current/demos/samples/DynTree.tcl} .. \ulink{Tree (Dynamic)}{http://tix.sourceforge.net/dist/current/demos/samples/DynTree.tcl}
Tabular ListBox Tabular ListBox
@ -366,18 +364,18 @@ Tabular ListBox
in a two dimensional format and (2) you can use graphical images as well as in a two dimensional format and (2) you can use graphical images as well as
multiple colors and fonts for the list entries. multiple colors and fonts for the list entries.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledTList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/STList1.tcl} .. \ulink{ScrolledTList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/STList1.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledTList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/STList2.tcl} .. \ulink{ScrolledTList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/STList2.tcl}
.. % Grid has yet to be added to Python .. Grid has yet to be added to Python
.. % \subsubsection{Grid Widget} .. \subsubsection{Grid Widget}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Simple Grid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid0.tcl} .. \ulink{Simple Grid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid0.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledGrid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid1.tcl} .. \ulink{ScrolledGrid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid1.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Editable Grid}{http://tix.sourceforge.net/dist/current/demos/samples/EditGrid.tcl} .. \ulink{Editable Grid}{http://tix.sourceforge.net/dist/current/demos/samples/EditGrid.tcl}
Manager Widgets Manager Widgets
@ -392,8 +390,8 @@ Manager Widgets
The panes can be arranged either vertically or horizontally. The user changes The panes can be arranged either vertically or horizontally. The user changes
the sizes of the panes by dragging the resize handle between two panes. the sizes of the panes by dragging the resize handle between two panes.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{PanedWindow}{http://tix.sourceforge.net/dist/current/demos/samples/PanedWin.tcl} .. \ulink{PanedWindow}{http://tix.sourceforge.net/dist/current/demos/samples/PanedWin.tcl}
.. class:: ListNoteBook() .. class:: ListNoteBook()
@ -406,8 +404,8 @@ Manager Widgets
can be shown. The user can navigate through these pages by choosing the name of can be shown. The user can navigate through these pages by choosing the name of
the desired page in the :attr:`hlist` subwidget. the desired page in the :attr:`hlist` subwidget.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ListNoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/ListNBK.tcl} .. \ulink{ListNoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/ListNBK.tcl}
.. class:: NoteBook() .. class:: NoteBook()
@ -419,18 +417,18 @@ Manager Widgets
these pages can be shown. The user can navigate through these pages by choosing these pages can be shown. The user can navigate through these pages by choosing
the visual "tabs" at the top of the NoteBook widget. the visual "tabs" at the top of the NoteBook widget.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/NoteBook.tcl} .. \ulink{NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/NoteBook.tcl}
.. % \subsubsection{Scrolled Widgets} .. \subsubsection{Scrolled Widgets}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledListBox}{http://tix.sourceforge.net/dist/current/demos/samples/SListBox.tcl} .. \ulink{ScrolledListBox}{http://tix.sourceforge.net/dist/current/demos/samples/SListBox.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledText}{http://tix.sourceforge.net/dist/current/demos/samples/SText.tcl} .. \ulink{ScrolledText}{http://tix.sourceforge.net/dist/current/demos/samples/SText.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{ScrolledWindow}{http://tix.sourceforge.net/dist/current/demos/samples/SWindow.tcl} .. \ulink{ScrolledWindow}{http://tix.sourceforge.net/dist/current/demos/samples/SWindow.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Canvas Object View}{http://tix.sourceforge.net/dist/current/demos/samples/CObjView.tcl} .. \ulink{Canvas Object View}{http://tix.sourceforge.net/dist/current/demos/samples/CObjView.tcl}
Image Types Image Types
@ -442,10 +440,10 @@ The :mod:`Tix` module adds:
capabilities to all :mod:`Tix` and :mod:`Tkinter` widgets to create color images capabilities to all :mod:`Tix` and :mod:`Tkinter` widgets to create color images
from XPM files. from XPM files.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{XPM Image In Button}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm.tcl} .. \ulink{XPM Image In Button}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{XPM Image In Menu}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm1.tcl} .. \ulink{XPM Image In Menu}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm1.tcl}
* `Compound * `Compound
<http://tix.sourceforge.net/dist/current/man/html/TixCmd/compound.htm>`_ image <http://tix.sourceforge.net/dist/current/man/html/TixCmd/compound.htm>`_ image
@ -455,14 +453,14 @@ The :mod:`Tix` module adds:
display a bitmap and a text string simultaneously in a Tk :class:`Button` display a bitmap and a text string simultaneously in a Tk :class:`Button`
widget. widget.
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Compound Image In Buttons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg.tcl} .. \ulink{Compound Image In Buttons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Compound Image In NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg2.tcl} .. \ulink{Compound Image In NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg2.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Compound Image Notebook Color Tabs}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg4.tcl} .. \ulink{Compound Image Notebook Color Tabs}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg4.tcl}
.. % Python Demo of: .. Python Demo of:
.. % \ulink{Compound Image Icons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg3.tcl} .. \ulink{Compound Image Icons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg3.tcl}
Miscellaneous Widgets Miscellaneous Widgets
@ -489,15 +487,6 @@ In addition, :mod:`Tix` augments :mod:`Tkinter` by providing:
<http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixForm.htm>`_ geometry <http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixForm.htm>`_ geometry
manager based on attachment rules for all Tk widgets. manager based on attachment rules for all Tk widgets.
.. % begin{latexonly}
.. % \subsection{Tix Class Structure}
.. %
.. % \begin{figure}[hbtp]
.. % \centerline{\epsfig{file=hierarchy.png,width=.9\textwidth}}
.. % \vspace{.5cm}
.. % \caption{The Class Hierarchy of Tix Widgets}
.. % \end{figure}
.. % end{latexonly}
Tix Commands Tix Commands

6
Doc/library/tk.rst
View File

@ -36,8 +36,8 @@ libraries, see the :ref:`other-gui-packages` section.
idle.rst idle.rst
othergui.rst othergui.rst
.. % Other sections I have in mind are .. Other sections I have in mind are
.. % Tkinter internals Tkinter internals
.. % Freezing Tkinter applications Freezing Tkinter applications

40
Doc/library/tkinter.rst
View File

@ -59,7 +59,7 @@ Or, more often::
widget of Tk which usually is the main window of an application. Each instance widget of Tk which usually is the main window of an application. Each instance
has its own associated Tcl interpreter. has its own associated Tcl interpreter.
.. % FIXME: The following keyword arguments are currently recognized: .. FIXME: The following keyword arguments are currently recognized:
.. versionchanged:: 2.4 .. versionchanged:: 2.4
The *useTk* parameter was added. The *useTk* parameter was added.
@ -118,8 +118,6 @@ This section is not designed to be an exhaustive tutorial on either Tk or
Tkinter. Rather, it is intended as a stop gap, providing some introductory Tkinter. Rather, it is intended as a stop gap, providing some introductory
orientation on the system. orientation on the system.
.. % Converted to LaTeX by Mike Clarkson.
Credits: Credits:
* Tkinter was written by Steen Lumholt and Guido van Rossum. * Tkinter was written by Steen Lumholt and Guido van Rossum.
@ -182,17 +180,6 @@ documentation that exists. Here are some hints:
A Simple Hello World Program A Simple Hello World Program
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. % HelloWorld.html
.. % begin{latexonly}
.. % \begin{figure}[hbtp]
.. % \centerline{\epsfig{file=HelloWorld.gif,width=.9\textwidth}}
.. % \vspace{.5cm}
.. % \caption{HelloWorld gadget image}
.. % \end{figure}
.. % See also the hello-world \ulink{notes}{classes/HelloWorld-notes.html} and
.. % \ulink{summary}{classes/HelloWorld-summary.html}.
.. % end{latexonly}
:: ::
from Tkinter import * from Tkinter import *
@ -233,8 +220,6 @@ The class hierarchy looks complicated, but in actual practice, application
programmers almost always refer to the classes at the very bottom of the programmers almost always refer to the classes at the very bottom of the
hierarchy. hierarchy.
.. % BriefTclTk.html
Notes: Notes:
* These classes are provided for the purposes of organizing certain functions * These classes are provided for the purposes of organizing certain functions
@ -349,13 +334,6 @@ the Form geometry manager. ::
How Tk and Tkinter are Related How Tk and Tkinter are Related
------------------------------ ------------------------------
.. % Relationship.html
.. note::
This was derived from a graphical image; the image will be used more directly in
a subsequent version of this document.
From the top down: From the top down:
Your App Here (Python) Your App Here (Python)
@ -468,8 +446,6 @@ The Packer
.. index:: single: packing (widgets) .. index:: single: packing (widgets)
.. % Packer.html
The packer is one of Tk's geometry-management mechanisms. Geometry managers The packer is one of Tk's geometry-management mechanisms. Geometry managers
are used to specify the relative positioning of the positioning of widgets are used to specify the relative positioning of the positioning of widgets
within their container - their mutual *master*. In contrast to the more within their container - their mutual *master*. In contrast to the more
@ -478,8 +454,6 @@ packer takes qualitative relationship specification - *above*, *to the left of*,
*filling*, etc - and works everything out to determine the exact placement *filling*, etc - and works everything out to determine the exact placement
coordinates for you. coordinates for you.
.. % See also \citetitle[classes/ClassPacker.html]{the Packer class interface}.
The size of any *master* widget is determined by the size of the "slave widgets" The size of any *master* widget is determined by the size of the "slave widgets"
inside. The packer is used to control where slave widgets appear inside the inside. The packer is used to control where slave widgets appear inside the
master into which they are packed. You can pack widgets into frames, and frames master into which they are packed. You can pack widgets into frames, and frames
@ -536,8 +510,6 @@ options are ``variable``, ``textvariable``, ``onvalue``, ``offvalue``, and
``value``. This connection works both ways: if the variable changes for any ``value``. This connection works both ways: if the variable changes for any
reason, the widget it's connected to will be updated to reflect the new value. reason, the widget it's connected to will be updated to reflect the new value.
.. % VarCouplings.html
Unfortunately, in the current implementation of :mod:`Tkinter` it is not Unfortunately, in the current implementation of :mod:`Tkinter` it is not
possible to hand over an arbitrary Python variable to a widget through a possible to hand over an arbitrary Python variable to a widget through a
``variable`` or ``textvariable`` option. The only kinds of variables for which ``variable`` or ``textvariable`` option. The only kinds of variables for which
@ -584,8 +556,6 @@ The Window Manager
.. index:: single: window manager (widgets) .. index:: single: window manager (widgets)
.. % WindowMgr.html
In Tk, there is a utility command, ``wm``, for interacting with the window In Tk, there is a utility command, ``wm``, for interacting with the window
manager. Options to the ``wm`` command allow you to control things like titles, manager. Options to the ``wm`` command allow you to control things like titles,
placement, icon bitmaps, and the like. In :mod:`Tkinter`, these commands have placement, icon bitmaps, and the like. In :mod:`Tkinter`, these commands have
@ -600,8 +570,6 @@ window that contains an arbitrary widget, you can call the :meth:`_root` method.
This method begins with an underscore to denote the fact that this function is This method begins with an underscore to denote the fact that this function is
part of the implementation, and not an interface to Tk functionality. part of the implementation, and not an interface to Tk functionality.
.. % See also \citetitle[classes/ClassWm.html]{the Wm class interface}.
Here are some examples of typical usage:: Here are some examples of typical usage::
from Tkinter import * from Tkinter import *
@ -629,8 +597,6 @@ Tk Option Data Types
.. index:: single: Tk Option Data Types .. index:: single: Tk Option Data Types
.. % OptionTypes.html
anchor anchor
Legal values are points of the compass: ``"n"``, ``"ne"``, ``"e"``, ``"se"``, Legal values are points of the compass: ``"n"``, ``"ne"``, ``"e"``, ``"se"``,
``"s"``, ``"sw"``, ``"w"``, ``"nw"``, and also ``"center"``. ``"s"``, ``"sw"``, ``"w"``, ``"nw"``, and also ``"center"``.
@ -710,8 +676,6 @@ Bindings and Events
single: bind (widgets) single: bind (widgets)
single: events (widgets) single: events (widgets)
.. % Bindings.html
The bind method from the widget command allows you to watch for certain events The bind method from the widget command allows you to watch for certain events
and to have a callback function trigger when that event type occurs. The form and to have a callback function trigger when that event type occurs. The form
of the bind method is:: of the bind method is::
@ -767,8 +731,6 @@ A number of widgets require"index" parameters to be passed. These are used to
point at a specific place in a Text widget, or to particular characters in an point at a specific place in a Text widget, or to particular characters in an
Entry widget, or to particular menu items in a Menu widget. Entry widget, or to particular menu items in a Menu widget.
.. % Index.html
Entry widget indexes (index, view index, etc.) Entry widget indexes (index, view index, etc.)
Entry widgets have options that refer to character positions in the text being Entry widgets have options that refer to character positions in the text being
displayed. You can use these :mod:`Tkinter` functions to access these special displayed. You can use these :mod:`Tkinter` functions to access these special

11
Doc/library/undoc.rst
View File

@ -195,13 +195,12 @@ in the build tree and either rebuilding Python if the modules are statically
linked, or building and installing the shared object if using dynamically-loaded linked, or building and installing the shared object if using dynamically-loaded
extensions. extensions.
.. % %% lib-old is empty as of Python 2.5 .. (lib-old is empty as of Python 2.5)
.. % Those which are written in Python will be installed into the directory
.. % \file{lib-old/} installed as part of the standard library. To use
.. % these, the directory must be added to \code{sys.path}, possibly using
.. % \envvar{PYTHONPATH}.
.. % XXX need Windows instructions! Those which are written in Python will be installed into the directory
\file{lib-old/} installed as part of the standard library. To use
these, the directory must be added to \code{sys.path}, possibly using
\envvar{PYTHONPATH}.
:mod:`timing` :mod:`timing`
--- Measure time intervals to high resolution (use :func:`time.clock` instead). --- Measure time intervals to high resolution (use :func:`time.clock` instead).

5
Doc/library/wave.rst
View File

@ -1,13 +1,10 @@
.. % Documentations stolen and LaTeX'ed from comments in file.
:mod:`wave` --- Read and write WAV files :mod:`wave` --- Read and write WAV files
======================================== ========================================
.. module:: wave .. module:: wave
:synopsis: Provide an interface to the WAV sound format. :synopsis: Provide an interface to the WAV sound format.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. Documentations stolen from comments in file.
The :mod:`wave` module provides a convenient interface to the WAV sound format. The :mod:`wave` module provides a convenient interface to the WAV sound format.
It does not support compression/decompression, but it does support mono/stereo. It does not support compression/decompression, but it does support mono/stereo.

6
Doc/library/weakref.rst
View File

@ -15,8 +15,8 @@
The :mod:`weakref` module allows the Python programmer to create :dfn:`weak The :mod:`weakref` module allows the Python programmer to create :dfn:`weak
references` to objects. references` to objects.
.. % When making changes to the examples in this file, be sure to update .. When making changes to the examples in this file, be sure to update
.. % Lib/test/test_weakref.py::libreftest too! Lib/test/test_weakref.py::libreftest too!
In the following, the term :dfn:`referent` means the object which is referred to In the following, the term :dfn:`referent` means the object which is referred to
by a weak reference. by a weak reference.
@ -312,7 +312,7 @@ objects that it has seen before. The IDs of the objects can then be used in
other data structures without forcing the objects to remain alive, but the other data structures without forcing the objects to remain alive, but the
objects can still be retrieved by ID if they do. objects can still be retrieved by ID if they do.
.. % Example contributed by Tim Peters. .. Example contributed by Tim Peters.
:: ::

2
Doc/library/wsgiref.rst
View File

@ -29,7 +29,7 @@ to the WSGI specification (:pep:`333`).
See http://www.wsgi.org for more information about WSGI, and links to tutorials See http://www.wsgi.org for more information about WSGI, and links to tutorials
and other resources. and other resources.
.. % XXX If you're just trying to write a web application... .. XXX If you're just trying to write a web application...
:mod:`wsgiref.util` -- WSGI environment utilities :mod:`wsgiref.util` -- WSGI environment utilities

6
Doc/library/xml.dom.minidom.rst
View File

@ -214,11 +214,11 @@ rules apply:
* Operations are used as methods. Since the DOM uses only :keyword:`in` * Operations are used as methods. Since the DOM uses only :keyword:`in`
parameters, the arguments are passed in normal order (from left to right). parameters, the arguments are passed in normal order (from left to right).
There are no optional arguments. :keyword:`void` operations return ``None``. There are no optional arguments. ``void`` operations return ``None``.
* IDL attributes map to instance attributes. For compatibility with the OMG IDL * IDL attributes map to instance attributes. For compatibility with the OMG IDL
language mapping for Python, an attribute ``foo`` can also be accessed through language mapping for Python, an attribute ``foo`` can also be accessed through
accessor methods :meth:`_get_foo` and :meth:`_set_foo`. :keyword:`readonly` accessor methods :meth:`_get_foo` and :meth:`_set_foo`. ``readonly``
attributes must not be changed; this is not enforced at runtime. attributes must not be changed; this is not enforced at runtime.
* The types ``short int``, ``unsigned int``, ``unsigned long long``, and * The types ``short int``, ``unsigned int``, ``unsigned long long``, and
@ -229,7 +229,7 @@ rules apply:
Values of type ``DOMString`` may also be ``None`` where allowed to have the IDL Values of type ``DOMString`` may also be ``None`` where allowed to have the IDL
``null`` value by the DOM specification from the W3C. ``null`` value by the DOM specification from the W3C.
* :keyword:`const` declarations map to variables in their respective scope (e.g. * ``const`` declarations map to variables in their respective scope (e.g.
``xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE``); they must not be changed. ``xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE``); they must not be changed.
* ``DOMException`` is currently not supported in :mod:`xml.dom.minidom`. * ``DOMException`` is currently not supported in :mod:`xml.dom.minidom`.

30
Doc/library/xml.dom.rst
View File

@ -40,13 +40,13 @@ DOM Level 2 recommendation.
package <http://pyxml.sourceforge.net/>`_. Refer to the documentation bundled package <http://pyxml.sourceforge.net/>`_. Refer to the documentation bundled
with that package for information on the current state of DOM Level 3 support. with that package for information on the current state of DOM Level 3 support.
.. % What if your needs are somewhere between SAX and the DOM? Perhaps .. What if your needs are somewhere between SAX and the DOM? Perhaps
.. % you cannot afford to load the entire tree in memory but you find the you cannot afford to load the entire tree in memory but you find the
.. % SAX model somewhat cumbersome and low-level. There is also a module SAX model somewhat cumbersome and low-level. There is also a module
.. % called xml.dom.pulldom that allows you to build trees of only the called xml.dom.pulldom that allows you to build trees of only the
.. % parts of a document that you need structured access to. It also has parts of a document that you need structured access to. It also has
.. % features that allow you to find your way around the DOM. features that allow you to find your way around the DOM.
.. % See http://www.prescod.net/python/pulldom See http://www.prescod.net/python/pulldom
DOM applications typically start by parsing some XML into a DOM. How this is DOM applications typically start by parsing some XML into a DOM. How this is
accomplished is not covered at all by DOM Level 1, and Level 2 provides only accomplished is not covered at all by DOM Level 1, and Level 2 provides only
@ -157,7 +157,7 @@ provided as part of this module does provide the constants used for the
within the class rather than at the module level to conform with the DOM within the class rather than at the module level to conform with the DOM
specifications. specifications.
.. % Should the Node documentation go here? .. Should the Node documentation go here?
.. _dom-objects: .. _dom-objects:
@ -906,7 +906,7 @@ attribute.
This is raised if data is specified for a node which does not support data. This is raised if data is specified for a node which does not support data.
.. % XXX a better explanation is needed! .. XXX a better explanation is needed!
.. exception:: NoModificationAllowedErr .. exception:: NoModificationAllowedErr
@ -919,7 +919,7 @@ attribute.
Raised when an invalid or illegal string is specified. Raised when an invalid or illegal string is specified.
.. % XXX how is this different from InvalidCharacterErr ??? .. XXX how is this different from InvalidCharacterErr?
.. exception:: WrongDocumentErr .. exception:: WrongDocumentErr
@ -1001,8 +1001,8 @@ Additionally, the :class:`DOMString` defined in the recommendation is mapped to
a Python string or Unicode string. Applications should be able to handle a Python string or Unicode string. Applications should be able to handle
Unicode whenever a string is returned from the DOM. Unicode whenever a string is returned from the DOM.
The IDL :keyword:`null` value is mapped to ``None``, which may be accepted or The IDL ``null`` value is mapped to ``None``, which may be accepted or
provided by the implementation whenever :keyword:`null` is allowed by the API. provided by the implementation whenever ``null`` is allowed by the API.
.. _dom-accessor-methods: .. _dom-accessor-methods:
@ -1011,7 +1011,7 @@ Accessor Methods
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
The mapping from OMG IDL to Python defines accessor functions for IDL The mapping from OMG IDL to Python defines accessor functions for IDL
:keyword:`attribute` declarations in much the way the Java mapping does. ``attribute`` declarations in much the way the Java mapping does.
Mapping the IDL declarations :: Mapping the IDL declarations ::
readonly attribute string someValue; readonly attribute string someValue;
@ -1030,13 +1030,13 @@ likely to work, and wrapper objects may be needed on the client if the DOM
objects are accessed via CORBA. While this does require some additional objects are accessed via CORBA. While this does require some additional
consideration for CORBA DOM clients, the implementers with experience using DOM consideration for CORBA DOM clients, the implementers with experience using DOM
over CORBA from Python do not consider this a problem. Attributes that are over CORBA from Python do not consider this a problem. Attributes that are
declared :keyword:`readonly` may not restrict write access in all DOM declared ``readonly`` may not restrict write access in all DOM
implementations. implementations.
In the Python DOM API, accessor functions are not required. If provided, they In the Python DOM API, accessor functions are not required. If provided, they
should take the form defined by the Python IDL mapping, but these methods are should take the form defined by the Python IDL mapping, but these methods are
considered unnecessary since the attributes are accessible directly from Python. considered unnecessary since the attributes are accessible directly from Python.
"Set" accessors should never be provided for :keyword:`readonly` attributes. "Set" accessors should never be provided for ``readonly`` attributes.
The IDL definitions do not fully embody the requirements of the W3C DOM API, The IDL definitions do not fully embody the requirements of the W3C DOM API,
such as the notion of certain objects, such as the return value of such as the notion of certain objects, such as the return value of

2
Doc/library/xml.etree.rst
View File

@ -14,7 +14,7 @@ common components from the ElementTree API library. In the current release,
this package contains the :mod:`ElementTree`, :mod:`ElementPath`, and this package contains the :mod:`ElementTree`, :mod:`ElementPath`, and
:mod:`ElementInclude` modules from the full ElementTree distribution. :mod:`ElementInclude` modules from the full ElementTree distribution.
.. % XXX To be continued! .. XXX To be continued!
.. seealso:: .. seealso::

2
Doc/library/xml.sax.handler.rst
View File

@ -207,7 +207,7 @@ events in the input document:
information to the application to expand prefixes in those contexts itself, if information to the application to expand prefixes in those contexts itself, if
necessary. necessary.
.. % XXX This is not really the default, is it? MvL .. XXX This is not really the default, is it? MvL
Note that :meth:`startPrefixMapping` and :meth:`endPrefixMapping` events are not Note that :meth:`startPrefixMapping` and :meth:`endPrefixMapping` events are not
guaranteed to be properly nested relative to each-other: all guaranteed to be properly nested relative to each-other: all

Some files were not shown because too many files have changed in this diff Show More