summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2008-11-30 22:46:23 (GMT)
committerBenjamin Peterson <benjamin@python.org>2008-11-30 22:46:23 (GMT)
commit4469d0ca565d82af241926b5bde67b48fb4b844f (patch)
tree28afe19b30a147fc2b032dd12b42cfcca5821244 /Doc
parent1742e401c4d76754e901e5cb2e4e9db86964999c (diff)
downloadcpython-4469d0ca565d82af241926b5bde67b48fb4b844f.zip
cpython-4469d0ca565d82af241926b5bde67b48fb4b844f.tar.gz
cpython-4469d0ca565d82af241926b5bde67b48fb4b844f.tar.bz2
Merged revisions 67348,67355,67359,67362,67364-67365,67367-67368,67398,67423-67424,67432,67440-67441,67444-67445,67454-67455,67457-67458 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r67348 | benjamin.peterson | 2008-11-22 20:09:41 -0600 (Sat, 22 Nov 2008) | 1 line raise a better error ........ r67355 | georg.brandl | 2008-11-23 13:17:25 -0600 (Sun, 23 Nov 2008) | 2 lines #4392: fix parameter name. ........ r67359 | georg.brandl | 2008-11-23 15:57:30 -0600 (Sun, 23 Nov 2008) | 2 lines #4399: fix typo. ........ r67362 | gregory.p.smith | 2008-11-23 18:41:43 -0600 (Sun, 23 Nov 2008) | 2 lines Document PY_SSIZE_T_CLEAN for PyArg_ParseTuple. ........ r67364 | benjamin.peterson | 2008-11-23 19:16:29 -0600 (Sun, 23 Nov 2008) | 2 lines replace reference to debugger-hooks ........ r67365 | benjamin.peterson | 2008-11-23 22:09:03 -0600 (Sun, 23 Nov 2008) | 1 line #4396 make the parser module correctly validate the with syntax ........ r67367 | georg.brandl | 2008-11-24 10:16:07 -0600 (Mon, 24 Nov 2008) | 2 lines Fix typo. ........ r67368 | georg.brandl | 2008-11-24 13:56:47 -0600 (Mon, 24 Nov 2008) | 2 lines #4404: make clear what "path" is. ........ r67398 | benjamin.peterson | 2008-11-26 11:39:17 -0600 (Wed, 26 Nov 2008) | 1 line fix typo in sqlite3 docs ........ r67423 | jesse.noller | 2008-11-28 12:59:35 -0600 (Fri, 28 Nov 2008) | 2 lines issue4238: bsd support for cpu_count ........ r67424 | christian.heimes | 2008-11-28 13:33:33 -0600 (Fri, 28 Nov 2008) | 1 line Retain copyright of processing examples. This was requested by a Debian maintainer during packaging of the multiprocessing package for 2.4/2.5 ........ r67432 | benjamin.peterson | 2008-11-28 17:18:46 -0600 (Fri, 28 Nov 2008) | 1 line SVN format 9 is the same it seems ........ r67440 | jeremy.hylton | 2008-11-28 17:42:59 -0600 (Fri, 28 Nov 2008) | 4 lines Move definition int sval into branch of ifdef where it is used. Otherwise, you get a warning about an undefined variable. ........ r67441 | jeremy.hylton | 2008-11-28 18:09:16 -0600 (Fri, 28 Nov 2008) | 2 lines Reflow long lines. ........ r67444 | amaury.forgeotdarc | 2008-11-28 20:03:32 -0600 (Fri, 28 Nov 2008) | 2 lines Fix a small typo in docstring ........ r67445 | benjamin.peterson | 2008-11-29 21:07:33 -0600 (Sat, 29 Nov 2008) | 1 line StringIO.close() stops you from using the buffer, too ........ r67454 | benjamin.peterson | 2008-11-30 08:43:23 -0600 (Sun, 30 Nov 2008) | 1 line note the version that works ........ r67455 | martin.v.loewis | 2008-11-30 13:28:27 -0600 (Sun, 30 Nov 2008) | 1 line Issue #4365: Add crtassem.h constants to the msvcrt module. ........ r67457 | christian.heimes | 2008-11-30 15:16:28 -0600 (Sun, 30 Nov 2008) | 1 line w# requires Py_ssize_t ........ r67458 | benjamin.peterson | 2008-11-30 15:46:16 -0600 (Sun, 30 Nov 2008) | 1 line fix pyspecific extensions that were broken by Sphinx's grand renaming ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/arg.rst26
-rw-r--r--Doc/includes/mp_benchmarks.py3
-rw-r--r--Doc/includes/mp_distributing.py3
-rw-r--r--Doc/includes/mp_newtype.py3
-rw-r--r--Doc/includes/mp_pool.py3
-rw-r--r--Doc/includes/mp_synchronize.py3
-rw-r--r--Doc/includes/mp_webserver.py3
-rw-r--r--Doc/includes/mp_workers.py3
-rw-r--r--Doc/library/bdb.rst5
-rw-r--r--Doc/library/collections.rst10
-rw-r--r--Doc/library/ctypes.rst2
-rw-r--r--Doc/library/os.rst8
-rw-r--r--Doc/library/sqlite3.rst4
-rw-r--r--Doc/tools/sphinxext/pyspecific.py2
14 files changed, 54 insertions, 24 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index e4b91b9..d64cc5c 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -32,6 +32,11 @@ variable(s) whose address should be passed.
converted to C strings using the default encoding. If this conversion fails, a
:exc:`UnicodeError` is raised.
+ Starting with Python 2.5 the type of the length argument can be
+ controlled by defining the macro :cmacro:`PY_SSIZE_T_CLEAN` before
+ including :file:`Python.h`. If the macro is defined, length is a
+ :ctype:`Py_ssize_t` rather than an int.
+
``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
This is similar to ``s``, but the code fills a :ctype:`Py_buffer` structure
provided by the caller. In this case the Python string may contain embedded
@@ -43,17 +48,20 @@ variable(s) whose address should be passed.
has processed the data.
``s#`` (string, Unicode or any read buffer compatible object) [const char \*, int or :ctype:`Py_ssize_t`]
- This variant on ``s*`` stores into two C variables, the first one a pointer
- to a character string, the second one its length. All other read-buffer
- compatible objects pass back a reference to the raw internal data
- representation. Since this format doesn't allow writable buffer compatible
- objects like byte arrays, ``s*`` is to be preferred. The type of
- the length argument (int or :ctype:`Py_ssize_t`) is controlled by
+ This variant on ``s`` stores into two C variables, the first one a pointer to
+ a character string, the second one its length. In this case the Python
+ string may contain embedded null bytes. Unicode objects pass back a pointer
+ to the default encoded string version of the object if such a conversion is
+ possible. All other read-buffer compatible objects pass back a reference to
+ the raw internal data representation. Since this format doesn't allow writable buffer compatible objects like byte
+ arrays, ``s*`` is to be preferred.
+
+ The type of the length argument (int or :ctype:`Py_ssize_t`) is controlled by
defining the macro :cmacro:`PY_SSIZE_T_CLEAN` before including
:file:`Python.h`. If the macro was defined, length is a :ctype:`Py_ssize_t`
- rather than an int. This behavior will change in a future Python
- version to only support :ctype:`Py_ssize_t` and drop int support.
- It is best to always define :cmacro:`PY_SSIZE_T_CLEAN`.
+ rather than an int. This behavior will change in a future Python version to
+ only support :ctype:`Py_ssize_t` and drop int support. It is best to always
+ define :cmacro:`PY_SSIZE_T_CLEAN`.
``y`` (bytes object) [const char \*]
This variant on ``s`` converts a Python bytes or bytearray object to a C
diff --git a/Doc/includes/mp_benchmarks.py b/Doc/includes/mp_benchmarks.py
index 4556de0..72d4426 100644
--- a/Doc/includes/mp_benchmarks.py
+++ b/Doc/includes/mp_benchmarks.py
@@ -1,6 +1,9 @@
#
# Simple benchmarks for the multiprocessing package
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
import time, sys, multiprocessing, threading, queue, gc
diff --git a/Doc/includes/mp_distributing.py b/Doc/includes/mp_distributing.py
index 3c61902..ef1e862 100644
--- a/Doc/includes/mp_distributing.py
+++ b/Doc/includes/mp_distributing.py
@@ -3,6 +3,9 @@
#
# Depends on `multiprocessing` package -- tested with `processing-0.60`
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
__all__ = ['Cluster', 'Host', 'get_logger', 'current_process']
diff --git a/Doc/includes/mp_newtype.py b/Doc/includes/mp_newtype.py
index f020c93..d1a55a6 100644
--- a/Doc/includes/mp_newtype.py
+++ b/Doc/includes/mp_newtype.py
@@ -2,6 +2,9 @@
# This module shows how to use arbitrary callables with a subclass of
# `BaseManager`.
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
from multiprocessing import freeze_support
from multiprocessing.managers import BaseManager, BaseProxy
diff --git a/Doc/includes/mp_pool.py b/Doc/includes/mp_pool.py
index c9f5815..46eac5a 100644
--- a/Doc/includes/mp_pool.py
+++ b/Doc/includes/mp_pool.py
@@ -1,6 +1,9 @@
#
# A test of `multiprocessing.Pool` class
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
import multiprocessing
import time
diff --git a/Doc/includes/mp_synchronize.py b/Doc/includes/mp_synchronize.py
index 2939fc6..fd393f2 100644
--- a/Doc/includes/mp_synchronize.py
+++ b/Doc/includes/mp_synchronize.py
@@ -1,6 +1,9 @@
#
# A test file for the `multiprocessing` package
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
import time, sys, random
from queue import Empty
diff --git a/Doc/includes/mp_webserver.py b/Doc/includes/mp_webserver.py
index b0f001d..0878de1 100644
--- a/Doc/includes/mp_webserver.py
+++ b/Doc/includes/mp_webserver.py
@@ -8,6 +8,9 @@
# Not sure if we should synchronize access to `socket.accept()` method by
# using a process-shared lock -- does not seem to be necessary.
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
import os
import sys
diff --git a/Doc/includes/mp_workers.py b/Doc/includes/mp_workers.py
index 47dfb54..e66d97b 100644
--- a/Doc/includes/mp_workers.py
+++ b/Doc/includes/mp_workers.py
@@ -7,6 +7,9 @@
# in the original order then consider using `Pool.map()` or
# `Pool.imap()` (which will save on the amount of code needed anyway).
#
+# Copyright (c) 2006-2008, R Oudkerk
+# All rights reserved.
+#
import time
import random
diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst
index fefb2ad..555b634 100644
--- a/Doc/library/bdb.rst
+++ b/Doc/library/bdb.rst
@@ -107,8 +107,9 @@ The :mod:`bdb` module also defines two classes:
The *arg* parameter depends on the previous event.
- For more information on trace functions, see :ref:`debugger-hooks`. For
- more information on code and frame objects, refer to :ref:`types`.
+ See the documentation for :func:`sys.settrace` for more information on the
+ trace function. For more information on code and frame objects, refer to
+ :ref:`types`.
.. method:: dispatch_line(frame)
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 2edbbac..b12bd7a 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -48,7 +48,7 @@ ABC Inherits Abstract Methods Mixin
:class:`Iterable`, and ``__len__`` ``index``, and ``count``
:class:`Container`
-:class:`MutableSequnce` :class:`Sequence` ``__getitem__`` Inherited Sequence methods and
+:class:`MutableSequence` :class:`Sequence` ``__getitem__`` Inherited Sequence methods and
``__delitem__``, ``append``, ``reverse``, ``extend``, ``pop``,
``insert``, ``remove``, and ``__iadd__``
and ``__len__``
@@ -466,16 +466,16 @@ Named tuples assign meaning to each position in a tuple and allow for more reada
self-documenting code. They can be used wherever regular tuples are used, and
they add the ability to access fields by name instead of position index.
-.. function:: namedtuple(typename, fieldnames, [verbose])
+.. function:: namedtuple(typename, field_names, [verbose])
Returns a new tuple subclass named *typename*. The new subclass is used to
create tuple-like objects that have fields accessible by attribute lookup as
well as being indexable and iterable. Instances of the subclass also have a
- helpful docstring (with typename and fieldnames) and a helpful :meth:`__repr__`
+ helpful docstring (with typename and field_names) and a helpful :meth:`__repr__`
method which lists the tuple contents in a ``name=value`` format.
- The *fieldnames* are a single string with each fieldname separated by whitespace
- and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *fieldnames*
+ The *field_names* are a single string with each fieldname separated by whitespace
+ and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names*
can be a sequence of strings such as ``['x', 'y']``.
Any valid Python identifier may be used for a fieldname except for names
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index cacb5ab..a574b56 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -1368,7 +1368,7 @@ function exported by these libraries, and reacquired afterwards.
All these classes can be instantiated by calling them with at least one
argument, the pathname of the shared library. If you have an existing handle to
-an already loaded shard library, it can be passed as the ``handle`` named
+an already loaded shared library, it can be passed as the ``handle`` named
parameter, otherwise the underlying platforms ``dlopen`` or :meth:`LoadLibrary`
function is used to load the library into the process, and to get a handle to
it.
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 81a3f35..3cc77bc 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -805,10 +805,10 @@ Files and Directories
.. function:: listdir(path)
- Return a list containing the names of the entries in the directory. The list
- is in arbitrary order. It does not include the special entries ``.`` and
- ``..`` even if they are present in the directory. Availability: Unix,
- Windows.
+ Return a list containing the names of the entries in the directory given by
+ *path*. The list is in arbitrary order. It does not include the special
+ entries ``'.'`` and ``'..'`` even if they are present in the directory.
+ Availability: Unix, Windows.
This function can be called with a bytes or string argument. In the bytes
case, all filenames will be listed as returned by the underlying API. In the
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 5a22ae4..2dd29c1 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -221,8 +221,8 @@ Connection Objects
.. attribute:: Connection.isolation_level
- Get or set the current isolation level. :const:`None` for autocommit mode or one of
- "DEFERRED", "IMMEDIATE" or "EXLUSIVE". See section
+ Get or set the current isolation level. :const:`None` for autocommit mode or
+ one of "DEFERRED", "IMMEDIATE" or "EXCLUSIVE". See section
:ref:`sqlite3-controlling-transactions` for a more detailed explanation.
diff --git a/Doc/tools/sphinxext/pyspecific.py b/Doc/tools/sphinxext/pyspecific.py
index 42bb1bf..9ff9a7a 100644
--- a/Doc/tools/sphinxext/pyspecific.py
+++ b/Doc/tools/sphinxext/pyspecific.py
@@ -46,7 +46,7 @@ from pprint import pformat
from docutils.io import StringOutput
from docutils.utils import new_document
from sphinx.builder import Builder
-from sphinx.textwriter import TextWriter
+from sphinx.writers.text import TextWriter
class PydocTopicsBuilder(Builder):
name = 'pydoc-topics'