Merged revisions 82301 via svnmerge from

svn+ssh://svn.python.org/python/branches/py3k

................
  r82301 | benjamin.peterson | 2010-06-28 00:32:30 +0200 (Mo, 28 Jun 2010) | 303 lines

  Merged revisions 80605-80609,80642-80646,80651-80652,80674,80684-80686,80748,80852,80854,80870,80872-80873,80907,80915-80916,80951-80952,80976-80977,80985,81038-81040,81042,81053,81070,81104-81105,81114,81125,81245,81285,81402,81463,81516,81562-81563,81567,81593,81635,81680-81681,81684,81801,81888,81931-81933,81939-81942,81963,81984,81991,82120,82188,82264-82267 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r80605 | andrew.kuchling | 2010-04-28 19:22:16 -0500 (Wed, 28 Apr 2010) | 1 line

    Add various items
  ........
    r80606 | andrew.kuchling | 2010-04-28 20:44:30 -0500 (Wed, 28 Apr 2010) | 6 lines

    Fix doubled 'the'.
    Markup fixes to use :exc:, :option: in a few places.
      (Glitch: unittest.main's -c ends up a link to the Python
      interpreter's -c option.  Should we skip using :option: for that
      switch, or disable the auto-linking somehow?)
  ........
    r80607 | andrew.kuchling | 2010-04-28 20:45:41 -0500 (Wed, 28 Apr 2010) | 1 line

    Add various unittest items
  ........
    r80608 | benjamin.peterson | 2010-04-28 22:18:05 -0500 (Wed, 28 Apr 2010) | 1 line

    update pypy description
  ........
    r80609 | benjamin.peterson | 2010-04-28 22:30:59 -0500 (Wed, 28 Apr 2010) | 1 line

    update pypy url
  ........
    r80642 | andrew.kuchling | 2010-04-29 19:49:09 -0500 (Thu, 29 Apr 2010) | 1 line

    Always add space after RFC; reword paragraph
  ........
    r80643 | andrew.kuchling | 2010-04-29 19:52:31 -0500 (Thu, 29 Apr 2010) | 6 lines

    Reword paragraph to make its meaning clearer.

    Antoine Pitrou: is my version of the paragraph still correct?

    R. David Murray: is this more understandable than the previous version?
  ........
    r80644 | andrew.kuchling | 2010-04-29 20:02:15 -0500 (Thu, 29 Apr 2010) | 1 line

    Fix typos
  ........
    r80645 | andrew.kuchling | 2010-04-29 20:32:47 -0500 (Thu, 29 Apr 2010) | 1 line

    Markup fix; clarify by adding 'in that order'
  ........
    r80646 | andrew.kuchling | 2010-04-29 20:33:40 -0500 (Thu, 29 Apr 2010) | 1 line

    Add various items; rearrange unittest section a bit
  ........
    r80651 | andrew.kuchling | 2010-04-30 08:46:55 -0500 (Fri, 30 Apr 2010) | 1 line

    Minor grammar re-wording
  ........
    r80652 | andrew.kuchling | 2010-04-30 08:47:34 -0500 (Fri, 30 Apr 2010) | 1 line

    Add item
  ........
    r80674 | andrew.kuchling | 2010-04-30 20:19:16 -0500 (Fri, 30 Apr 2010) | 1 line

    Add various items
  ........
    r80684 | andrew.kuchling | 2010-05-01 07:05:52 -0500 (Sat, 01 May 2010) | 1 line

    Minor grammar fix
  ........
    r80685 | andrew.kuchling | 2010-05-01 07:06:51 -0500 (Sat, 01 May 2010) | 1 line

    Describe memoryview
  ........
    r80686 | antoine.pitrou | 2010-05-01 07:16:39 -0500 (Sat, 01 May 2010) | 4 lines

    Fix attribution. Travis didn't do much and he did a bad work.
    (yes, this is a sensitive subject, sorry)
  ........
    r80748 | andrew.kuchling | 2010-05-03 20:24:22 -0500 (Mon, 03 May 2010) | 1 line

    Add some more items; the urlparse change is added twice
  ........
    r80852 | andrew.kuchling | 2010-05-05 20:09:47 -0500 (Wed, 05 May 2010) | 1 line

    Reword paragraph; fix filename, which should be pyconfig.h
  ........
    r80854 | andrew.kuchling | 2010-05-05 20:10:56 -0500 (Wed, 05 May 2010) | 1 line

    Add various items
  ........
    r80870 | andrew.kuchling | 2010-05-06 09:14:09 -0500 (Thu, 06 May 2010) | 1 line

    Describe ElementTree 1.3; rearrange new-module sections; describe dict views as sets; small edits and items
  ........
    r80872 | andrew.kuchling | 2010-05-06 12:21:59 -0500 (Thu, 06 May 2010) | 1 line

    Add 2 items; record ideas for two initial sections; clarify wording
  ........
    r80873 | andrew.kuchling | 2010-05-06 12:27:57 -0500 (Thu, 06 May 2010) | 1 line

    Change section title; point to unittest2
  ........
    r80907 | andrew.kuchling | 2010-05-06 20:45:14 -0500 (Thu, 06 May 2010) | 1 line

    Add a new section on the development plan; add an item
  ........
    r80915 | antoine.pitrou | 2010-05-07 05:15:51 -0500 (Fri, 07 May 2010) | 3 lines

    Fix some markup and a class name. Also, wrap a long line.
  ........
    r80916 | andrew.kuchling | 2010-05-07 06:30:47 -0500 (Fri, 07 May 2010) | 1 line

    Re-word text
  ........
    r80951 | andrew.kuchling | 2010-05-07 20:15:26 -0500 (Fri, 07 May 2010) | 1 line

    Add two items
  ........
    r80952 | andrew.kuchling | 2010-05-07 20:35:55 -0500 (Fri, 07 May 2010) | 1 line

    Get accents correct
  ........
    r80976 | andrew.kuchling | 2010-05-08 08:28:03 -0500 (Sat, 08 May 2010) | 1 line

    Add logging.dictConfig example; give up on writing a Ttk example
  ........
    r80977 | andrew.kuchling | 2010-05-08 08:29:46 -0500 (Sat, 08 May 2010) | 1 line

    Markup fixes
  ........
    r80985 | andrew.kuchling | 2010-05-08 10:39:46 -0500 (Sat, 08 May 2010) | 7 lines

    Write summary of the 2.7 release; rewrite the future section some more;
    mention PYTHONWARNINGS env. var; tweak some examples for readability.

    And with this commit, the "What's New" is done... except for a
    complete read-through to polish the text, and fixing any reported errors,
    but those tasks can easily wait until after beta2.
  ........
    r81038 | benjamin.peterson | 2010-05-09 16:09:40 -0500 (Sun, 09 May 2010) | 1 line

    finish clause
  ........
    r81039 | andrew.kuchling | 2010-05-10 09:18:27 -0500 (Mon, 10 May 2010) | 1 line

    Markup fix; re-word a sentence
  ........
    r81040 | andrew.kuchling | 2010-05-10 09:20:12 -0500 (Mon, 10 May 2010) | 1 line

    Use title case
  ........
    r81042 | andrew.kuchling | 2010-05-10 10:03:35 -0500 (Mon, 10 May 2010) | 1 line

    Link to unittest2 article
  ........
    r81053 | florent.xicluna | 2010-05-10 14:59:22 -0500 (Mon, 10 May 2010) | 2 lines

    Add a link on maketrans().
  ........
    r81070 | andrew.kuchling | 2010-05-10 18:13:41 -0500 (Mon, 10 May 2010) | 1 line

    Fix typo
  ........
    r81104 | andrew.kuchling | 2010-05-11 19:38:44 -0500 (Tue, 11 May 2010) | 1 line

    Revision pass: lots of edits, typo fixes, rearrangements
  ........
    r81105 | andrew.kuchling | 2010-05-11 19:40:47 -0500 (Tue, 11 May 2010) | 1 line

    Let's call this done
  ........
    r81114 | andrew.kuchling | 2010-05-12 08:56:07 -0500 (Wed, 12 May 2010) | 1 line

    Grammar fix
  ........
    r81125 | andrew.kuchling | 2010-05-12 13:56:48 -0500 (Wed, 12 May 2010) | 1 line

    #8696: add documentation for logging.config.dictConfig (PEP 391)
  ........
    r81245 | andrew.kuchling | 2010-05-16 18:31:16 -0500 (Sun, 16 May 2010) | 1 line

    Add cross-reference to later section
  ........
    r81285 | vinay.sajip | 2010-05-18 03:16:27 -0500 (Tue, 18 May 2010) | 1 line

    Fixed minor typo in ReST markup.
  ........
    r81402 | vinay.sajip | 2010-05-21 12:41:34 -0500 (Fri, 21 May 2010) | 1 line

    Updated logging documentation with more dictConfig information.
  ........
    r81463 | georg.brandl | 2010-05-22 03:17:23 -0500 (Sat, 22 May 2010) | 1 line

    #8785: less confusing description of regex.find*.
  ........
    r81516 | andrew.kuchling | 2010-05-25 08:34:08 -0500 (Tue, 25 May 2010) | 1 line

    Add three items
  ........
    r81562 | andrew.kuchling | 2010-05-27 08:22:53 -0500 (Thu, 27 May 2010) | 1 line

    Rewrite wxWidgets section
  ........
    r81563 | andrew.kuchling | 2010-05-27 08:30:09 -0500 (Thu, 27 May 2010) | 1 line

    Remove top-level 'General Questions' section, pushing up the questions it contains
  ........
    r81567 | andrew.kuchling | 2010-05-27 16:29:59 -0500 (Thu, 27 May 2010) | 1 line

    Add item
  ........
    r81593 | georg.brandl | 2010-05-29 03:46:18 -0500 (Sat, 29 May 2010) | 1 line

    #8616: add new turtle demo "nim".
  ........
    r81635 | georg.brandl | 2010-06-01 02:25:23 -0500 (Tue, 01 Jun 2010) | 1 line

    Put docs for RegexObject.search() before RegexObject.match() to mirror re.search() and re.match() order.
  ........
    r81680 | vinay.sajip | 2010-06-03 17:34:42 -0500 (Thu, 03 Jun 2010) | 1 line

    Issue #8890: Documentation changed to avoid reference to temporary files.
  ........
    r81681 | sean.reifschneider | 2010-06-03 20:51:26 -0500 (Thu, 03 Jun 2010) | 2 lines

    Issue8810: Clearing up docstring for tzinfo.utcoffset.
  ........
    r81684 | vinay.sajip | 2010-06-04 08:41:02 -0500 (Fri, 04 Jun 2010) | 1 line

    Issue #8890: Documentation changed to avoid reference to temporary files - other cases covered.
  ........
    r81801 | andrew.kuchling | 2010-06-07 08:38:40 -0500 (Mon, 07 Jun 2010) | 1 line

    #8875: Remove duplicated paragraph
  ........
    r81888 | andrew.kuchling | 2010-06-10 20:54:58 -0500 (Thu, 10 Jun 2010) | 1 line

    Add a few more items
  ........
    r81931 | georg.brandl | 2010-06-12 01:26:54 -0500 (Sat, 12 Jun 2010) | 1 line

    Fix punctuation.
  ........
    r81932 | georg.brandl | 2010-06-12 01:28:58 -0500 (Sat, 12 Jun 2010) | 1 line

    Document that an existing directory raises in mkdir().
  ........
    r81933 | georg.brandl | 2010-06-12 01:45:33 -0500 (Sat, 12 Jun 2010) | 1 line

    Update version in README.
  ........
    r81939 | georg.brandl | 2010-06-12 04:45:01 -0500 (Sat, 12 Jun 2010) | 1 line

    Use newer toctree syntax.
  ........
    r81940 | georg.brandl | 2010-06-12 04:45:28 -0500 (Sat, 12 Jun 2010) | 1 line

    Add document on how to build.
  ........
    r81941 | georg.brandl | 2010-06-12 04:45:58 -0500 (Sat, 12 Jun 2010) | 1 line

    Fix gratuitous indentation.
  ........
    r81942 | georg.brandl | 2010-06-12 04:46:03 -0500 (Sat, 12 Jun 2010) | 1 line

    Update README.
  ........
    r81963 | andrew.kuchling | 2010-06-12 15:00:55 -0500 (Sat, 12 Jun 2010) | 1 line

    Grammar fix
  ........
    r81984 | georg.brandl | 2010-06-14 10:58:39 -0500 (Mon, 14 Jun 2010) | 1 line

    #8993: fix reference.
  ........
    r81991 | andrew.kuchling | 2010-06-14 19:38:58 -0500 (Mon, 14 Jun 2010) | 1 line

    Add another bunch of items
  ........
    r82120 | andrew.kuchling | 2010-06-20 16:45:45 -0500 (Sun, 20 Jun 2010) | 1 line

    Note that Python 3.x isn't covered; add forward ref. for UTF-8; note error in 2.5 and up
  ........
    r82188 | benjamin.peterson | 2010-06-23 19:02:46 -0500 (Wed, 23 Jun 2010) | 1 line

    remove reverted changed
  ........
    r82264 | georg.brandl | 2010-06-27 05:47:47 -0500 (Sun, 27 Jun 2010) | 1 line

    Confusing punctuation.
  ........
    r82265 | georg.brandl | 2010-06-27 05:49:23 -0500 (Sun, 27 Jun 2010) | 1 line

    Use designated syntax for optional grammar element.
  ........
    r82266 | georg.brandl | 2010-06-27 05:51:44 -0500 (Sun, 27 Jun 2010) | 1 line

    Fix URL.
  ........
    r82267 | georg.brandl | 2010-06-27 05:55:38 -0500 (Sun, 27 Jun 2010) | 1 line

    Two typos.
  ........
