diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/Makefile | 8 | ||||
| -rw-r--r-- | Doc/glossary.rst | 15 | ||||
| -rw-r--r-- | Doc/library/abc.rst | 8 | ||||
| -rw-r--r-- | Doc/library/collections.rst | 4 | ||||
| -rw-r--r-- | Doc/library/msilib.rst | 9 | ||||
| -rw-r--r-- | Doc/library/rlcompleter.rst | 6 | ||||
| -rw-r--r-- | Doc/library/subprocess.rst | 4 | ||||
| -rw-r--r-- | Doc/reference/compound_stmts.rst | 8 | ||||
| -rw-r--r-- | Doc/reference/expressions.rst | 6 |
9 files changed, 43 insertions, 25 deletions
diff --git a/Doc/Makefile b/Doc/Makefile index c1abe11..470337b 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -33,15 +33,15 @@ checkout: fi @if [ ! -d tools/docutils ]; then \ echo "Checking out Docutils..."; \ - svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \ + svn checkout $(SVNROOT)/external/docutils-0.5/docutils tools/docutils; \ fi @if [ ! -d tools/jinja ]; then \ echo "Checking out Jinja..."; \ - svn checkout $(SVNROOT)/external/Jinja-1.1/jinja tools/jinja; \ + svn checkout $(SVNROOT)/external/Jinja-1.2/jinja tools/jinja; \ fi @if [ ! -d tools/pygments ]; then \ echo "Checking out Pygments..."; \ - svn checkout $(SVNROOT)/external/Pygments-0.9/pygments tools/pygments; \ + svn checkout $(SVNROOT)/external/Pygments-0.10/pygments tools/pygments; \ fi update: checkout @@ -103,6 +103,8 @@ pydoc-topics: build @echo "Building finished; now copy build/pydoc-topics/pydoc_topics.py " \ "into the Lib/ directory" +htmlview: html + $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')" clean: -rm -rf build/* -rm -rf tools/sphinx diff --git a/Doc/glossary.rst b/Doc/glossary.rst index cd8b7ac..3caa36e 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -16,6 +16,14 @@ Glossary The typical Python prompt of the interactive shell when entering code for an indented code block. + Abstract Base Class + Abstract Base Classes (abbreviated ABCs) complement :term:`duck-typing` by + providing a way to define interfaces when other techniques like :func:`hasattr` + would be clumsy. Python comes with many builtin ABCs for data structures + (in the :mod:`collections` module), numbers (in the :mod:`numbers` + module), and streams (in the :mod:`io` module). You can create your own + ABC with the :mod:`abc` module. + argument A value passed to a function or method, assigned to a name local to the body. A function or method may have both positional arguments and @@ -93,15 +101,16 @@ Glossary be any object with a :meth:`__hash__` function, not just integers starting from zero. Called a hash in Perl. - duck-typing + duck-typing Pythonic programming style that determines an object's type by inspection of its method or attribute signature rather than by explicit relationship to some type object ("If it looks like a duck and quacks like a duck, it must be a duck.") By emphasizing interfaces rather than specific types, well-designed code improves its flexibility by allowing polymorphic substitution. Duck-typing avoids tests using :func:`type` or - :func:`isinstance`. Instead, it typically employs :func:`hasattr` tests or - :term:`EAFP` programming. + :func:`isinstance`. (Note, however, that duck-typing can be complemented + with abstract base classes.) Instead, it typically employs :func:`hasattr` + tests or :term:`EAFP` programming. EAFP Easier to ask for forgiveness than permission. This common Python coding diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index f1a6c06..21d3018 100644 --- a/Doc/library/abc.rst +++ b/Doc/library/abc.rst @@ -8,10 +8,10 @@ .. sectionauthor:: Georg Brandl .. much of the content adapted from docstrings -This module provides the infrastructure for defining abstract base classes -(ABCs) in Python, as outlined in :pep:`3119`; see the PEP for why this was added -to Python. (See also :pep:`3141` and the :mod:`numbers` module regarding a type -hierarchy for numbers based on ABCs.) +This module provides the infrastructure for defining :term:`abstract base +classes` (ABCs) in Python, as outlined in :pep:`3119`; see the PEP for why this +was added to Python. (See also :pep:`3141` and the :mod:`numbers` module +regarding a type hierarchy for numbers based on ABCs.) The :mod:`collections` module has some concrete classes that derive from ABCs; these can, of course, be further derived. In addition the diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index 3203ca5..7718c51 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -520,8 +520,8 @@ Example: raise ValueError('Got unexpected field names: %r' % kwds.keys()) return result <BLANKLINE> - def __getnewargs__(self): - return tuple(self) + def __getnewargs__(self): + return tuple(self) <BLANKLINE> x = property(itemgetter(0)) y = property(itemgetter(1)) diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst index eb58d44..d0a53d7 100644 --- a/Doc/library/msilib.rst +++ b/Doc/library/msilib.rst @@ -1,4 +1,3 @@ - :mod:`msilib` --- Read and write Microsoft Installer files ========================================================== @@ -163,11 +162,11 @@ View Objects ------------ -.. method:: View.Execute([params=None]) +.. method:: View.Execute(params) - Execute the SQL query of the view, through :cfunc:`MSIViewExecute`. *params* is - an optional record describing actual values of the parameter tokens in the - query. + Execute the SQL query of the view, through :cfunc:`MSIViewExecute`. If + *params* is not ``None``, it is a record describing actual values of the + parameter tokens in the query. .. method:: View.GetColumnInfo(kind) diff --git a/Doc/library/rlcompleter.rst b/Doc/library/rlcompleter.rst index 01efb03..b09df54 100644 --- a/Doc/library/rlcompleter.rst +++ b/Doc/library/rlcompleter.rst @@ -20,9 +20,9 @@ Example:: >>> import readline >>> readline.parse_and_bind("tab: complete") >>> readline. <TAB PRESSED> - readline.__doc__ readline.get_line_buffer readline.read_init_file - readline.__file__ readline.insert_text readline.set_completer - readline.__name__ readline.parse_and_bind + readline.__doc__ readline.get_line_buffer( readline.read_init_file( + readline.__file__ readline.insert_text( readline.set_completer( + readline.__name__ readline.parse_and_bind( >>> readline. The :mod:`rlcompleter` module is designed for use with Python's interactive diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index ba2a5a1..daa88b3 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -18,6 +18,10 @@ replace several other, older modules and functions, such as:: Information about how the :mod:`subprocess` module can be used to replace these modules and functions can be found in the following sections. +.. seealso:: + + :pep:`324` -- PEP proposing the subprocess module + Using the subprocess Module --------------------------- diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst index c5b949e..a3665e7 100644 --- a/Doc/reference/compound_stmts.rst +++ b/Doc/reference/compound_stmts.rst @@ -583,10 +583,10 @@ variables with different implementation details. :pep:`3129` - Class Decorators -Class definitions, like function definitions, may be wrapped by one or -more :term:`decorator` expressions. The evaluation rules for the -decorator expressions are the same as for functions. The result must -be a class object, which is then bound to the class name. +Class definitions, like function definitions, may be wrapped by one or more +:term:`decorator` expressions. The evaluation rules for the decorator +expressions are the same as for functions. The result must be a class object, +which is then bound to the class name. .. rubric:: Footnotes diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst index af79e53..e205e42 100644 --- a/Doc/reference/expressions.rst +++ b/Doc/reference/expressions.rst @@ -1082,7 +1082,7 @@ The operator :keyword:`not in` is defined to have the inverse true value of The operators :keyword:`is` and :keyword:`is not` test for object identity: ``x is y`` is true if and only if *x* and *y* are the same object. ``x is not y`` -yields the inverse truth value. +yields the inverse truth value. [#]_ .. _booleans: @@ -1314,3 +1314,7 @@ groups from right to left). identity only, but this caused surprises because people expected to be able to test a dictionary for emptiness by comparing it to ``{}``. +.. [#] Due to automatic garbage-collection, free lists, and the dynamic nature of + descriptors, you may notice seemingly unusual behaviour in certain uses of + the :keyword:`is` operator, like those involving comparisons between instance + methods, or constants. Check their documentation for more info. |