mirror of https://github.com/python/cpython
Merged revisions 72007-72010,72036-72037 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r72007 | georg.brandl | 2009-04-27 17:09:25 +0200 (Mo, 27 Apr 2009) | 1 line #5856: fix typo s in traceback example. ........ r72008 | georg.brandl | 2009-04-27 17:10:44 +0200 (Mo, 27 Apr 2009) | 1 line Remove ".. warning::" markup that doesnt contain warnings for users, rather todo items. ........ r72009 | georg.brandl | 2009-04-27 17:29:09 +0200 (Mo, 27 Apr 2009) | 3 lines Demote warnings to notices where appropriate, following the goal that as few "red box" warnings should clutter the docs as possible. Part 1: stuff that gets merged to Py3k. ........ r72010 | georg.brandl | 2009-04-27 17:29:26 +0200 (Mo, 27 Apr 2009) | 2 lines Demote warnings to notices, part 2: stuff that is 2.x-only. ........ r72036 | georg.brandl | 2009-04-27 19:04:23 +0200 (Mo, 27 Apr 2009) | 1 line #5848: small unittest doc patch. ........ r72037 | georg.brandl | 2009-04-27 19:09:53 +0200 (Mo, 27 Apr 2009) | 1 line #5840: dont claim we dont support TLS. ........
This commit is contained in:
parent
9ba8e571c1
commit
3885314b11
|
@ -419,10 +419,9 @@ the I/O is waiting for the I/O operation to complete.
|
||||||
The Python interpreter needs to keep some bookkeeping information separate per
|
The Python interpreter needs to keep some bookkeeping information separate per
|
||||||
thread --- for this it uses a data structure called :ctype:`PyThreadState`.
|
thread --- for this it uses a data structure called :ctype:`PyThreadState`.
|
||||||
There's one global variable, however: the pointer to the current
|
There's one global variable, however: the pointer to the current
|
||||||
:ctype:`PyThreadState` structure. While most thread packages have a way to
|
:ctype:`PyThreadState` structure. Before the addition of :dfn:`thread-local
|
||||||
store "per-thread global data," Python's internal platform independent thread
|
storage` (:dfn:`TLS`) the current thread state had to be manipulated
|
||||||
abstraction doesn't support this yet. Therefore, the current thread state must
|
explicitly.
|
||||||
be manipulated explicitly.
|
|
||||||
|
|
||||||
This is easy enough in most cases. Most code manipulating the global
|
This is easy enough in most cases. Most code manipulating the global
|
||||||
interpreter lock has the following simple structure::
|
interpreter lock has the following simple structure::
|
||||||
|
|
|
@ -44,7 +44,7 @@ This implies inclusion of the following standard headers: ``<stdio.h>``,
|
||||||
``<string.h>``, ``<errno.h>``, ``<limits.h>``, and ``<stdlib.h>`` (if
|
``<string.h>``, ``<errno.h>``, ``<limits.h>``, and ``<stdlib.h>`` (if
|
||||||
available).
|
available).
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Since Python may define some pre-processor definitions which affect the standard
|
Since Python may define some pre-processor definitions which affect the standard
|
||||||
headers on some systems, you *must* include :file:`Python.h` before any standard
|
headers on some systems, you *must* include :file:`Python.h` before any standard
|
||||||
|
|
|
@ -886,9 +886,7 @@ tarballs or zipfiles.
|
||||||
prefix of all files and directories in the archive. *root_dir* and *base_dir*
|
prefix of all files and directories in the archive. *root_dir* and *base_dir*
|
||||||
both default to the current directory. Returns the name of the archive file.
|
both default to the current directory. Returns the name of the archive file.
|
||||||
|
|
||||||
.. warning::
|
.. XXX This should be changed to support bz2 files.
|
||||||
|
|
||||||
This should be changed to support bz2 files
|
|
||||||
|
|
||||||
|
|
||||||
.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])
|
.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])
|
||||||
|
@ -901,9 +899,7 @@ tarballs or zipfiles.
|
||||||
possibly plus the appropriate compression extension (:file:`.gz`, :file:`.bz2`
|
possibly plus the appropriate compression extension (:file:`.gz`, :file:`.bz2`
|
||||||
or :file:`.Z`). Return the output filename.
|
or :file:`.Z`). Return the output filename.
|
||||||
|
|
||||||
.. warning::
|
.. XXX This should be replaced with calls to the :mod:`tarfile` module.
|
||||||
|
|
||||||
This should be replaced with calls to the :mod:`tarfile` module.
|
|
||||||
|
|
||||||
|
|
||||||
.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])
|
.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])
|
||||||
|
@ -1346,10 +1342,8 @@ provides the following additional features:
|
||||||
|
|
||||||
Wraps *text* to less than *width* wide.
|
Wraps *text* to less than *width* wide.
|
||||||
|
|
||||||
.. warning::
|
.. XXX Should be replaced with :mod:`textwrap` (which is available in Python
|
||||||
|
2.3 and later).
|
||||||
Should be replaced with :mod:`textwrap` (which is available in Python 2.3 and
|
|
||||||
later).
|
|
||||||
|
|
||||||
|
|
||||||
.. class:: FancyGetopt([option_table=None])
|
.. class:: FancyGetopt([option_table=None])
|
||||||
|
@ -1398,8 +1392,8 @@ The :class:`FancyGetopt` class provides the following methods:
|
||||||
================================================
|
================================================
|
||||||
|
|
||||||
.. module:: distutils.filelist
|
.. module:: distutils.filelist
|
||||||
:synopsis: The FileList class, used for poking about the file system and building lists of
|
:synopsis: The FileList class, used for poking about the file system and
|
||||||
files.
|
building lists of files.
|
||||||
|
|
||||||
|
|
||||||
This module provides the :class:`FileList` class, used for poking about the
|
This module provides the :class:`FileList` class, used for poking about the
|
||||||
|
@ -1413,13 +1407,8 @@ filesystem and building lists of files.
|
||||||
:synopsis: A simple logging mechanism, 282-style
|
:synopsis: A simple logging mechanism, 282-style
|
||||||
|
|
||||||
|
|
||||||
.. warning::
|
.. XXX Should be replaced with standard :mod:`logging` module.
|
||||||
|
|
||||||
Should be replaced with standard :mod:`logging` module.
|
|
||||||
|
|
||||||
.. % \subsubsection{\module{} --- }
|
|
||||||
.. % \declaremodule{standard}{distutils.magic}
|
|
||||||
.. % \modulesynopsis{ }
|
|
||||||
|
|
||||||
|
|
||||||
:mod:`distutils.spawn` --- Spawn a sub-process
|
:mod:`distutils.spawn` --- Spawn a sub-process
|
||||||
|
|
|
@ -594,11 +594,11 @@ units as well as normal text:
|
||||||
|
|
||||||
.. describe:: warning
|
.. describe:: warning
|
||||||
|
|
||||||
An important bit of information about an API that a user should be very aware
|
An important bit of information about an API that a user should be aware of
|
||||||
of when using whatever bit of API the warning pertains to. The content of
|
when using whatever bit of API the warning pertains to. The content of the
|
||||||
the directive should be written in complete sentences and include all
|
directive should be written in complete sentences and include all appropriate
|
||||||
appropriate punctuation. This differs from ``note`` in that it is recommended
|
punctuation. This should only be chosen over ``note`` for information
|
||||||
over ``note`` for information regarding security.
|
regarding the possibility of crashes, data loss, or security implications.
|
||||||
|
|
||||||
.. describe:: versionadded
|
.. describe:: versionadded
|
||||||
|
|
||||||
|
|
|
@ -47,7 +47,7 @@ The first line of our file can be::
|
||||||
which pulls in the Python API (you can add a comment describing the purpose of
|
which pulls in the Python API (you can add a comment describing the purpose of
|
||||||
the module and a copyright notice if you like).
|
the module and a copyright notice if you like).
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Since Python may define some pre-processor definitions which affect the standard
|
Since Python may define some pre-processor definitions which affect the standard
|
||||||
headers on some systems, you *must* include :file:`Python.h` before any standard
|
headers on some systems, you *must* include :file:`Python.h` before any standard
|
||||||
|
|
|
@ -101,7 +101,7 @@ true function call.
|
||||||
.. moduleauthor:: Collin Winter
|
.. moduleauthor:: Collin Winter
|
||||||
|
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The :mod:`lib2to3` API should be considered unstable and may change
|
The :mod:`lib2to3` API should be considered unstable and may change
|
||||||
drastically in the future.
|
drastically in the future.
|
||||||
|
|
|
@ -14,9 +14,9 @@ variables to AppleEvent descriptors and back (unpacking). Within Python the
|
||||||
AppleEvent descriptor is handled by Python objects of built-in type
|
AppleEvent descriptor is handled by Python objects of built-in type
|
||||||
:class:`AEDesc`, defined in module :mod:`Carbon.AE`.
|
:class:`AEDesc`, defined in module :mod:`Carbon.AE`.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
The :mod:`aepack` module defines the following functions:
|
The :mod:`aepack` module defines the following functions:
|
||||||
|
|
|
@ -22,9 +22,9 @@ The :mod:`aetools` module itself uses the AppleEvent support provided by the
|
||||||
manager, see section :ref:`osx-gui-scripts` for details. This restriction may be
|
manager, see section :ref:`osx-gui-scripts` for details. This restriction may be
|
||||||
lifted in future releases.
|
lifted in future releases.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
The :mod:`aetools` module defines the following functions:
|
The :mod:`aetools` module defines the following functions:
|
||||||
|
|
|
@ -31,9 +31,9 @@ application for which you have not generated the stub package this module also
|
||||||
contains object specifiers for a number of common OSA classes such as
|
contains object specifiers for a number of common OSA classes such as
|
||||||
``Document``, ``Window``, ``Character``, etc.
|
``Document``, ``Window``, ``Character``, etc.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`aifc` --- Read and write AIFF and AIFC files
|
:mod:`aifc` --- Read and write AIFF and AIFC files
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
|
@ -16,10 +15,11 @@ AIFF is Audio Interchange File Format, a format for storing digital audio
|
||||||
samples in a file. AIFF-C is a newer version of the format that includes the
|
samples in a file. AIFF-C is a newer version of the format that includes the
|
||||||
ability to compress the audio data.
|
ability to compress the audio data.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Some operations may only work under IRIX; these will raise :exc:`ImportError`
|
Some operations may only work under IRIX; these will raise :exc:`ImportError`
|
||||||
when attempting to import the :mod:`cl` module, which is only available on IRIX.
|
when attempting to import the :mod:`cl` module, which is only available on
|
||||||
|
IRIX.
|
||||||
|
|
||||||
Audio files have a number of parameters that describe the audio data. The
|
Audio files have a number of parameters that describe the audio data. The
|
||||||
sampling rate or frame rate is the number of times per second the sound is
|
sampling rate or frame rate is the number of times per second the sound is
|
||||||
|
|
|
@ -13,9 +13,9 @@ The :mod:`autoGIL` module provides a function :func:`installAutoGIL` that
|
||||||
automatically locks and unlocks Python's :term:`Global Interpreter Lock` when
|
automatically locks and unlocks Python's :term:`Global Interpreter Lock` when
|
||||||
running an event loop.
|
running an event loop.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module has been removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
.. exception:: AutoGILError
|
.. exception:: AutoGILError
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
.. versionchanged:: 2.3
|
.. versionchanged:: 2.3
|
||||||
Disabled module.
|
Disabled module.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The documentation has been left in place to help in reading old code that uses
|
The documentation has been left in place to help in reading old code that uses
|
||||||
the module.
|
the module.
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`binhex` --- Encode and decode binhex4 files
|
:mod:`binhex` --- Encode and decode binhex4 files
|
||||||
=================================================
|
=================================================
|
||||||
|
|
||||||
|
@ -11,9 +10,9 @@ representation of Macintosh files in ASCII. On the Macintosh, both forks of a
|
||||||
file and the finder information are encoded (or decoded), on other platforms
|
file and the finder information are encoded (or decoded), on other platforms
|
||||||
only the data fork is handled.
|
only the data fork is handled.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
In 3.0, special Macintosh support is removed.
|
In Python 3.x, special Macintosh support has been removed.
|
||||||
|
|
||||||
|
|
||||||
The :mod:`binhex` module defines the following functions:
|
The :mod:`binhex` module defines the following functions:
|
||||||
|
|
|
@ -22,9 +22,9 @@ framework and Qt is in the QuickTime framework. The normal use pattern is ::
|
||||||
|
|
||||||
from Carbon import AE
|
from Carbon import AE
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The Carbon modules are removed in 3.0.
|
The Carbon modules have been removed in Python 3.0.
|
||||||
|
|
||||||
|
|
||||||
:mod:`Carbon.AE` --- Apple Events
|
:mod:`Carbon.AE` --- Apple Events
|
||||||
|
|
|
@ -42,7 +42,7 @@ To do just the former:
|
||||||
(``'single'``, the default) or as an :term:`expression` (``'eval'``). Any
|
(``'single'``, the default) or as an :term:`expression` (``'eval'``). Any
|
||||||
other value will cause :exc:`ValueError` to be raised.
|
other value will cause :exc:`ValueError` to be raised.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
It is possible (but not likely) that the parser stops parsing with a
|
It is possible (but not likely) that the parser stops parsing with a
|
||||||
successful outcome before reaching the end of the source; in this case,
|
successful outcome before reaching the end of the source; in this case,
|
||||||
|
|
|
@ -13,9 +13,9 @@
|
||||||
The :mod:`ColorPicker` module provides access to the standard color picker
|
The :mod:`ColorPicker` module provides access to the standard color picker
|
||||||
dialog.
|
dialog.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
.. function:: GetColor(prompt, rgb)
|
.. function:: GetColor(prompt, rgb)
|
||||||
|
|
|
@ -16,11 +16,12 @@ The :mod:`subprocess` module provides more powerful facilities for spawning new
|
||||||
processes and retrieving their results. Using the :mod:`subprocess` module is
|
processes and retrieving their results. Using the :mod:`subprocess` module is
|
||||||
preferable to using the :mod:`commands` module.
|
preferable to using the :mod:`commands` module.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
In 3.x, :func:`getstatus` and two undocumented functions (:func:`mk2arg` and
|
In Python 3.x, :func:`getstatus` and two undocumented functions
|
||||||
:func:`mkarg`) have been removed. Also, :func:`getstatusoutput` and
|
(:func:`mk2arg` and :func:`mkarg`) have been removed. Also,
|
||||||
:func:`getoutput` have been moved to the :mod:`subprocess` module.
|
:func:`getstatusoutput` and :func:`getoutput` have been moved to the
|
||||||
|
:mod:`subprocess` module.
|
||||||
|
|
||||||
The :mod:`commands` module defines the following functions:
|
The :mod:`commands` module defines the following functions:
|
||||||
|
|
||||||
|
|
|
@ -27,10 +27,10 @@ structure similar to what you would find on Microsoft Windows INI files. You
|
||||||
can use this to write Python programs which can be customized by end users
|
can use this to write Python programs which can be customized by end users
|
||||||
easily.
|
easily.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This library does *not* interpret or write the value-type prefixes used in the
|
This library does *not* interpret or write the value-type prefixes used in
|
||||||
Windows Registry extended version of INI syntax.
|
the Windows Registry extended version of INI syntax.
|
||||||
|
|
||||||
The configuration file consists of sections, led by a ``[section]`` header and
|
The configuration file consists of sections, led by a ``[section]`` header and
|
||||||
followed by ``name: value`` entries, with continuations in the style of
|
followed by ``name: value`` entries, with continuations in the style of
|
||||||
|
|
|
@ -16,9 +16,9 @@ resource used for the dialog, provided that the dialog items correspond (both
|
||||||
type and item number) to those in the default :const:`DLOG` resource. See source
|
type and item number) to those in the default :const:`DLOG` resource. See source
|
||||||
code for details.
|
code for details.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
The :mod:`EasyDialogs` module defines the following functions:
|
The :mod:`EasyDialogs` module defines the following functions:
|
||||||
|
|
|
@ -150,7 +150,7 @@ and the backup file remains around; by default, the extension is ``'.bak'`` and
|
||||||
it is deleted when the output file is closed. In-place filtering is disabled
|
it is deleted when the output file is closed. In-place filtering is disabled
|
||||||
when standard input is read.
|
when standard input is read.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The current implementation does not work for MS-DOS 8+3 filesystems.
|
The current implementation does not work for MS-DOS 8+3 filesystems.
|
||||||
|
|
||||||
|
|
|
@ -16,9 +16,9 @@ often be done on various different levels, i.e. to handle clicks in a single
|
||||||
dialog window in a non-standard way it is not necessary to override the complete
|
dialog window in a non-standard way it is not necessary to override the complete
|
||||||
event handling.
|
event handling.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
Work on the :mod:`FrameWork` has pretty much stopped, now that :mod:`PyObjC` is
|
Work on the :mod:`FrameWork` has pretty much stopped, now that :mod:`PyObjC` is
|
||||||
available for full Cocoa access from Python, and the documentation describes
|
available for full Cocoa access from Python, and the documentation describes
|
||||||
|
|
|
@ -364,7 +364,7 @@ available. They are listed here in alphabetical order.
|
||||||
If both dictionaries are omitted, the expression is executed in the environment
|
If both dictionaries are omitted, the expression is executed in the environment
|
||||||
where :func:`execfile` is called. The return value is ``None``.
|
where :func:`execfile` is called. The return value is ``None``.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The default *locals* act as described for function :func:`locals` below:
|
The default *locals* act as described for function :func:`locals` below:
|
||||||
modifications to the default *locals* dictionary should not be attempted. Pass
|
modifications to the default *locals* dictionary should not be attempted. Pass
|
||||||
|
@ -625,7 +625,7 @@ available. They are listed here in alphabetical order.
|
||||||
|
|
||||||
Update and return a dictionary representing the current local symbol table.
|
Update and return a dictionary representing the current local symbol table.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The contents of this dictionary should not be modified; changes may not affect
|
The contents of this dictionary should not be modified; changes may not affect
|
||||||
the values of local variables used by the interpreter.
|
the values of local variables used by the interpreter.
|
||||||
|
@ -1348,7 +1348,7 @@ available. They are listed here in alphabetical order.
|
||||||
else that has a :attr:`__dict__` attribute), returns a dictionary corresponding
|
else that has a :attr:`__dict__` attribute), returns a dictionary corresponding
|
||||||
to the object's symbol table.
|
to the object's symbol table.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The returned dictionary should not be modified:
|
The returned dictionary should not be modified:
|
||||||
the effects on the corresponding symbol table are undefined. [#]_
|
the effects on the corresponding symbol table are undefined. [#]_
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`gl` --- *Graphics Library* interface
|
:mod:`gl` --- *Graphics Library* interface
|
||||||
==========================================
|
==========================================
|
||||||
|
|
||||||
|
@ -17,9 +16,9 @@ available only on Silicon Graphics machines.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
Some illegal calls to the GL library cause the Python interpreter to dump core.
|
Some illegal calls to the GL library cause the Python interpreter to dump
|
||||||
In particular, the use of most GL calls is unsafe before the first window is
|
core. In particular, the use of most GL calls is unsafe before the first
|
||||||
opened.
|
window is opened.
|
||||||
|
|
||||||
The module is too large to document here in its entirety, but the following
|
The module is too large to document here in its entirety, but the following
|
||||||
should help you to get started. The parameter conventions for the C functions
|
should help you to get started. The parameter conventions for the C functions
|
||||||
|
|
|
@ -26,7 +26,7 @@ in C, it should result in a much smaller performance impact than the existing
|
||||||
The results should be more meaningful than in the past: the timing core
|
The results should be more meaningful than in the past: the timing core
|
||||||
contained a critical bug.
|
contained a critical bug.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The :mod:`hotshot` profiler does not yet work well with threads. It is useful to
|
The :mod:`hotshot` profiler does not yet work well with threads. It is useful to
|
||||||
use an unthreaded script to run the profiler over the code you're interested in
|
use an unthreaded script to run the profiler over the code you're interested in
|
||||||
|
|
|
@ -68,9 +68,9 @@ The module provides the following classes:
|
||||||
formatted file that contains your private key. *cert_file* is a PEM formatted
|
formatted file that contains your private key. *cert_file* is a PEM formatted
|
||||||
certificate chain file.
|
certificate chain file.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This does not do any certificate verification!
|
This does not do any certificate verification.
|
||||||
|
|
||||||
.. versionadded:: 2.0
|
.. versionadded:: 2.0
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`ic` --- Access to the Mac OS X Internet Config
|
:mod:`ic` --- Access to the Mac OS X Internet Config
|
||||||
====================================================
|
====================================================
|
||||||
|
|
||||||
|
@ -11,9 +10,9 @@
|
||||||
This module provides access to various internet-related preferences set through
|
This module provides access to various internet-related preferences set through
|
||||||
:program:`System Preferences` or the :program:`Finder`.
|
:program:`System Preferences` or the :program:`Finder`.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
.. index:: module: icglue
|
.. index:: module: icglue
|
||||||
|
|
|
@ -510,7 +510,7 @@ six items: the frame object, the filename, the line number of the current line,
|
||||||
the function name, a list of lines of context from the source code, and the
|
the function name, a list of lines of context from the source code, and the
|
||||||
index of the current line within that list.
|
index of the current line within that list.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Keeping references to frame objects, as found in the first element of the frame
|
Keeping references to frame objects, as found in the first element of the frame
|
||||||
records these functions return, can cause your program to create reference
|
records these functions return, can cause your program to create reference
|
||||||
|
|
|
@ -398,7 +398,7 @@ descriptions are taken from the corresponding description in the GNU C library.
|
||||||
|
|
||||||
Return name of the n-th day of the week.
|
Return name of the n-th day of the week.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This follows the US convention of :const:`DAY_1` being Sunday, not the
|
This follows the US convention of :const:`DAY_1` being Sunday, not the
|
||||||
international convention (ISO 8601) that Monday is the first day of the week.
|
international convention (ISO 8601) that Monday is the first day of the week.
|
||||||
|
@ -434,7 +434,7 @@ descriptions are taken from the corresponding description in the GNU C library.
|
||||||
Return a regular expression that can be used with the regex function to
|
Return a regular expression that can be used with the regex function to
|
||||||
recognize a positive response to a yes/no question.
|
recognize a positive response to a yes/no question.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The expression is in the syntax suitable for the :cfunc:`regex` function from
|
The expression is in the syntax suitable for the :cfunc:`regex` function from
|
||||||
the C library, which might differ from the syntax used in :mod:`re`.
|
the C library, which might differ from the syntax used in :mod:`re`.
|
||||||
|
|
|
@ -10,9 +10,9 @@ See the chapters :ref:`mac-scripting` and :ref:`undoc-mac-modules` for more
|
||||||
modules, and the HOWTO :ref:`using-on-mac` for a general introduction to
|
modules, and the HOWTO :ref:`using-on-mac` for a general introduction to
|
||||||
Mac-specific Python programming.
|
Mac-specific Python programming.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
These modules are deprecated and are removed in 3.0.
|
These modules are deprecated and have been removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
|
@ -11,9 +11,9 @@ This module provides access to MacOS specific functionality in the Python
|
||||||
interpreter, such as how the interpreter eventloop functions and the like. Use
|
interpreter, such as how the interpreter eventloop functions and the like. Use
|
||||||
with care.
|
with care.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.x.
|
||||||
|
|
||||||
Note the capitalization of the module name; this is a historical artifact.
|
Note the capitalization of the module name; this is a historical artifact.
|
||||||
|
|
||||||
|
|
|
@ -13,9 +13,9 @@ Macintosh. All file parameters can be specified as pathnames, :class:`FSRef` or
|
||||||
:class:`FSSpec` objects. This module expects a filesystem which supports forked
|
:class:`FSSpec` objects. This module expects a filesystem which supports forked
|
||||||
files, so it should not be used on UFS partitions.
|
files, so it should not be used on UFS partitions.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This module is removed in 3.0.
|
This module has been removed in Python 3.0.
|
||||||
|
|
||||||
The :mod:`macostools` module defines the following functions:
|
The :mod:`macostools` module defines the following functions:
|
||||||
|
|
||||||
|
|
|
@ -85,7 +85,7 @@ The module defines these functions:
|
||||||
file must be an open file object opened in binary mode (``'rb'`` or
|
file must be an open file object opened in binary mode (``'rb'`` or
|
||||||
``'r+b'``).
|
``'r+b'``).
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
If an object containing an unsupported type was marshalled with :func:`dump`,
|
If an object containing an unsupported type was marshalled with :func:`dump`,
|
||||||
:func:`load` will substitute ``None`` for the unmarshallable type.
|
:func:`load` will substitute ``None`` for the unmarshallable type.
|
||||||
|
|
|
@ -10,7 +10,7 @@ This module implements some useful functions on pathnames. To read or
|
||||||
write files see :func:`open`, and for accessing the filesystem see the
|
write files see :func:`open`, and for accessing the filesystem see the
|
||||||
:mod:`os` module.
|
:mod:`os` module.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
On Windows, many of these functions do not properly support UNC pathnames.
|
On Windows, many of these functions do not properly support UNC pathnames.
|
||||||
:func:`splitunc` and :func:`ismount` do handle them correctly.
|
:func:`splitunc` and :func:`ismount` do handle them correctly.
|
||||||
|
@ -317,7 +317,7 @@ write files see :func:`open`, and for accessing the filesystem see the
|
||||||
identify them with ``os.path.islink(file)`` and ``os.path.isdir(file)``, and
|
identify them with ``os.path.islink(file)`` and ``os.path.isdir(file)``, and
|
||||||
invoke :func:`walk` as necessary.
|
invoke :func:`walk` as necessary.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
This function is deprecated and has been removed in 3.0 in favor of
|
This function is deprecated and has been removed in 3.0 in favor of
|
||||||
:func:`os.walk`.
|
:func:`os.walk`.
|
||||||
|
|
|
@ -77,8 +77,8 @@ The :mod:`pickle` module differs from :mod:`marshal` several significant ways:
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
The :mod:`pickle` module is not intended to be secure against erroneous or
|
The :mod:`pickle` module is not intended to be secure against erroneous or
|
||||||
maliciously constructed data. Never unpickle data received from an untrusted or
|
maliciously constructed data. Never unpickle data received from an untrusted
|
||||||
unauthenticated source.
|
or unauthenticated source.
|
||||||
|
|
||||||
Note that serialization is a more primitive notion than persistence; although
|
Note that serialization is a more primitive notion than persistence; although
|
||||||
:mod:`pickle` reads and writes file objects, it does not handle the issue of
|
:mod:`pickle` reads and writes file objects, it does not handle the issue of
|
||||||
|
@ -453,7 +453,7 @@ Pickling and unpickling normal class instances
|
||||||
:meth:`__getstate__` and :meth:`__setstate__`, the state object needn't be a
|
:meth:`__getstate__` and :meth:`__setstate__`, the state object needn't be a
|
||||||
dictionary and these methods can do what they want. [#]_
|
dictionary and these methods can do what they want. [#]_
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
For :term:`new-style class`\es, if :meth:`__getstate__` returns a false
|
For :term:`new-style class`\es, if :meth:`__getstate__` returns a false
|
||||||
value, the :meth:`__setstate__` method will not be called.
|
value, the :meth:`__setstate__` method will not be called.
|
||||||
|
|
|
@ -75,10 +75,9 @@ This module defines the following functions:
|
||||||
Read a plist from the resource with type *restype* from the resource fork of
|
Read a plist from the resource with type *restype* from the resource fork of
|
||||||
*path*. Availability: Mac OS X.
|
*path*. Availability: Mac OS X.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
In 3.0, this function is removed.
|
|
||||||
|
|
||||||
|
In Python 3.x, this function has been removed.
|
||||||
|
|
||||||
|
|
||||||
.. function:: writePlistToResource(rootObject, path[, restype='plst'[, resid=0]])
|
.. function:: writePlistToResource(rootObject, path[, restype='plst'[, resid=0]])
|
||||||
|
@ -86,9 +85,9 @@ This module defines the following functions:
|
||||||
Write *rootObject* as a resource with type *restype* to the resource fork of
|
Write *rootObject* as a resource with type *restype* to the resource fork of
|
||||||
*path*. Availability: Mac OS X.
|
*path*. Availability: Mac OS X.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
In 3.0, this function is removed.
|
In Python 3.x, this function has been removed.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`rexec` --- Restricted execution framework
|
:mod:`rexec` --- Restricted execution framework
|
||||||
===============================================
|
===============================================
|
||||||
|
|
||||||
|
|
|
@ -592,7 +592,7 @@ They are not available as string methods.
|
||||||
map each character in *from* into the character at the same position in *to*;
|
map each character in *from* into the character at the same position in *to*;
|
||||||
*from* and *to* must have the same length.
|
*from* and *to* must have the same length.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Don't use strings derived from :const:`lowercase` and :const:`uppercase` as
|
Don't use strings derived from :const:`lowercase` and :const:`uppercase` as
|
||||||
arguments; in some locales, these don't have the same length. For case
|
arguments; in some locales, these don't have the same length. For case
|
||||||
|
|
|
@ -276,10 +276,10 @@ The following attributes are also available:
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
Use :meth:`communicate` rather than :meth:`.stdin.write`,
|
Use :meth:`communicate` rather than :attr:`.stdin.write <stdin>`,
|
||||||
:meth:`.stdout.read` or :meth:`.stderr.read` to avoid deadlocks due
|
:attr:`.stdout.read <stdout>` or :attr:`.stderr.read <stderr>` to avoid
|
||||||
to any of the other OS pipe buffers filling up and blocking the child
|
deadlocks due to any of the other OS pipe buffers filling up and blocking the
|
||||||
process.
|
child process.
|
||||||
|
|
||||||
|
|
||||||
.. attribute:: Popen.stdin
|
.. attribute:: Popen.stdin
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`tabnanny` --- Detection of ambiguous indentation
|
:mod:`tabnanny` --- Detection of ambiguous indentation
|
||||||
======================================================
|
======================================================
|
||||||
|
|
||||||
|
@ -14,7 +13,7 @@ For the time being this module is intended to be called as a script. However it
|
||||||
is possible to import it into an IDE and use the function :func:`check`
|
is possible to import it into an IDE and use the function :func:`check`
|
||||||
described below.
|
described below.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
The API provided by this module is likely to change in future releases; such
|
The API provided by this module is likely to change in future releases; such
|
||||||
changes may not be backward compatible.
|
changes may not be backward compatible.
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`traceback` --- Print or retrieve a stack traceback
|
:mod:`traceback` --- Print or retrieve a stack traceback
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
|
@ -275,10 +274,10 @@ The following example shows the different ways to print and format the stack::
|
||||||
This last example demonstrates the final few formatting functions::
|
This last example demonstrates the final few formatting functions::
|
||||||
|
|
||||||
>>> import traceback
|
>>> import traceback
|
||||||
>>> format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
|
>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
|
||||||
... ('eggs.py', 42, 'eggs', 'return "bacon"')])
|
... ('eggs.py', 42, 'eggs', 'return "bacon"')])
|
||||||
[' File "spam.py", line 3, in <module>\n spam.eggs()\n',
|
[' File "spam.py", line 3, in <module>\n spam.eggs()\n',
|
||||||
' File "eggs.py", line 42, in eggs\n return "bacon"\n']
|
' File "eggs.py", line 42, in eggs\n return "bacon"\n']
|
||||||
>>> theError = IndexError('tuple indx out of range')
|
>>> an_error = IndexError('tuple index out of range')
|
||||||
>>> traceback.format_exception_only(type(theError), theError)
|
>>> traceback.format_exception_only(type(an_error), an_error)
|
||||||
['IndexError: tuple index out of range\n']
|
['IndexError: tuple index out of range\n']
|
||||||
|
|
|
@ -20,9 +20,8 @@ Miscellaneous useful utilities
|
||||||
Some of these are very old and/or not very robust; marked with "hmm."
|
Some of these are very old and/or not very robust; marked with "hmm."
|
||||||
|
|
||||||
:mod:`ihooks`
|
:mod:`ihooks`
|
||||||
--- Import hook support (for :mod:`rexec`; may become obsolete).
|
--- Import hook support (for :mod:`rexec`; may become obsolete). Removed in
|
||||||
|
Python 3.x.
|
||||||
.. warning:: The :mod:`ihooks` module has been removed in Python 3.0.
|
|
||||||
|
|
||||||
|
|
||||||
Platform specific modules
|
Platform specific modules
|
||||||
|
@ -47,27 +46,19 @@ Multimedia
|
||||||
==========
|
==========
|
||||||
|
|
||||||
:mod:`audiodev`
|
:mod:`audiodev`
|
||||||
--- Platform-independent API for playing audio data.
|
--- Platform-independent API for playing audio data. Removed in Python 3.x.
|
||||||
|
|
||||||
.. warning:: The :mod:`audiodev` module has been removed in 3.0.
|
|
||||||
|
|
||||||
:mod:`linuxaudiodev`
|
:mod:`linuxaudiodev`
|
||||||
--- Play audio data on the Linux audio device. Replaced in Python 2.3 by the
|
--- Play audio data on the Linux audio device. Replaced in Python 2.3 by the
|
||||||
:mod:`ossaudiodev` module.
|
:mod:`ossaudiodev` module. Removed in Python 3.x.
|
||||||
|
|
||||||
.. warning:: The :mod:`linuxaudiodev` module has been removed in Python 3.0.
|
|
||||||
|
|
||||||
:mod:`sunaudio`
|
:mod:`sunaudio`
|
||||||
--- Interpret Sun audio headers (may become obsolete or a tool/demo).
|
--- Interpret Sun audio headers (may become obsolete or a tool/demo).
|
||||||
|
Removed in Python 3.x.
|
||||||
.. warning:: The :mod:`sunaudio` module has been removed in Python 3.0.
|
|
||||||
|
|
||||||
:mod:`toaiff`
|
:mod:`toaiff`
|
||||||
--- Convert "arbitrary" sound files to AIFF files; should probably become a tool
|
--- Convert "arbitrary" sound files to AIFF files; should probably become a tool
|
||||||
or demo. Requires the external program :program:`sox`.
|
or demo. Requires the external program :program:`sox`. Removed in Python 3.x.
|
||||||
|
|
||||||
|
|
||||||
.. warning:: The :mod:`toaiff` module has been removed in 3.0.
|
|
||||||
|
|
||||||
|
|
||||||
.. _undoc-mac-modules:
|
.. _undoc-mac-modules:
|
||||||
|
@ -239,9 +230,8 @@ extensions.
|
||||||
\envvar{PYTHONPATH}.
|
\envvar{PYTHONPATH}.
|
||||||
|
|
||||||
:mod:`timing`
|
:mod:`timing`
|
||||||
--- Measure time intervals to high resolution (use :func:`time.clock` instead).
|
--- Measure time intervals to high resolution (use :func:`time.clock`
|
||||||
|
instead). Removed in Python 3.x.
|
||||||
.. warning:: The :mod:`timing` module has been removed in Python 3.0.
|
|
||||||
|
|
||||||
|
|
||||||
SGI-specific Extension modules
|
SGI-specific Extension modules
|
||||||
|
@ -255,6 +245,4 @@ of reality.
|
||||||
|
|
||||||
:mod:`sv`
|
:mod:`sv`
|
||||||
--- Interface to the "simple video" board on SGI Indigo (obsolete hardware).
|
--- Interface to the "simple video" board on SGI Indigo (obsolete hardware).
|
||||||
|
Removed in Python 3.x.
|
||||||
.. warning:: The :mod:`sv` module has been removed in Python 3.0.
|
|
||||||
|
|
||||||
|
|
|
@ -178,7 +178,7 @@ function :func:`range` returns a sequence of integers suitable to emulate the
|
||||||
effect of Pascal's ``for i := a to b do``; e.g., ``range(3)`` returns the list
|
effect of Pascal's ``for i := a to b do``; e.g., ``range(3)`` returns the list
|
||||||
``[0, 1, 2]``.
|
``[0, 1, 2]``.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
.. index::
|
.. index::
|
||||||
single: loop; over mutable sequence
|
single: loop; over mutable sequence
|
||||||
|
|
|
@ -231,7 +231,7 @@ Exceptions can also be identified by strings, in which case the
|
||||||
:keyword:`except` clause is selected by object identity. An arbitrary value can
|
:keyword:`except` clause is selected by object identity. An arbitrary value can
|
||||||
be raised along with the identifying string which can be passed to the handler.
|
be raised along with the identifying string which can be passed to the handler.
|
||||||
|
|
||||||
.. warning::
|
.. note::
|
||||||
|
|
||||||
Messages to exceptions are not part of the Python API. Their contents may
|
Messages to exceptions are not part of the Python API. Their contents may
|
||||||
change from one version of Python to the next without warning and should not be
|
change from one version of Python to the next without warning and should not be
|
||||||
|
|
|
@ -351,7 +351,7 @@ Miscellaneous options
|
||||||
Skip the first line of the source, allowing use of non-Unix forms of
|
Skip the first line of the source, allowing use of non-Unix forms of
|
||||||
``#!cmd``. This is intended for a DOS specific hack only.
|
``#!cmd``. This is intended for a DOS specific hack only.
|
||||||
|
|
||||||
.. warning:: The line numbers in error messages will be off by one!
|
.. note:: The line numbers in error messages will be off by one.
|
||||||
|
|
||||||
|
|
||||||
.. cmdoption:: -3
|
.. cmdoption:: -3
|
||||||
|
|
Loading…
Reference in New Issue