................
This commit is contained in:
Georg Brandl 2010-07-11 10:41:07 +00:00
parent 725443fef9
commit c62efa87f6
26 changed files with 2286 additions and 374 deletions

View file

@ -14,12 +14,11 @@ those familiar with the previous docs written in LaTeX.
Building the docs Building the docs
================= =================
You need to install Python 2.4 or higher (but Python 3.0 is not supported yet); You need to have Python 2.4 or higher installed; the toolset used to build the
the toolset used to build the docs are written in Python. The toolset used docs is written in Python. It is called *Sphinx*, it is not included in this
to build the documentation is called *Sphinx*, it is not included in this tree, but maintained separately. Also needed are the docutils, supplying the
tree, but maintained separately in the Python Subversion repository. Also base markup that Sphinx uses, Jinja, a templating engine, and optionally
needed are Jinja, a templating engine (included in Sphinx as a Subversion Pygments, a code highlighter.
external), and optionally Pygments, a code highlighter.
Using make Using make
@ -47,29 +46,29 @@ Available make targets are:
convert them into a single Compiled HTML (.chm) file -- these are popular convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform. under Microsoft Windows, but very handy on every platform.
To create the CHM file, you need to run the Microsoft HTML Help Workshop To create the CHM file, you need to run the Microsoft HTML Help Workshop over
over the generated project (.hhp) file. the generated project (.hhp) file.
* "latex", which builds LaTeX source files that can be run with "pdflatex" * "latex", which builds LaTeX source files as input to "pdflatex" to produce
to produce PDF documents. PDF documents.
* "text", which builds a plain text file for each source file. * "text", which builds a plain text file for each source file.
* "linkcheck", which checks all external references to see whether they are * "linkcheck", which checks all external references to see whether they are
broken, redirected or malformed, and outputs this information to stdout broken, redirected or malformed, and outputs this information to stdout as
as well as a plain-text (.txt) file. well as a plain-text (.txt) file.
* "changes", which builds an overview over all versionadded/versionchanged/ * "changes", which builds an overview over all versionadded/versionchanged/
deprecated items in the current version. This is meant as a help for the deprecated items in the current version. This is meant as a help for the
writer of the "What's New" document. writer of the "What's New" document.
* "coverage", which builds a coverage overview for standard library modules * "coverage", which builds a coverage overview for standard library modules and
and C API. C API.
* "pydoc-topics", which builds a Python module containing a dictionary * "pydoc-topics", which builds a Python module containing a dictionary with
with plain text documentation for the labels defined in plain text documentation for the labels defined in
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
and keyword help. keyword help.
A "make update" updates the Subversion checkouts in `tools/`. A "make update" updates the Subversion checkouts in `tools/`.

