summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-21 20:36:10 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-21 20:36:10 (GMT)
commit86def6cb2b8d6d8c7f239795fa7af57c97a5890d (patch)
treeb4c1860eabc4fa30e6fb9f01af21a78a12e11cbb /Doc
parente1c981161c49ce6bc232b62f85ca222530491dae (diff)
downloadcpython-86def6cb2b8d6d8c7f239795fa7af57c97a5890d.zip
cpython-86def6cb2b8d6d8c7f239795fa7af57c97a5890d.tar.gz
cpython-86def6cb2b8d6d8c7f239795fa7af57c97a5890d.tar.bz2
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r60151 | christian.heimes | 2008-01-21 14:11:15 +0100 (Mon, 21 Jan 2008) | 1 line A bunch of header files were not listed as dependencies for object files. Changes to files like Parser/parser.h weren't picked up by make. ........ r60152 | georg.brandl | 2008-01-21 15:16:46 +0100 (Mon, 21 Jan 2008) | 3 lines #1087741: make mmap.mmap the type of mmap objects, not a factory function. Allow it to be subclassed. ........ r60153 | georg.brandl | 2008-01-21 15:18:14 +0100 (Mon, 21 Jan 2008) | 2 lines mmap is an extension module. ........ r60154 | georg.brandl | 2008-01-21 17:28:13 +0100 (Mon, 21 Jan 2008) | 2 lines Fix example. ........ r60155 | georg.brandl | 2008-01-21 17:34:07 +0100 (Mon, 21 Jan 2008) | 2 lines #1555501: document plistlib and move it to the general library. ........ r60156 | georg.brandl | 2008-01-21 17:36:00 +0100 (Mon, 21 Jan 2008) | 2 lines Add a stub for bundlebuilder documentation. ........ r60157 | georg.brandl | 2008-01-21 17:46:58 +0100 (Mon, 21 Jan 2008) | 2 lines Removing bundlebuilder docs again -- it's not to be used anymore (see #779825). ........ r60158 | georg.brandl | 2008-01-21 17:51:51 +0100 (Mon, 21 Jan 2008) | 2 lines #997912: acknowledge nested scopes in tutorial. ........ r60159 | vinay.sajip | 2008-01-21 18:02:26 +0100 (Mon, 21 Jan 2008) | 1 line Fix: #1836: Off-by-one bug in TimedRotatingFileHandler rollover calculation. Patch thanks to Kathryn M. Kowalski. ........ r60161 | georg.brandl | 2008-01-21 18:13:03 +0100 (Mon, 21 Jan 2008) | 2 lines Adapt pydoc to new doc URLs. ........ r60162 | georg.brandl | 2008-01-21 18:17:00 +0100 (Mon, 21 Jan 2008) | 2 lines Fix old link. ........ r60163 | georg.brandl | 2008-01-21 18:22:06 +0100 (Mon, 21 Jan 2008) | 2 lines #1726198: replace while 1: fp.readline() with file iteration. ........ r60164 | georg.brandl | 2008-01-21 18:29:23 +0100 (Mon, 21 Jan 2008) | 2 lines Clarify $ behavior in re docstring. #1631394. ........ r60165 | vinay.sajip | 2008-01-21 18:39:22 +0100 (Mon, 21 Jan 2008) | 1 line Minor documentation change - hyperlink tidied up. ........ r60166 | georg.brandl | 2008-01-21 18:42:40 +0100 (Mon, 21 Jan 2008) | 2 lines #1530959: change distutils build dir for --with-pydebug python builds. ........ r60167 | vinay.sajip | 2008-01-21 19:16:05 +0100 (Mon, 21 Jan 2008) | 1 line Updated to include news on recent logging fixes and documentation changes. ........ r60168 | georg.brandl | 2008-01-21 19:35:49 +0100 (Mon, 21 Jan 2008) | 3 lines Issue #1882: when compiling code from a string, encoding cookies in the second line of code were not always recognized correctly. ........ r60170 | georg.brandl | 2008-01-21 19:36:51 +0100 (Mon, 21 Jan 2008) | 2 lines Add NEWS entry for #1882. ........ r60172 | georg.brandl | 2008-01-21 19:41:24 +0100 (Mon, 21 Jan 2008) | 2 lines Use original location of document, which has translations. ........ r60173 | walter.doerwald | 2008-01-21 21:18:04 +0100 (Mon, 21 Jan 2008) | 2 lines Follow PEP 8 in module docstring. ........ r60175 | georg.brandl | 2008-01-21 21:20:53 +0100 (Mon, 21 Jan 2008) | 2 lines Adapt to latest doctools refactoring. ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/bugs.rst2
-rw-r--r--Doc/conf.py15
-rw-r--r--Doc/extending/building.rst2
-rw-r--r--Doc/howto/regex.rst5
-rw-r--r--Doc/library/configparser.rst2
-rw-r--r--Doc/library/fileformats.rst1
-rw-r--r--Doc/library/logging.rst13
-rw-r--r--Doc/library/mmap.rst15
-rw-r--r--Doc/library/plistlib.rst124
-rw-r--r--Doc/library/pydoc.rst2
-rw-r--r--Doc/tools/sphinxext/patchlevel.py68
-rw-r--r--Doc/tutorial/controlflow.rst9
12 files changed, 229 insertions, 29 deletions
diff --git a/Doc/bugs.rst b/Doc/bugs.rst
index f8f75c2..8b8df81 100644
--- a/Doc/bugs.rst
+++ b/Doc/bugs.rst
@@ -49,7 +49,7 @@ taken on the bug.
.. seealso::
- `How to Report Bugs Effectively <http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html>`_
+ `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
Article which goes into some detail about how to create a useful bug report.
This describes what kind of information is useful and why it is useful.
diff --git a/Doc/conf.py b/Doc/conf.py
index 5be5d1e..8359674 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -7,23 +7,27 @@
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
+import sys, os, time
+sys.path.append('tools/sphinxext')
+
# General configuration
# ---------------------
# General substitutions.
project = 'Python'
-copyright = '1990-2007, Python Software Foundation'
+copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y')
# The default replacements for |version| and |release|.
-# If '<auto>', Sphinx looks for the Include/patchlevel.h file in the current Python
-# source tree and replaces the values accordingly.
#
# The short X.Y version.
# version = '2.6'
-version = '<auto>'
# The full version, including alpha/beta/rc tags.
# release = '2.6a0'
-release = '<auto>'
+
+# We look for the Include/patchlevel.h file in the current Python source tree
+# and replace the values accordingly.
+import patchlevel
+version, release = patchlevel.get_version_info()
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
@@ -119,7 +123,6 @@ latex_documents = [
'What\'s New in Python', 'A. M. Kuchling', 'howto'),
]
# Collect all HOWTOs individually
-import os
latex_documents.extend(('howto/' + fn, 'howto-' + fn[:-4] + '.tex',
'HOWTO', _stdauthor, 'howto')
for fn in os.listdir('howto')
diff --git a/Doc/extending/building.rst b/Doc/extending/building.rst
index 5e1dec8..1c7b53f 100644
--- a/Doc/extending/building.rst
+++ b/Doc/extending/building.rst
@@ -80,7 +80,7 @@ example below. ::
description = 'This is a demo package',
author = 'Martin v. Loewis',
author_email = 'martin@v.loewis.de',
- url = 'http://www.python.org/doc/current/ext/building.html',
+ url = 'http://docs.python.org/extending/building',
long_description = '''
This is really just a demo package.
''',
diff --git a/Doc/howto/regex.rst b/Doc/howto/regex.rst
index 6adecd7..d6c6b0a 100644
--- a/Doc/howto/regex.rst
+++ b/Doc/howto/regex.rst
@@ -335,9 +335,8 @@ Performing Matches
Once you have an object representing a compiled regular expression, what do you
do with it? :class:`RegexObject` instances have several methods and attributes.
-Only the most significant ones will be covered here; consult `the Library
-Reference <http://www.python.org/doc/lib/module-re.html>`_ for a complete
-listing.
+Only the most significant ones will be covered here; consult the :mod:`re` docs
+for a complete listing.
+------------------+-----------------------------------------------+
| Method/Attribute | Purpose |
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 979f351..28f2e59 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -420,3 +420,5 @@ The function ``opt_move`` below can be used to move options between sections::
# Create non-existent section
config.add_section(section2)
opt_move(config, section1, section2, option)
+ else:
+ config.remove_option(section1, option)
diff --git a/Doc/library/fileformats.rst b/Doc/library/fileformats.rst
index c0c2eed..d2f0639 100644
--- a/Doc/library/fileformats.rst
+++ b/Doc/library/fileformats.rst
@@ -16,3 +16,4 @@ that aren't markup languages or are related to e-mail.
robotparser.rst
netrc.rst
xdrlib.rst
+ plistlib.rst
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 923d9f2..ce574d0 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1180,13 +1180,13 @@ also illustrates what dict-like behaviour is needed from an arbitrary
"dict-like" object for use in the constructor::
import logging
-
+
class ConnInfo:
"""
An example class which shows how an arbitrary class can be used as
the 'extra' context information repository passed to a LoggerAdapter.
"""
-
+
def __getitem__(self, name):
"""
To allow this instance to look like a dict.
@@ -1199,7 +1199,7 @@ also illustrates what dict-like behaviour is needed from an arbitrary
else:
result = self.__dict__.get(name, "?")
return result
-
+
def __iter__(self):
"""
To allow iteration over keys, which will be merged into
@@ -1208,7 +1208,7 @@ also illustrates what dict-like behaviour is needed from an arbitrary
keys = ["ip", "user"]
keys.extend(self.__dict__.keys())
return keys.__iter__()
-
+
if __name__ == "__main__":
from random import choice
levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
@@ -2133,7 +2133,10 @@ LoggerAdapter Objects
.. versionadded:: 2.6
:class:`LoggerAdapter` instances are used to conveniently pass contextual
-information into logging calls. For a usage example , see context-info_.
+information into logging calls. For a usage example , see the section on
+`adding contextual information to your logging output`__.
+
+__ context-info_
.. class:: LoggerAdapter(logger, extra)
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst
index 37391d0..8ec9885 100644
--- a/Doc/library/mmap.rst
+++ b/Doc/library/mmap.rst
@@ -15,7 +15,7 @@ substring by assigning to a slice: ``obj[i1:i2] = '...'``. You can also read
and write data starting at the current file position, and :meth:`seek` through
the file to different positions.
-A memory-mapped file is created by the :func:`mmap` function, which is different
+A memory-mapped file is created by the :class:`mmap` constructor, which is different
on Unix and on Windows. In either case you must provide a file descriptor for a
file opened for update. If you wish to map an existing Python file object, use
its :meth:`fileno` method to obtain the correct value for the *fileno*
@@ -23,7 +23,7 @@ parameter. Otherwise, you can open the file using the :func:`os.open` function,
which returns a file descriptor directly (the file still needs to be closed when
done).
-For both the Unix and Windows versions of the function, *access* may be
+For both the Unix and Windows versions of the constructor, *access* may be
specified as an optional keyword parameter. *access* accepts one of three
values: :const:`ACCESS_READ`, :const:`ACCESS_WRITE`, or :const:`ACCESS_COPY` to
specify readonly, write-through or copy-on-write memory respectively. *access*
@@ -37,11 +37,10 @@ not update the underlying file.
To map anonymous memory, -1 should be passed as the fileno along with the length.
-
-.. function:: mmap(fileno, length[, tagname[, access[, offset]]])
+.. class:: mmap(fileno, length[, tagname[, access[, offset]]])
**(Windows version)** Maps *length* bytes from the file specified by the file
- handle *fileno*, and returns a mmap object. If *length* is larger than the
+ handle *fileno*, and creates a mmap object. If *length* is larger than the
current size of the file, the file is extended to contain *length* bytes. If
*length* is ``0``, the maximum length of the map is the current size of the
file, except that if the file is empty Windows raises an exception (you cannot
@@ -59,12 +58,12 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
*offset* must be a multiple of the ALLOCATIONGRANULARITY.
-.. function:: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
+.. class:: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
:noindex:
**(Unix version)** Maps *length* bytes from the file specified by the file
descriptor *fileno*, and returns a mmap object. If *length* is ``0``, the
- maximum length of the map will be the current size of the file when :func:`mmap`
+ maximum length of the map will be the current size of the file when :class:`mmap`
is called.
*flags* specifies the nature of the mapping. :const:`MAP_PRIVATE` creates a
@@ -85,7 +84,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
be relative to the offset from the beginning of the file. *offset* defaults to 0.
*offset* must be a multiple of the PAGESIZE or ALLOCATIONGRANULARITY.
- This example shows a simple way of using :func:`mmap`::
+ This example shows a simple way of using :class:`mmap`::
import mmap
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst
new file mode 100644
index 0000000..508f8e8
--- /dev/null
+++ b/Doc/library/plistlib.rst
@@ -0,0 +1,124 @@
+:mod:`plistlib` --- Generate and parse MacOS X ``.plist`` files
+===============================================================
+
+.. module:: plistlib
+ :synopsis: Generate and parse MacOS X plist files.
+.. moduleauthor:: Jack Jansen
+.. sectionauthor:: Georg Brandl <georg@python.org>
+.. (harvested from docstrings in the original file)
+
+.. versionchanged:: 2.6
+ This module was previously only available in the Mac-specific library, it is
+ now available for all platforms.
+
+.. index::
+ pair: plist; file
+ single: property list
+
+This module provides an interface for reading and writing the "property list"
+XML files used mainly by MacOS X.
+
+The property list (``.plist``) file format is a simple XML pickle supporting
+basic object types, like dictionaries, lists, numbers and strings. Usually the
+top level object is a dictionary.
+
+Values can be strings, integers, floats, booleans, tuples, lists, dictionaries
+(but only with string keys), :class:`Data` or :class:`datetime.datetime`
+objects. String values (including dictionary keys) may be unicode strings --
+they will be written out as UTF-8.
+
+The ``<data>`` plist type is supported through the :class:`Data` class. This is
+a thin wrapper around a Python string. Use :class:`Data` if your strings
+contain control characters.
+
+.. seealso::
+
+ `PList manual page <http://developer.apple.com/documentation/Darwin/Reference/ManPages/man5/plist.5.html>`
+ Apple's documentation of the file format.
+
+
+This module defines the following functions:
+
+.. function:: readPlist(pathOrFile)
+
+ Read a plist file. *pathOrFile* may either be a file name or a (readable)
+ file object. Return the unpacked root object (which usually is a
+ dictionary).
+
+ The XML data is parsed using the Expat parser from :mod:`xml.parsers.expat`
+ -- see its documentation for possible exceptions on ill-formed XML.
+ Unknown elements will simply be ignored by the plist parser.
+
+
+.. function:: writePlist(rootObject, pathOrFile)
+
+ Write *rootObject* to a plist file. *pathOrFile* may either be a file name
+ or a (writable) file object.
+
+ A :exc:`TypeError` will be raised if the object is of an unsupported type or
+ a container that contains objects of unsupported types.
+
+
+.. function:: readPlistFromString(data)
+
+ Read a plist from a string. Return the root object.
+
+
+.. function:: writePlistToString(rootObject)
+
+ Return *rootObject* as a plist-formatted string.
+
+
+
+.. function:: readPlistFromResource(path[, restype='plst'[, resid=0]])
+
+ Read a plist from the resource with type *restype* from the resource fork of
+ *path*. Availability: MacOS X.
+
+
+.. function:: writePlistToResource(rootObject, path[, restype='plst'[, resid=0]])
+
+ Write *rootObject* as a resource with type *restype* to the resource fork of
+ *path*. Availability: MacOS X.
+
+
+The following class is available:
+
+.. class:: Data(data)
+
+ Return a "data" wrapper object around the string *data*. This is used in
+ functions converting from/to plists to represent the ``<data>`` type
+ available in plists.
+
+ It has one attribute, :attr:`data`, that can be used to retrieve the Python
+ string stored in it.
+
+
+Examples
+--------
+
+Generating a plist::
+
+ pl = dict(
+ aString="Doodah",
+ aList=["A", "B", 12, 32.1, [1, 2, 3]],
+ aFloat = 0.1,
+ anInt = 728,
+ aDict=dict(
+ anotherString="<hello & hi there!>",
+ aUnicodeValue=u'M\xe4ssig, Ma\xdf',
+ aTrueValue=True,
+ aFalseValue=False,
+ ),
+ someData = Data("<binary gunk>"),
+ someMoreData = Data("<lots of binary gunk>" * 10),
+ aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),
+ )
+ # unicode keys are possible, but a little awkward to use:
+ pl[u'\xc5benraa'] = "That was a unicode key."
+ writePlist(pl, fileName)
+
+Parsing a plist::
+
+ pl = readPlist(pathOrFile)
+ print pl["aKey"]
diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index 4d74397..41ea1c6 100644
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -57,7 +57,7 @@ documents precisely the version of the module you would get if you started the
Python interpreter and typed ``import spam``.
Module docs for core modules are assumed to reside in
-http://www.python.org/doc/current/lib/. This can be overridden by setting the
+http://docs.python.org/library/. This can be overridden by setting the
:envvar:`PYTHONDOCS` environment variable to a different URL or to a local
directory containing the Library Reference Manual pages.
diff --git a/Doc/tools/sphinxext/patchlevel.py b/Doc/tools/sphinxext/patchlevel.py
new file mode 100644
index 0000000..971ea61
--- /dev/null
+++ b/Doc/tools/sphinxext/patchlevel.py
@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+"""
+ patchlevel.py
+ ~~~~~~~~~~~~~
+
+ Extract version info from Include/patchlevel.h.
+ Adapted from Doc/tools/getversioninfo.
+
+ :copyright: 2007-2008 by Georg Brandl.
+ :license: Python license.
+"""
+
+import os
+import re
+import sys
+
+def get_header_version_info(srcdir):
+ patchlevel_h = os.path.join(srcdir, '..', 'Include', 'patchlevel.h')
+
+ # This won't pick out all #defines, but it will pick up the ones we
+ # care about.
+ rx = re.compile(r'\s*#define\s+([a-zA-Z][a-zA-Z_0-9]*)\s+([a-zA-Z_0-9]+)')
+
+ d = {}
+ f = open(patchlevel_h)
+ try:
+ for line in f:
+ m = rx.match(line)
+ if m is not None:
+ name, value = m.group(1, 2)
+ d[name] = value
+ finally:
+ f.close()
+
+ release = version = '%s.%s' % (d['PY_MAJOR_VERSION'], d['PY_MINOR_VERSION'])
+ micro = int(d['PY_MICRO_VERSION'])
+ if micro != 0:
+ release += '.' + str(micro)
+
+ level = d['PY_RELEASE_LEVEL']
+ suffixes = {
+ 'PY_RELEASE_LEVEL_ALPHA': 'a',
+ 'PY_RELEASE_LEVEL_BETA': 'b',
+ 'PY_RELEASE_LEVEL_GAMMA': 'c',
+ }
+ if level != 'PY_RELEASE_LEVEL_FINAL':
+ release += suffixes[level] + str(int(d['PY_RELEASE_SERIAL']))
+ return version, release
+
+
+def get_sys_version_info():
+ major, minor, micro, level, serial = sys.version_info
+ release = version = '%s.%s' % (major, minor)
+ if micro:
+ release += '.%s' % micro
+ if level != 'final':
+ release += '%s%s' % (level[0], serial)
+ return version, release
+
+
+def get_version_info():
+ try:
+ return get_header_version_info('.')
+ except (IOError, OSError):
+ version, release = get_sys_version_info()
+ print >>sys.stderr, 'Can\'t get version info from Include/patchlevel.h, ' \
+ 'using version of this interpreter (%s).' % release
+ return version, release
diff --git a/Doc/tutorial/controlflow.rst b/Doc/tutorial/controlflow.rst
index 82a8977..3d011d1 100644
--- a/Doc/tutorial/controlflow.rst
+++ b/Doc/tutorial/controlflow.rst
@@ -235,10 +235,11 @@ it.
The *execution* of a function introduces a new symbol table used for the local
variables of the function. More precisely, all variable assignments in a
function store the value in the local symbol table; whereas variable references
-first look in the local symbol table, then in the global symbol table, and then
-in the table of built-in names. Thus, global variables cannot be directly
-assigned a value within a function (unless named in a :keyword:`global`
-statement), although they may be referenced.
+first look in the local symbol table, then in the local symbol tables of
+enclosing functions, then in the global symbol table, and finally in the table
+of built-in names. Thus, global variables cannot be directly assigned a value
+within a function (unless named in a :keyword:`global` statement), although they
+may be referenced.
The actual parameters (arguments) to a function call are introduced in the local
symbol table of the called function when it is called; thus, arguments are