summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAlexandre Vassalotti <alexandre@peadrop.com>2008-05-15 22:09:29 (GMT)
committerAlexandre Vassalotti <alexandre@peadrop.com>2008-05-15 22:09:29 (GMT)
commit6461e10158db1f1d41dc9449e233551b2889ebb5 (patch)
treec1860ecebd924e489948471797e0beb81174c29b /Doc
parentb645bc7b775b85e3520a561413905a7a1c4ae11c (diff)
downloadcpython-6461e10158db1f1d41dc9449e233551b2889ebb5.zip
cpython-6461e10158db1f1d41dc9449e233551b2889ebb5.tar.gz
cpython-6461e10158db1f1d41dc9449e233551b2889ebb5.tar.bz2
Merged revisions 62914-62916,62918-62919,62921-62922,62924-62942,62944-62945,62947-62949 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r62914 | skip.montanaro | 2008-05-08 20:45:00 -0400 (Thu, 08 May 2008) | 4 lines Add an example about using NamedTemporaryFile() to replace mktemp(). I'm unclear whether the verbatim text should have been indented or by how much. ........ r62915 | benjamin.peterson | 2008-05-08 20:50:40 -0400 (Thu, 08 May 2008) | 2 lines reindent example ........ r62927 | georg.brandl | 2008-05-09 02:09:25 -0400 (Fri, 09 May 2008) | 2 lines #2788: add .hgignore file. ........ r62928 | georg.brandl | 2008-05-09 02:10:43 -0400 (Fri, 09 May 2008) | 2 lines #2781: fix function name. ........ r62929 | georg.brandl | 2008-05-09 02:18:27 -0400 (Fri, 09 May 2008) | 2 lines Add a sentence to basicConfig() that is in the docstring. ........ r62930 | georg.brandl | 2008-05-09 02:26:54 -0400 (Fri, 09 May 2008) | 2 lines Add another link to colorsys docs. ........ r62931 | georg.brandl | 2008-05-09 02:36:07 -0400 (Fri, 09 May 2008) | 2 lines Add Kodos as a re reference. ........ r62932 | georg.brandl | 2008-05-09 02:39:58 -0400 (Fri, 09 May 2008) | 2 lines Add a note about using reload(). ........ r62933 | andrew.kuchling | 2008-05-09 07:46:05 -0400 (Fri, 09 May 2008) | 3 lines Update planned release date. Uncomment PEP 370 section. Add some module items ........ r62934 | christian.heimes | 2008-05-09 08:19:09 -0400 (Fri, 09 May 2008) | 1 line Add --user option to build_ext ........ r62948 | mark.dickinson | 2008-05-09 13:54:23 -0400 (Fri, 09 May 2008) | 3 lines Issue #2487. math.ldexp(x, n) raised OverflowError when n was large and negative; fix to return an (appropriately signed) zero instead. ........ r62949 | martin.v.loewis | 2008-05-09 14:21:55 -0400 (Fri, 09 May 2008) | 1 line Use the CHM file name that Sphinx assigns. ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/_winreg.rst4
-rw-r--r--Doc/library/colorsys.rst9
-rw-r--r--Doc/library/re.rst3
-rw-r--r--Doc/library/tempfile.rst18
-rw-r--r--Doc/tutorial/modules.rst7
-rw-r--r--Doc/whatsnew/2.6.rst74
6 files changed, 88 insertions, 27 deletions
diff --git a/Doc/library/_winreg.rst b/Doc/library/_winreg.rst
index a4f3879..ba2994d 100644
--- a/Doc/library/_winreg.rst
+++ b/Doc/library/_winreg.rst
@@ -146,7 +146,7 @@ This module offers the following functions:
*key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
- It is not necessary to call RegFlushKey to change a key. Registry changes are
+ It is not necessary to call :func:`FlushKey` to change a key. Registry changes are
flushed to disk by the registry using its lazy flusher. Registry changes are
also flushed to disk at system shutdown. Unlike :func:`CloseKey`, the
:func:`FlushKey` method returns only when all the data has been written to the
@@ -159,7 +159,7 @@ This module offers the following functions:
isn't.
-.. function:: RegLoadKey(key, sub_key, file_name)
+.. function:: LoadKey(key, sub_key, file_name)
Creates a subkey under the specified key and stores registration information
from a specified file into that subkey.
diff --git a/Doc/library/colorsys.rst b/Doc/library/colorsys.rst
index 2e7f3b7..2cbc704 100644
--- a/Doc/library/colorsys.rst
+++ b/Doc/library/colorsys.rst
@@ -1,4 +1,3 @@
-
:mod:`colorsys` --- Conversions between color systems
=====================================================
@@ -15,8 +14,11 @@ spaces are floating point values. In the YIQ space, the Y coordinate is between
0 and 1, but the I and Q coordinates can be positive or negative. In all other
spaces, the coordinates are all between 0 and 1.
-More information about color spaces can be found at
-http://www.poynton.com/ColorFAQ.html.
+.. seealso::
+
+ More information about color spaces can be found at
+ http://www.poynton.com/ColorFAQ.html and
+ http://www.cambridgeincolour.com/tutorials/color-spaces.htm.
The :mod:`colorsys` module defines the following functions:
@@ -57,4 +59,3 @@ Example::
(0.25, 0.5, 0.4)
>>> colorsys.hsv_to_rgb(0.25, 0.5, 0.4)
(0.3, 0.4, 0.2)
-
diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index e3867c0..707eedf 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -43,6 +43,9 @@ fine-tuning parameters.
second edition of the book no longer covers Python at all, but the first
edition covered writing good regular expression patterns in great detail.
+ `Kodos <http://kodos.sf.net/>`_
+ is a graphical regular expression debugger written in Python.
+
.. _re-syntax:
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
index 7363940..25d5acb 100644
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -152,6 +152,24 @@ The module defines the following user-callable functions:
Use of this function may introduce a security hole in your program.
By the time you get around to doing anything with the file name it
returns, someone else may have beaten you to the punch.
+ :func:`mktemp` usage can be replaced easily with
+ :func:`NamedTemporaryFile`, passing it the `delete=False` parameter::
+
+ >>> f = NamedTemporaryFile(delete=False)
+ >>> print f.name
+ >>> f.write("Hello World!\n")
+ >>> f.close()
+ >>> os.unlink(f.name)
+ >>> f = NamedTemporaryFile(delete=False)
+ >>> f
+ <open file '<fdopen>', mode 'w+b' at 0x384698>
+ >>> f.name
+ '/var/folders/5q/5qTPn6xq2RaWqk+1Ytw3-U+++TI/-Tmp-/tmpG7V1Y0'
+ >>> f.write("Hello World!\n")
+ >>> f.close()
+ >>> os.unlink(f.name)
+ >>> os.path.exists(f.name)
+ False
The module uses two global variables that tell it how to construct a
temporary name. They are initialized at the first call to any of the
diff --git a/Doc/tutorial/modules.rst b/Doc/tutorial/modules.rst
index eee989f..4d06df2 100644
--- a/Doc/tutorial/modules.rst
+++ b/Doc/tutorial/modules.rst
@@ -106,6 +106,13 @@ In most cases Python programmers do not use this facility since it introduces
an unknown set of names into the interpreter, possibly hiding some things
you have already defined.
+.. note::
+
+ For efficiency reasons, each module is only imported once per interpreter
+ session. Therefore, if you change your modules, you must restart the
+ interpreter -- or, if it's just one module you want to test interactively,
+ use :func:`reload`, e.g. ``reload('modulename')``.
+
.. _tut-modulesasscripts:
diff --git a/Doc/whatsnew/2.6.rst b/Doc/whatsnew/2.6.rst
index 1af6f73..9708c67 100644
--- a/Doc/whatsnew/2.6.rst
+++ b/Doc/whatsnew/2.6.rst
@@ -40,25 +40,26 @@
* Credit the author of a patch or bugfix. Just the name is
sufficient; the e-mail address isn't necessary.
- * It's helpful to add the bug/patch number in an parenthetical
+ * It's helpful to add the bug/patch number in a parenthetical comment.
XXX Describe the transmogrify() function added to the socket
module.
(Contributed by P.Y. Developer; :issue:`12345`.)
- This saves the maintainer the effort of going through the SVN logs
+ This saves the maintainer some effort going through the SVN logs
when researching a change.
-This article explains the new features in Python 2.6. No release date for
-Python 2.6 has been set; it will probably be released in mid 2008.
+This article explains the new features in Python 2.6. The release
+schedule is described in :pep:`361`; currently the final release is
+scheduled for September 3 2008.
This article doesn't attempt to provide a complete specification of
the new features, but instead provides a convenient overview. For
full details, you should refer to the documentation for Python 2.6. If
-you want to understand the complete implementation and design
-rationale, refer to the PEP for a particular new feature. For smaller
-changes, this edition of "What's New in Python" links to the bug/patch
-item for each change whenever possible.
+you want to understand the rationale for the design and
+implementation, refer to the PEP for a particular new feature.
+Whenever possible, "What's New in Python" links to the bug/patch item
+for each change.
.. Compare with previous release in 2 - 3 sentences here.
add hyperlink when the documentation becomes available online.
@@ -481,24 +482,41 @@ can now be used in scripts running from inside a package.
.. ======================================================================
-.. ::
+.. _pep-0370:
- .. _pep-0370:
+PEP 370: Per-user ``site-packages`` Directory
+=====================================================
+
+When you run Python, the module search path ``sys.modules`` usually
+includes a directory whose path ends in ``"site-packages"``. This
+directory is intended to hold locally-installed packages available to
+all users on a machine or using a particular site installation.
+
+Python 2.6 introduces a convention for user-specific site directories.
+The directory varies depending on the platform:
+
+* Unix and MacOS: :file:`~/.local/`
+* Windows: :file:`%APPDATA%/Python`
- PEP 370: XXX
- =====================================================
+Within this directory, there will be version-specific subdirectories,
+such as :file:`lib/python2.6/site-packages` on Unix/MacOS and
+:file:`Python26/site-packages` on Windows.
- When you run Python, the module search page ``sys.modules`` usually
- includes a directory whose path ends in ``"site-packages"``. This
- directory is intended to hold locally-installed packages available to
- all users on a machine or using a particular site installation.
+If you don't like the default directory, it can be overridden by an
+environment variable. :envvar:`PYTHONUSERBASE` sets the root
+directory used for all Python versions supporting this feature. On
+Windows, the directory for application-specific data can be changed by
+setting the :envvar:`APPDATA` environment variable. You can also
+modify the :file:`site.py` file for your Python installation.
- Python 2.6 introduces a convention for user-specific site directories.
+The feature can be disabled entirely by running Python with the
+:option:`-s` option or setting the :envvar:`PYTHONNOUSERSITE`
+environment variable.
- .. seealso::
+.. seealso::
- :pep:`370` - XXX
- PEP written by XXX; implemented by Christian Heimes.
+ :pep:`370` - Per-user ``site-packages`` Directory
+ PEP written and implemented by Christian Heimes.
.. ======================================================================
@@ -1450,6 +1468,12 @@ fixes. Here's a partial list of the most notable changes, sorted alphabetically
by module name. Consult the :file:`Misc/NEWS` file in the source tree for a more
complete list of changes, or look through the CVS logs for all the details.
+* (3.0-warning mode) The :mod:`audiodev` module is being deprecated,
+ and has been removed from Python 3.0, so importing it now triggers a
+ warning. The module hasn't been maintained for several versions,
+ and is written against an outdated sound interface for SunOS and
+ IRIX.
+
* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
available, instead of restricting itself to protocol 1.
(Contributed by W. Barnes; :issue:`1551443`.)
@@ -2104,7 +2128,12 @@ complete list of changes, or look through the CVS logs for all the details.
(Added by Facundo Batista.)
-* The XML-RPC classes :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
+* The :mod:`warnings` module's :func:`formatwarning` and :func:`showwarning`
+ gained an optional *line* argument that can be used to supply the
+ line of source code. (Added as part of :issue:`1631171`, which re-implemented
+ part of the :mod:`warnings` module in C code.)
+
+* The XML-RPC :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
classes can now be prevented from immediately opening and binding to
their socket by passing True as the ``bind_and_activate``
constructor parameter. This can be used to modify the instance's
@@ -2144,6 +2173,9 @@ complete list of changes, or look through the CVS logs for all the details.
(Contributed by Alan McIntyre; :issue:`467924`.)
+ Also, :mod:`zipfile` now supports using Unicode filenames
+ for archived files. (Contributed by Alexey Borzenkov; :issue:`1734346`.)
+
.. ======================================================================
.. whole new modules get described in subsections here