View file

@ -392,7 +392,7 @@ Initialization, Finalization, and Threads
.. cfunction:: void PySys_SetArgv(int argc, wchar_t **argv) .. cfunction:: void PySys_SetArgv(int argc, wchar_t **argv)
This function works like :cfunc:`PySys_SetArgv` with *updatepath* set to 1. This function works like :cfunc:`PySys_SetArgvEx` with *updatepath* set to 1.
.. cfunction:: void Py_SetPythonHome(wchar_t *home) .. cfunction:: void Py_SetPythonHome(wchar_t *home)

View file

@ -321,7 +321,7 @@ the :option:`--no-target-compile` and/or the :option:`--no-target-optimize`
option. option.
By default the installer will display the cool "Python Powered" logo when it is By default the installer will display the cool "Python Powered" logo when it is
run, but you can also supply your own 152x161 bitmap which must be a Windows run, but you can also supply your own 152x261 bitmap which must be a Windows
:file:`.bmp` file with the :option:`--bitmap` option. :file:`.bmp` file with the :option:`--bitmap` option.
The installer will also display a large title on the desktop background window The installer will also display a large title on the desktop background window
@ -374,7 +374,7 @@ check or modify your existing install.)
The Postinstallation script The Postinstallation script
--------------------------- ---------------------------
Starting with Python 2.3, a postinstallation script can be specified which the Starting with Python 2.3, a postinstallation script can be specified with the
:option:`--install-script` option. The basename of the script must be :option:`--install-script` option. The basename of the script must be
specified, and the script filename must also be listed in the scripts argument specified, and the script filename must also be listed in the scripts argument
to the setup function. to the setup function.

View file

