[Python-checkins] r58580 - in python/trunk/Doc: distutils/apiref.rst extending/newtypes.rst glossary.rst howto/functional.rst library/_ast.rst library/ctypes.rst library/pyclbr.rst library/stdtypes.rst tutorial/modules.rst using/cmdline.rst
georg.brandl
python-checkins at python.org
Sun Oct 21 12:45:47 CEST 2007
Author: georg.brandl
Date: Sun Oct 21 12:45:46 2007
New Revision: 58580
Modified:
python/trunk/Doc/distutils/apiref.rst
python/trunk/Doc/extending/newtypes.rst
python/trunk/Doc/glossary.rst
python/trunk/Doc/howto/functional.rst
python/trunk/Doc/library/_ast.rst
python/trunk/Doc/library/ctypes.rst
python/trunk/Doc/library/pyclbr.rst
python/trunk/Doc/library/stdtypes.rst
python/trunk/Doc/tutorial/modules.rst
python/trunk/Doc/using/cmdline.rst
Log:
Add :term:s for descriptors.
Modified: python/trunk/Doc/distutils/apiref.rst
==============================================================================
--- python/trunk/Doc/distutils/apiref.rst (original)
+++ python/trunk/Doc/distutils/apiref.rst Sun Oct 21 12:45:46 2007
@@ -1199,7 +1199,7 @@
If *force* is true, all files are recompiled regardless of timestamps.
- The source filename encoded in each bytecode file defaults to the filenames
+ The source filename encoded in each :term:`bytecode` file defaults to the filenames
listed in *py_files*; you can modify these with *prefix* and *basedir*.
*prefix* is a string that will be stripped off of each source filename, and
*base_dir* is a directory name that will be prepended (after *prefix* is
Modified: python/trunk/Doc/extending/newtypes.rst
==============================================================================
--- python/trunk/Doc/extending/newtypes.rst (original)
+++ python/trunk/Doc/extending/newtypes.rst Sun Oct 21 12:45:46 2007
@@ -1149,7 +1149,7 @@
attributes, when the values are computed, or how relevant data is stored.
When :cfunc:`PyType_Ready` is called, it uses three tables referenced by the
-type object to create *descriptors* which are placed in the dictionary of the
+type object to create :term:`descriptor`\s which are placed in the dictionary of the
type object. Each descriptor controls access to one attribute of the instance
object. Each of the tables is optional; if all three are *NULL*, instances of
the type will only have attributes that are inherited from their base type, and
@@ -1193,7 +1193,7 @@
char *doc;
} PyMemberDef;
-For each entry in the table, a descriptor will be constructed and added to the
+For each entry in the table, a :term:`descriptor` will be constructed and added to the
type which will be able to extract a value from the instance structure. The
:attr:`type` field should contain one of the type codes defined in the
:file:`structmember.h` header; the value will be used to determine how to
Modified: python/trunk/Doc/glossary.rst
==============================================================================
--- python/trunk/Doc/glossary.rst (original)
+++ python/trunk/Doc/glossary.rst Sun Oct 21 12:45:46 2007
@@ -59,14 +59,16 @@
descriptor
Any *new-style* object that defines the methods :meth:`__get__`,
- :meth:`__set__`, or :meth:`__delete__`. When a class attribute is a
+ :meth:`__set__`, or :meth:`__delete__`. When a class attribute is a
descriptor, its special binding behavior is triggered upon attribute
- lookup. Normally, writing *a.b* looks up the object *b* in the class
- dictionary for *a*, but if *b* is a descriptor, the defined method gets
- called. Understanding descriptors is a key to a deep understanding of
- Python because they are the basis for many features including functions,
- methods, properties, class methods, static methods, and reference to super
- classes.
+ lookup. Normally, using *a.b* to get, set or delete an attribute looks up
+ the object named *b* in the class dictionary for *a*, but if *b* is a
+ descriptor, the respective descriptor method gets called. Understanding
+ descriptors is a key to a deep understanding of Python because they are
+ the basis for many features including functions, methods, properties,
+ class methods, static methods, and reference to super classes.
+
+ For more information about descriptors' methods, see :ref:`descriptors`.
dictionary
An associative array, where arbitrary keys are mapped to values. The use
Modified: python/trunk/Doc/howto/functional.rst
==============================================================================
--- python/trunk/Doc/howto/functional.rst (original)
+++ python/trunk/Doc/howto/functional.rst Sun Oct 21 12:45:46 2007
@@ -448,8 +448,8 @@
yield i
Any function containing a ``yield`` keyword is a generator function; this is
-detected by Python's :term:`bytecode` compiler which compiles the function specially as
-a result.
+detected by Python's :term:`bytecode` compiler which compiles the function
+specially as a result.
When you call a generator function, it doesn't return a single value; instead it
returns a generator object that supports the iterator protocol. On executing
Modified: python/trunk/Doc/library/_ast.rst
==============================================================================
--- python/trunk/Doc/library/_ast.rst (original)
+++ python/trunk/Doc/library/_ast.rst Sun Oct 21 12:45:46 2007
@@ -14,7 +14,7 @@
The ``_ast`` module helps Python applications to process trees of the Python
abstract syntax grammar. The Python compiler currently provides read-only access
to such trees, meaning that applications can only create a tree for a given
-piece of Python source code; generating byte code from a (potentially modified)
+piece of Python source code; generating :term:`bytecode` from a (potentially modified)
tree is not supported. The abstract syntax itself might change with each Python
release; this module helps to find out programmatically what the current grammar
looks like.
Modified: python/trunk/Doc/library/ctypes.rst
==============================================================================
--- python/trunk/Doc/library/ctypes.rst (original)
+++ python/trunk/Doc/library/ctypes.rst Sun Oct 21 12:45:46 2007
@@ -586,8 +586,8 @@
>>> r = RECT(POINT(1, 2), POINT(3, 4))
>>> r = RECT((1, 2), (3, 4))
-Fields descriptors can be retrieved from the *class*, they are useful for
-debugging because they can provide useful information::
+Field :term:`descriptor`\s can be retrieved from the *class*, they are useful
+for debugging because they can provide useful information::
>>> print POINT.x
<Field type=c_long, ofs=0, size=4>
@@ -1197,10 +1197,10 @@
>>>
Why is it printing ``False``? ctypes instances are objects containing a memory
-block plus some descriptors accessing the contents of the memory. Storing a
-Python object in the memory block does not store the object itself, instead the
-``contents`` of the object is stored. Accessing the contents again constructs a
-new Python each time!
+block plus some :term:`descriptor`\s accessing the contents of the memory.
+Storing a Python object in the memory block does not store the object itself,
+instead the ``contents`` of the object is stored. Accessing the contents again
+constructs a new Python object each time!
.. _ctypes-variable-sized-data-types:
@@ -2267,7 +2267,7 @@
Concrete structure and union types must be created by subclassing one of these
types, and at least define a :attr:`_fields_` class variable. ``ctypes`` will
-create descriptors which allow reading and writing the fields by direct
+create :term:`descriptor`\s which allow reading and writing the fields by direct
attribute accesses. These are the
Modified: python/trunk/Doc/library/pyclbr.rst
==============================================================================
--- python/trunk/Doc/library/pyclbr.rst (original)
+++ python/trunk/Doc/library/pyclbr.rst Sun Oct 21 12:45:46 2007
@@ -19,10 +19,10 @@
.. function:: readmodule(module[, path])
Read a module and return a dictionary mapping class names to class descriptor
- objects. The parameter *module* should be the name of a module as a string; it
- may be the name of a module within a package. The *path* parameter should be a
- sequence, and is used to augment the value of ``sys.path``, which is used to
- locate module source code.
+ objects. The parameter *module* should be the name of a module as a string;
+ it may be the name of a module within a package. The *path* parameter should
+ be a sequence, and is used to augment the value of ``sys.path``, which is
+ used to locate module source code.
.. % The 'inpackage' parameter appears to be for internal use only....
Modified: python/trunk/Doc/library/stdtypes.rst
==============================================================================
--- python/trunk/Doc/library/stdtypes.rst (original)
+++ python/trunk/Doc/library/stdtypes.rst Sun Oct 21 12:45:46 2007
@@ -1899,8 +1899,7 @@
.. method:: file.fileno()
.. index::
- single: file descriptor
- single: descriptor, file
+ pair: file; descriptor
module: fcntl
Return the integer "file descriptor" that is used by the underlying
Modified: python/trunk/Doc/tutorial/modules.rst
==============================================================================
--- python/trunk/Doc/tutorial/modules.rst (original)
+++ python/trunk/Doc/tutorial/modules.rst Sun Oct 21 12:45:46 2007
@@ -186,8 +186,8 @@
* When the Python interpreter is invoked with the :option:`-O` flag, optimized
code is generated and stored in :file:`.pyo` files. The optimizer currently
doesn't help much; it only removes :keyword:`assert` statements. When
- :option:`-O` is used, *all* bytecode is optimized; ``.pyc`` files are ignored
- and ``.py`` files are compiled to optimized bytecode.
+ :option:`-O` is used, *all* :term:`bytecode` is optimized; ``.pyc`` files are
+ ignored and ``.py`` files are compiled to optimized bytecode.
* Passing two :option:`-O` flags to the Python interpreter (:option:`-OO`) will
cause the bytecode compiler to perform optimizations that could in some rare
Modified: python/trunk/Doc/using/cmdline.rst
==============================================================================
--- python/trunk/Doc/using/cmdline.rst (original)
+++ python/trunk/Doc/using/cmdline.rst Sun Oct 21 12:45:46 2007
@@ -169,7 +169,7 @@
.. cmdoption:: -O
Turn on basic optimizations. This changes the filename extension for
- compiled (:term:`byte code`) files from ``.pyc`` to ``.pyo``. See also
+ compiled (:term:`bytecode`) files from ``.pyc`` to ``.pyo``. See also
:envvar:`PYTHONOPTIMIZE`.
More information about the Python-checkins
mailing list