@ -0,0 +1,91 @@
Building the documentation
==========================
You need to have Python 2.4 or higher installed; the toolset used to build the
docs is written in Python. It is called *Sphinx*, it is not included in this
tree, but maintained separately. Also needed are the docutils, supplying the
base markup that Sphinx uses, Jinja, a templating engine, and optionally
Pygments, a code highlighter.
Using make
----------
Luckily, a Makefile has been prepared so that on Unix, provided you have
installed Python and Subversion, you can just run ::
make html
to check out the necessary toolset in the `tools/` subdirectory and build the
HTML output files. To view the generated HTML, point your favorite browser at
the top-level index `build/html/index.html` after running "make".
Available make targets are:
* "html", which builds standalone HTML files for offline viewing.
* "htmlhelp", which builds HTML files and a HTML Help project file usable to
convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform.
To create the CHM file, you need to run the Microsoft HTML Help Workshop
over the generated project (.hhp) file.
* "latex", which builds LaTeX source files as input to "pdflatex" to produce
PDF documents.
* "text", which builds a plain text file for each source file.
* "linkcheck", which checks all external references to see whether they are
broken, redirected or malformed, and outputs this information to stdout
as well as a plain-text (.txt) file.
* "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.
* "coverage", which builds a coverage overview for standard library modules
and C API.
* "pydoc-topics", which builds a Python module containing a dictionary with
plain text documentation for the labels defined in
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
keyword help.
A "make update" updates the Subversion checkouts in `tools/`.
Without make
------------
You'll need to install the Sphinx package, either by checking it out via ::
svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx
or by installing it from PyPI.
Then, you need to install Docutils, either by checking it out via ::
svn co http://svn.python.org/projects/external/docutils-0.6/docutils tools/docutils
or by installing it from http://docutils.sf.net/.
You also need Jinja2, either by checking it out via ::
svn co http://svn.python.org/projects/external/Jinja-2.3.1/jinja2 tools/jinja2
or by installing it from PyPI.
You can optionally also install Pygments, either as a checkout via ::
svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments
or from PyPI at http://pypi.python.org/pypi/Pygments.
Then, make an output directory, e.g. under `build/`, and run ::
python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see
the make targets above).

View file

@ -10,9 +10,9 @@ contributed by various authors. The markup used for the Python documentation is
`reStructuredText`_, developed by the `docutils`_ project, amended by custom `reStructuredText`_, developed by the `docutils`_ project, amended by custom
directives and using a toolset named `Sphinx`_ to postprocess the HTML output. directives and using a toolset named `Sphinx`_ to postprocess the HTML output.
This document describes the style guide for our documentation, the custom This document describes the style guide for our documentation as well as the
reStructuredText markup introduced to support Python documentation and how it custom reStructuredText markup introduced by Sphinx to support Python
should be used, as well as the Sphinx build system. documentation and how it should be used.
.. _reStructuredText: http://docutils.sf.net/rst.html .. _reStructuredText: http://docutils.sf.net/rst.html
.. _docutils: http://docutils.sf.net/ .. _docutils: http://docutils.sf.net/
@ -35,3 +35,4 @@ should be used, as well as the Sphinx build system.
rest.rst rest.rst
markup.rst markup.rst
fromlatex.rst fromlatex.rst
building.rst

View file

@ -698,10 +698,10 @@ tables of contents. The ``toctree`` directive is the central element.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
intro.rst intro
strings.rst strings
datatypes.rst datatypes
numeric.rst numeric
(many more files listed here) (many more files listed here)
This accomplishes two things: This accomplishes two things:
@ -709,8 +709,8 @@ tables of contents. The ``toctree`` directive is the central element.
* Tables of contents from all those files are inserted, with a maximum depth * Tables of contents from all those files are inserted, with a maximum depth
of two, that means one nested heading. ``toctree`` directives in those of two, that means one nested heading. ``toctree`` directives in those
files are also taken into account. files are also taken into account.
* Sphinx knows that the relative order of the files ``intro.rst``, * Sphinx knows that the relative order of the files ``intro``,
``strings.rst`` and so forth, and it knows that they are children of the ``strings`` and so forth, and it knows that they are children of the
shown file, the library index. From this information it generates "next shown file, the library index. From this information it generates "next
chapter", "previous chapter" and "parent chapter" links. chapter", "previous chapter" and "parent chapter" links.

View file

@ -7,7 +7,7 @@ The Python documentation should follow the `Apple Publications Style Guide`_
wherever possible. This particular style guide was selected mostly because it wherever possible. This particular style guide was selected mostly because it
seems reasonable and is easy to get online. seems reasonable and is easy to get online.
Topics which are not covered in the Apple's style guide will be discussed in Topics which are not covered in Apple's style guide will be discussed in
this document. this document.
All reST files use an indentation of 3 spaces. The maximum line length is 80 All reST files use an indentation of 3 spaces. The maximum line length is 80

View file

@ -10,14 +10,14 @@ General GUI Questions
===================== =====================
What platform-independent GUI toolkits exist for Python? What platform-independent GUI toolkits exist for Python?
-------------------------------------------------------- ========================================================
Depending on what platform(s) you are aiming at, there are several. Depending on what platform(s) you are aiming at, there are several.
.. XXX check links .. XXX check links
Tkinter Tkinter
''''''' -------
Standard builds of Python include an object-oriented interface to the Tcl/Tk Standard builds of Python include an object-oriented interface to the Tcl/Tk
widget set, called Tkinter. This is probably the easiest to install and use. widget set, called Tkinter. This is probably the easiest to install and use.
@ -26,23 +26,26 @@ page at http://www.tcl.tk. Tcl/Tk is fully portable to the MacOS, Windows, and
Unix platforms. Unix platforms.
wxWindows wxWindows
''''''''' ---------
wxWindows is a portable GUI class library written in C++ that's a portable wxWidgets (http://www.wxwidgets.org) is a free, portable GUI class
interface to various platform-specific libraries; wxWidgets is a Python library written in C++ that provides a native look and feel on a
interface to wxWindows. wxWindows supports Windows and MacOS; on Unix variants, number of platforms, with Windows, MacOS X, GTK, X11, all listed as
it supports both GTk+ and Motif toolkits. wxWindows preserves the look and feel current stable targets. Language bindings are available for a number
of the underlying graphics toolkit, and there is quite a rich widget set and of languages including Python, Perl, Ruby, etc.
collection of GDI classes. See `the wxWindows page <http://www.wxwindows.org>`_
for more details.
`wxWidgets <http://wxwidgets.org>`_ is an extension module that wraps many of wxPython (http://www.wxpython.org) is the Python binding for
the wxWindows C++ classes, and is quickly gaining popularity amongst Python wxwidgets. While it often lags slightly behind the official wxWidgets
developers. You can get wxWidgets as part of the source or CVS distribution of releases, it also offers a number of features via pure Python
wxWindows, or directly from its home page. extensions that are not available in other language bindings. There
is an active wxPython user and developer community.
Both wxWidgets and wxPython are free, open source, software with
permissive licences that allow their use in commercial products as
well as in freeware or shareware.
Qt Qt
''' ---
There are bindings available for the Qt toolkit (`PyQt There are bindings available for the Qt toolkit (`PyQt
<http://www.riverbankcomputing.co.uk/software/pyqt/>`_) and for KDE (PyKDE). If <http://www.riverbankcomputing.co.uk/software/pyqt/>`_) and for KDE (PyKDE). If
@ -53,13 +56,13 @@ Qt 4.5 upwards is licensed under the LGPL license) a Qt license from `Trolltech
<http://www.trolltech.com>`_. <http://www.trolltech.com>`_.
Gtk+ Gtk+
'''' ----
PyGtk bindings for the `Gtk+ toolkit <http://www.gtk.org>`_ have been PyGtk bindings for the `Gtk+ toolkit <http://www.gtk.org>`_ have been
implemented by by James Henstridge; see ftp://ftp.gtk.org/pub/gtk/python/. implemented by by James Henstridge; see ftp://ftp.gtk.org/pub/gtk/python/.
FLTK FLTK
'''' ----
Python bindings for `the FLTK toolkit <http://www.fltk.org>`_, a simple yet Python bindings for `the FLTK toolkit <http://www.fltk.org>`_, a simple yet
powerful and mature cross-platform windowing system, are available from `the powerful and mature cross-platform windowing system, are available from `the
@ -67,7 +70,7 @@ PyFLTK project <http://pyfltk.sourceforge.net>`_.
FOX FOX
''' ----
A wrapper for `the FOX toolkit <http://www.fox-toolkit.org/>`_ called `FXpy A wrapper for `the FOX toolkit <http://www.fox-toolkit.org/>`_ called `FXpy
<http://fxpy.sourceforge.net/>`_ is available. FOX supports both Unix variants <http://fxpy.sourceforge.net/>`_ is available. FOX supports both Unix variants
@ -75,13 +78,13 @@ and Windows.
OpenGL OpenGL
'''''' ------
For OpenGL bindings, see `PyOpenGL <http://pyopengl.sourceforge.net>`_. For OpenGL bindings, see `PyOpenGL <http://pyopengl.sourceforge.net>`_.
What platform-specific GUI toolkits exist for Python? What platform-specific GUI toolkits exist for Python?
----------------------------------------------------- ========================================================
`The Mac port <http://python.org/download/mac>`_ by Jack Jansen has a rich and `The Mac port <http://python.org/download/mac>`_ by Jack Jansen has a rich and
ever-growing set of modules that support the native Mac toolbox calls. The port ever-growing set of modules that support the native Mac toolbox calls. The port

View file

@ -5,9 +5,6 @@
:Author: A. M. Kuchling :Author: A. M. Kuchling
:Release: 0.31 :Release: 0.31
(This is a first draft. Please send comments/error reports/suggestions to
amk@amk.ca.)
In this document, we'll take a tour of Python's features suitable for In this document, we'll take a tour of Python's features suitable for
implementing programs in a functional style. After an introduction to the implementing programs in a functional style. After an introduction to the
concepts of functional programming, we'll look at language features such as concepts of functional programming, we'll look at language features such as

View file

@ -4,10 +4,12 @@
Unicode HOWTO Unicode HOWTO
***************** *****************
:Release: 1.1 :Release: 1.11
This HOWTO discusses Python's support for Unicode, and explains various problems This HOWTO discusses Python 2.x's support for Unicode, and explains
that people commonly encounter when trying to work with Unicode. various problems that people commonly encounter when trying to work
with Unicode. (This HOWTO has not yet been updated to cover the 3.x
versions of Python.)
Introduction to Unicode Introduction to Unicode
@ -146,8 +148,9 @@ problems.
4. Many Internet standards are defined in terms of textual data, and can't 4. Many Internet standards are defined in terms of textual data, and can't
handle content with embedded zero bytes. handle content with embedded zero bytes.
Generally people don't use this encoding, instead choosing other encodings that Generally people don't use this encoding, instead choosing other
are more efficient and convenient. encodings that are more efficient and convenient. UTF-8 is probably
the most commonly supported encoding; it will be discussed below.
Encodings don't have to handle every possible Unicode character, and most Encodings don't have to handle every possible Unicode character, and most
encodings don't. The rules for converting a Unicode string into the ASCII encodings don't. The rules for converting a Unicode string into the ASCII
@ -223,8 +226,8 @@ Wikipedia entries are often helpful; see the entries for "character encoding"
<http://en.wikipedia.org/wiki/UTF-8>, for example. <http://en.wikipedia.org/wiki/UTF-8>, for example.
Python's Unicode Support Python 2.x's Unicode Support
======================== ============================
Now that you've learned the rudiments of Unicode, we can look at Python's Now that you've learned the rudiments of Unicode, we can look at Python's
Unicode features. Unicode features.
@ -266,8 +269,8 @@ Unicode result). The following examples show the differences::
>>> b'\x80abc'.decode("utf-8", "ignore") >>> b'\x80abc'.decode("utf-8", "ignore")
'abc' 'abc'
Encodings are specified as strings containing the encoding's name. Python comes Encodings are specified as strings containing the encoding's name. Python 3.2
with roughly 100 different encodings; see the Python Library Reference at comes with roughly 100 different encodings; see the Python Library Reference at
:ref:`standard-encodings` for a list. Some encodings have multiple names; for :ref:`standard-encodings` for a list. Some encodings have multiple names; for
example, 'latin-1', 'iso_8859_1' and '8859' are all synonyms for the same example, 'latin-1', 'iso_8859_1' and '8859' are all synonyms for the same
encoding. encoding.
@ -626,7 +629,10 @@ Version 1.02: posted August 16 2005. Corrects factual errors.
Version 1.1: Feb-Nov 2008. Updates the document with respect to Python 3 changes. Version 1.1: Feb-Nov 2008. Updates the document with respect to Python 3 changes.
Version 1.11: posted June 20 2010. Notes that Python 3.x is not covered,
and that the HOWTO only covers 2.x.
.. comment Describe Python 3.x support (new section? new document?)
.. comment Additional topic: building Python w/ UCS2 or UCS4 support .. comment Additional topic: building Python w/ UCS2 or UCS4 support
.. comment Describe use of codecs.StreamRecoder and StreamReaderWriter .. comment Describe use of codecs.StreamRecoder and StreamReaderWriter

View file

@ -15,7 +15,7 @@ the week to Sunday (6) or to any other weekday. Parameters that specify dates
are given as integers. For related are given as integers. For related
functionality, see also the :mod:`datetime` and :mod:`time` modules. functionality, see also the :mod:`datetime` and :mod:`time` modules.
Most of these functions and classses rely on the :mod:`datetime` module which Most of these functions and classes rely on the :mod:`datetime` module which
uses an idealized calendar, the current Gregorian calendar indefinitely extended uses an idealized calendar, the current Gregorian calendar indefinitely extended
in both directions. This matches the definition of the "proleptic Gregorian" in both directions. This matches the definition of the "proleptic Gregorian"
calendar in Dershowitz and Reingold's book "Calendrical Calculations", where calendar in Dershowitz and Reingold's book "Calendrical Calculations", where

View file

@ -53,10 +53,12 @@ Simple examples
Most applications are probably going to want to log to a file, so let's start Most applications are probably going to want to log to a file, so let's start
with that case. Using the :func:`basicConfig` function, we can set up the with that case. Using the :func:`basicConfig` function, we can set up the
default handler so that debug messages are written to a file:: default handler so that debug messages are written to a file (in the example,
we assume that you have the appropriate permissions to create a file called
*example.log* in the current directory)::
import logging import logging
LOG_FILENAME = '/tmp/logging_example.out' LOG_FILENAME = 'example.log'
logging.basicConfig(filename=LOG_FILENAME,level=logging.DEBUG) logging.basicConfig(filename=LOG_FILENAME,level=logging.DEBUG)
logging.debug('This message should go to the log file') logging.debug('This message should go to the log file')
@ -75,7 +77,7 @@ yourself, though, it is simpler to use a :class:`RotatingFileHandler`::
import logging import logging
import logging.handlers import logging.handlers
LOG_FILENAME = '/tmp/logging_rotatingfile_example.out' LOG_FILENAME = 'logging_rotatingfile_example.out'
# Set up a specific logger with our desired output level # Set up a specific logger with our desired output level
my_logger = logging.getLogger('MyLogger') my_logger = logging.getLogger('MyLogger')
@ -100,14 +102,14 @@ yourself, though, it is simpler to use a :class:`RotatingFileHandler`::
The result should be 6 separate files, each with part of the log history for the The result should be 6 separate files, each with part of the log history for the
application:: application::
/tmp/logging_rotatingfile_example.out logging_rotatingfile_example.out
/tmp/logging_rotatingfile_example.out.1 logging_rotatingfile_example.out.1
/tmp/logging_rotatingfile_example.out.2 logging_rotatingfile_example.out.2
/tmp/logging_rotatingfile_example.out.3 logging_rotatingfile_example.out.3
/tmp/logging_rotatingfile_example.out.4 logging_rotatingfile_example.out.4
/tmp/logging_rotatingfile_example.out.5 logging_rotatingfile_example.out.5
The most current file is always :file:`/tmp/logging_rotatingfile_example.out`, The most current file is always :file:`logging_rotatingfile_example.out`,
and each time it reaches the size limit it is renamed with the suffix and each time it reaches the size limit it is renamed with the suffix
``.1``. Each of the existing backup files is renamed to increment the suffix ``.1``. Each of the existing backup files is renamed to increment the suffix
(``.1`` becomes ``.2``, etc.) and the ``.6`` file is erased. (``.1`` becomes ``.2``, etc.) and the ``.6`` file is erased.
@ -1039,14 +1041,14 @@ destination can be easily changed, as shown in the example below::
logging.basicConfig(level=logging.DEBUG, logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s %(levelname)s %(message)s', format='%(asctime)s %(levelname)s %(message)s',
filename='/tmp/myapp.log', filename='myapp.log',
filemode='w') filemode='w')
logging.debug('A debug message') logging.debug('A debug message')
logging.info('Some information') logging.info('Some information')
logging.warning('A shot across the bows') logging.warning('A shot across the bows')
The :meth:`basicConfig` method is used to change the configuration defaults, The :meth:`basicConfig` method is used to change the configuration defaults,
which results in output (written to ``/tmp/myapp.log``) which should look which results in output (written to ``myapp.log``) which should look
something like the following:: something like the following::
2004-07-02 13:00:08,743 DEBUG A debug message 2004-07-02 13:00:08,743 DEBUG A debug message

View file

@ -1003,7 +1003,8 @@ Files and Directories
Create a directory named *path* with numeric mode *mode*. The default *mode* Create a directory named *path* with numeric mode *mode*. The default *mode*
is ``0o777`` (octal). On some systems, *mode* is ignored. Where it is used, is ``0o777`` (octal). On some systems, *mode* is ignored. Where it is used,
the current umask value is first masked out. the current umask value is first masked out. If the directory already
exists, :exc:`OSError` is raised.
It is also possible to create temporary directories; see the It is also possible to create temporary directories; see the
:mod:`tempfile` module's :func:`tempfile.mkdtemp` function. :mod:`tempfile` module's :func:`tempfile.mkdtemp` function.

View file

@ -714,18 +714,12 @@ Regular Expression Objects
The :class:`RegexObject` class supports the following methods and attributes: The :class:`RegexObject` class supports the following methods and attributes:
.. method:: RegexObject.search(string[, pos[, endpos]])
.. method:: RegexObject.match(string[, pos[, endpos]]) Scan through *string* looking for a location where this regular expression
produces a match, and return a corresponding :class:`MatchObject` instance.
If zero or more characters at the beginning of *string* match this regular Return ``None`` if no position in the string matches the pattern; note that this
expression, return a corresponding :class:`MatchObject` instance. Return is different from finding a zero-length match at some point in the string.
``None`` if the string does not match the pattern; note that this is different
from a zero-length match.
.. note::
If you want to locate a match anywhere in *string*, use
:meth:`~RegexObject.search` instead.
The optional second parameter *pos* gives an index in the string where the The optional second parameter *pos* gives an index in the string where the
search is to start; it defaults to ``0``. This is not completely equivalent to search is to start; it defaults to ``0``. This is not completely equivalent to
@ -737,24 +731,34 @@ Regular Expression Objects
will be as if the string is *endpos* characters long, so only the characters will be as if the string is *endpos* characters long, so only the characters
from *pos* to ``endpos - 1`` will be searched for a match. If *endpos* is less from *pos* to ``endpos - 1`` will be searched for a match. If *endpos* is less
than *pos*, no match will be found, otherwise, if *rx* is a compiled regular than *pos*, no match will be found, otherwise, if *rx* is a compiled regular
expression object, ``rx.match(string, 0, 50)`` is equivalent to expression object, ``rx.search(string, 0, 50)`` is equivalent to
``rx.match(string[:50], 0)``. ``rx.search(string[:50], 0)``.
>>> pattern = re.compile("o") >>> pattern = re.compile("d")
>>> pattern.match("dog") # No match as "o" is not at the start of "dog." >>> pattern.search("dog") # Match at index 0
>>> pattern.match("dog", 1) # Match as "o" is the 2nd character of "dog".
<_sre.SRE_Match object at ...> <_sre.SRE_Match object at ...>
>>> pattern.search("dog", 1) # No match; search doesn't include the "d"
.. method:: RegexObject.search(string[, pos[, endpos]]) .. method:: RegexObject.match(string[, pos[, endpos]])
Scan through *string* looking for a location where this regular expression If zero or more characters at the *beginning* of *string* match this regular
produces a match, and return a corresponding :class:`MatchObject` instance. expression, return a corresponding :class:`MatchObject` instance. Return
Return ``None`` if no position in the string matches the pattern; note that this ``None`` if the string does not match the pattern; note that this is different
is different from finding a zero-length match at some point in the string. from a zero-length match.
The optional *pos* and *endpos* parameters have the same meaning as for the The optional *pos* and *endpos* parameters have the same meaning as for the
:meth:`~RegexObject.match` method. :meth:`~RegexObject.search` method.
.. note::
If you want to locate a match anywhere in *string*, use
:meth:`~RegexObject.search` instead.
>>> pattern = re.compile("o")
>>> pattern.match("dog") # No match as "o" is not at the start of "dog".
>>> pattern.match("dog", 1) # Match as "o" is the 2nd character of "dog".
<_sre.SRE_Match object at ...>
.. method:: RegexObject.split(string[, maxsplit=0]) .. method:: RegexObject.split(string[, maxsplit=0])
@ -764,12 +768,16 @@ Regular Expression Objects
.. method:: RegexObject.findall(string[, pos[, endpos]]) .. method:: RegexObject.findall(string[, pos[, endpos]])
Identical to the :func:`findall` function, using the compiled pattern. Similar to the :func:`findall` function, using the compiled pattern, but
also accepts optional *pos* and *endpos* parameters that limit the search
region like for :meth:`match`.
.. method:: RegexObject.finditer(string[, pos[, endpos]]) .. method:: RegexObject.finditer(string[, pos[, endpos]])
Identical to the :func:`finditer` function, using the compiled pattern. Similar to the :func:`finditer` function, using the compiled pattern, but
also accepts optional *pos* and *endpos* parameters that limit the search
region like for :meth:`match`.
.. method:: RegexObject.sub(repl, string[, count=0]) .. method:: RegexObject.sub(repl, string[, count=0])

View file

@ -85,6 +85,9 @@ tuple, and the fields depend on the address type. The general tuple form is
If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
reference, and *v3* should be set to 0. reference, and *v3* should be set to 0.
If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
reference, and *v3* should be set to 0.
All errors raise exceptions. The normal exceptions for invalid argument types All errors raise exceptions. The normal exceptions for invalid argument types
and out-of-memory conditions can be raised; errors related to socket or address and out-of-memory conditions can be raised; errors related to socket or address
@ -684,7 +687,7 @@ correspond to Unix system calls applicable to sockets.
Set a timeout on blocking socket operations. The *value* argument can be a Set a timeout on blocking socket operations. The *value* argument can be a
nonnegative float expressing seconds, or ``None``. If a float is given, nonnegative float expressing seconds, or ``None``. If a float is given,
subsequent socket operations will raise an :exc:`timeout` exception if the subsequent socket operations will raise a :exc:`timeout` exception if the
timeout period *value* has elapsed before the operation has completed. Setting timeout period *value* has elapsed before the operation has completed. Setting
a timeout of ``None`` disables timeouts on socket operations. a timeout of ``None`` disables timeouts on socket operations.
``s.settimeout(0.0)`` is equivalent to ``s.setblocking(0)``; ``s.settimeout(0.0)`` is equivalent to ``s.setblocking(0)``;

View file

@ -1162,6 +1162,10 @@ functions based on regular expressions.
You can use :meth:`str.maketrans` to create a translation map from You can use :meth:`str.maketrans` to create a translation map from
character-to-character mappings in different formats. character-to-character mappings in different formats.
You can use the :func:`~string.maketrans` helper function in the :mod:`string`
module to create a translation table. For string objects, set the *table*
argument to ``None`` for translations that only delete characters:
.. note:: .. note::
An even more flexible approach is to create a custom character mapping An even more flexible approach is to create a custom character mapping

View file

@ -197,7 +197,7 @@ The grammar for a replacement field is as follows:
.. productionlist:: sf .. productionlist:: sf
replacement_field: "{" [`field_name`] ["!" `conversion`] [":" `format_spec`] "}" replacement_field: "{" [`field_name`] ["!" `conversion`] [":" `format_spec`] "}"
field_name: arg_name ("." `attribute_name` | "[" `element_index` "]")* field_name: arg_name ("." `attribute_name` | "[" `element_index` "]")*
arg_name: (`identifier` | `integer`)? arg_name: [`identifier` | `integer`]
attribute_name: `identifier` attribute_name: `identifier`
element_index: `integer` | `index_string` element_index: `integer` | `index_string`
index_string: <any source character except "]"> + index_string: <any source character except "]"> +

View file

@ -1413,5 +1413,5 @@ Loading and running tests
Calling ``main`` actually returns an instance of the ``TestProgram`` class. Calling ``main`` actually returns an instance of the ``TestProgram`` class.
This stores the result of the tests run as the ``result`` attribute. This stores the result of the tests run as the ``result`` attribute.
.. versionchanged:: 3.2 .. versionchanged:: 3.1
The ``exit`` parameter was added. The ``exit`` parameter was added.

View file

@ -1596,7 +1596,7 @@ The following methods are used to override the default behavior of the
In particular, the metaclass :class:`abc.ABCMeta` implements these methods in In particular, the metaclass :class:`abc.ABCMeta` implements these methods in
order to allow the addition of Abstract Base Classes (ABCs) as "virtual base order to allow the addition of Abstract Base Classes (ABCs) as "virtual base
classes" to any class or type (including built-in types), and including to other classes" to any class or type (including built-in types), including other
ABCs. ABCs.
.. method:: class.__instancecheck__(self, instance) .. method:: class.__instancecheck__(self, instance)
@ -1615,7 +1615,7 @@ ABCs.
Note that these methods are looked up on the type (metaclass) of a class. They Note that these methods are looked up on the type (metaclass) of a class. They
cannot be defined as class methods in the actual class. This is consistent with cannot be defined as class methods in the actual class. This is consistent with
the lookup of special methods that are called on instances, only that in this the lookup of special methods that are called on instances, only in this
case the instance is itself a class. case the instance is itself a class.
.. seealso:: .. seealso::

View file

@ -69,12 +69,12 @@ IronPython
more information, see `the IronPython website <http://www.ironpython.com/>`_. more information, see `the IronPython website <http://www.ironpython.com/>`_.
PyPy PyPy
An implementation of Python written in Python; even the bytecode interpreter is An implementation of Python written completely in Python. It supports several
written in Python. This is executed using CPython as the underlying advanced features not found in other implementations like stackless support
interpreter. One of the goals of the project is to encourage experimentation and a Just in Time compiler. One of the goals of the project is to encourage
with the language itself by making it easier to modify the interpreter (since it experimentation with the language itself by making it easier to modify the
is written in Python). Additional information is available on `the PyPy interpreter (since it is written in Python). Additional information is
project's home page <http://codespeak.net/pypy/>`_. available on `the PyPy project's home page <http://pypy.org/>`_.
Each of these implementations varies in some way from the language as documented Each of these implementations varies in some way from the language as documented
in this manual, or introduces specific information beyond what's covered in the in this manual, or introduces specific information beyond what's covered in the

View file

@ -580,7 +580,7 @@ Private Variables
================= =================
"Private" instance variables that cannot be accessed except from inside an "Private" instance variables that cannot be accessed except from inside an
object, don't exist in Python. However, there is a convention that is followed object don't exist in Python. However, there is a convention that is followed
by most Python code: a name prefixed with an underscore (e.g. ``_spam``) should by most Python code: a name prefixed with an underscore (e.g. ``_spam``) should
be treated as a non-public part of the API (whether it is a function, a method be treated as a non-public part of the API (whether it is a function, a method
or a data member). It should be considered an implementation detail and subject or a data member). It should be considered an implementation detail and subject

View file

@ -208,7 +208,7 @@ next line is a logical continuation of the line::
print(hello) print(hello)
Note that newlines still need to be embedded in the string using ``\n``; the Note that newlines still need to be embedded in the string using ``\n`` -- the
newline following the trailing backslash is discarded. This example would print newline following the trailing backslash is discarded. This example would print
the following: the following:

View file

@ -114,8 +114,8 @@ The IDE
======= =======
MacPython ships with the standard IDLE development environment. A good MacPython ships with the standard IDLE development environment. A good
introduction to using IDLE can be found at http://hkn.eecs.berkeley.edu/ introduction to using IDLE can be found at
dyoo/python/idle_intro/index.html. http://hkn.eecs.berkeley.edu/~dyoo/python/idle_intro/index.html.
.. _mac-package-manager: .. _mac-package-manager:

File diff suppressed because it is too large Load diff

View file

@ -16,10 +16,11 @@ RFC 1808: "Relative Uniform Resource Locators", by R. Fielding, UC Irvine, June
RFC 1738: "Uniform Resource Locators (URL)" by T. Berners-Lee, L. Masinter, M. RFC 1738: "Uniform Resource Locators (URL)" by T. Berners-Lee, L. Masinter, M.
McCahill, December 1994 McCahill, December 1994
RFC 3986 is considered the current standard and any changes to urlparse module RFC 3986 is considered the current standard and any future changes to
should conform to this. urlparse module is not entirely compliant with this. urlparse module should conform with it. The urlparse module is
The defacto scenarios of parsing are considered sometimes and for backward currently not entirely compliant with this RFC due to defacto
compatiblity purposes, older RFC uses of parsing are retained. The testcases in scenarios for parsing, and for backward compatibility purposes, some
parsing quirks from older RFCs are retained. The testcases in
test_urlparse.py provides a good indicator of parsing behavior. test_urlparse.py provides a good indicator of parsing behavior.
""" """

View file

@ -2941,7 +2941,8 @@ static PyMethodDef tzinfo_methods[] = {
PyDoc_STR("datetime -> DST offset in minutes east of UTC.")}, PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
{"fromutc", (PyCFunction)tzinfo_fromutc, METH_O, {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
PyDoc_STR("datetime in UTC -> datetime in local time.")}, PyDoc_STR("datetime -> timedelta showing offset from UTC, negative "
"values indicating West of UTC")},
{"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS, {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
PyDoc_STR("-> (cls, state)")}, PyDoc_STR("-> (cls, state)")},