Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
cf3fb259
Commit
cf3fb259
authored
Oct 21, 2007
by
Georg Brandl
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add :term: for generators.
parent
bb75e4e5
Changes
17
Hide whitespace changes
Inline
Side-by-side
Showing
17 changed files
with
47 additions
and
46 deletions
+47
-46
Doc/howto/functional.rst
Doc/howto/functional.rst
+2
-2
Doc/library/codecs.rst
Doc/library/codecs.rst
+4
-4
Doc/library/compiler.rst
Doc/library/compiler.rst
+1
-1
Doc/library/contextlib.rst
Doc/library/contextlib.rst
+3
-3
Doc/library/csv.rst
Doc/library/csv.rst
+2
-2
Doc/library/difflib.rst
Doc/library/difflib.rst
+7
-7
Doc/library/dis.rst
Doc/library/dis.rst
+1
-1
Doc/library/exceptions.rst
Doc/library/exceptions.rst
+3
-3
Doc/library/itertools.rst
Doc/library/itertools.rst
+2
-2
Doc/library/os.path.rst
Doc/library/os.path.rst
+2
-2
Doc/library/sqlite3.rst
Doc/library/sqlite3.rst
+1
-1
Doc/library/stdtypes.rst
Doc/library/stdtypes.rst
+5
-5
Doc/library/tokenize.rst
Doc/library/tokenize.rst
+1
-1
Doc/library/types.rst
Doc/library/types.rst
+2
-2
Doc/library/weakref.rst
Doc/library/weakref.rst
+3
-3
Doc/library/xmlrpclib.rst
Doc/library/xmlrpclib.rst
+2
-1
Doc/tutorial/classes.rst
Doc/tutorial/classes.rst
+6
-6
No files found.
Doc/howto/functional.rst
View file @
cf3fb259
...
@@ -13,8 +13,8 @@ disclaimer.)
...
@@ -13,8 +13,8 @@ disclaimer.)
In this document, we'll take a tour of Python's features suitable for
In this document, we'll take a tour of Python's features suitable for
implementing programs in a functional style. After an introduction to the
implementing programs in a functional style. After an introduction to the
concepts of functional programming, we'll look at language features such as
concepts of functional programming, we'll look at language features such as
iterators and
generators and relevant library modules such as :mod:`itertools`
iterators and
:term:`generator`\s and relevant library modules such as
and :mod:`functools`.
:mod:`itertools`
and :mod:`functools`.
Introduction
Introduction
...
...
Doc/library/codecs.rst
View file @
cf3fb259
...
@@ -242,8 +242,8 @@ utility functions:
...
@@ -242,8 +242,8 @@ utility functions:
..
function:: iterencode(iterable, encoding[, errors])
..
function:: iterencode(iterable, encoding[, errors])
Uses an incremental encoder to iteratively encode the input provided by
Uses an incremental encoder to iteratively encode the input provided by
*iterable*. This function is a
generator. *errors* (as well as any other keyword
*iterable*. This function is a
:term:`generator`. *errors* (as well as any
argument) is passed through to the incremental encoder.
other keyword
argument) is passed through to the incremental encoder.
.. versionadded:: 2.5
.. versionadded:: 2.5
...
@@ -251,8 +251,8 @@ utility functions:
...
@@ -251,8 +251,8 @@ utility functions:
..
function:: iterdecode(iterable, encoding[, errors])
..
function:: iterdecode(iterable, encoding[, errors])
Uses an incremental decoder to iteratively decode the input provided by
Uses an incremental decoder to iteratively decode the input provided by
*iterable*. This function is a
generator. *errors* (as well as any other keyword
*iterable*. This function is a
:term:`generator`. *errors* (as well as any
argument) is passed through to the incremental decoder.
other keyword
argument) is passed through to the incremental decoder.
.. versionadded:: 2.5
.. versionadded:: 2.5
...
...
Doc/library/compiler.rst
View file @
cf3fb259
...
@@ -640,5 +640,5 @@ The code generator is a visitor that emits bytecodes. Each visit method can
...
@@ -640,5 +640,5 @@ The code generator is a visitor that emits bytecodes. Each visit method can
call the :meth:`emit` method to emit a new bytecode. The basic code generator
call the :meth:`emit` method to emit a new bytecode. The basic code generator
is specialized for modules, classes, and functions. An assembler converts that
is specialized for modules, classes, and functions. An assembler converts that
emitted instructions to the low-level bytecode format. It handles things like
emitted instructions to the low-level bytecode format. It handles things like
generat
or
of constant lists of code objects and calculation of jump offsets.
generat
ion
of constant lists of code objects and calculation of jump offsets.
Doc/library/contextlib.rst
View file @
cf3fb259
...
@@ -39,9 +39,9 @@ Functions provided:
...
@@ -39,9 +39,9 @@ Functions provided:
foo
foo
</h1>
</h1>
The function being decorated must return a
generator-iterator when called. This
The function being decorated must return a
:term:`generator`-iterator when
iterator must yield exactly one value, which will be bound to the targets in the
called. This iterator must yield exactly one value, which will be bound to
:keyword:`with` statement's :keyword:`as` clause, if any.
the targets in the
:keyword:`with` statement's :keyword:`as` clause, if any.
At the point where the generator yields, the block nested in the :keyword:`with`
At the point where the generator yields, the block nested in the :keyword:`with`
statement is executed. The generator is then resumed after the block is exited.
statement is executed. The generator is then resumed after the block is exited.
...
...
Doc/library/csv.rst
View file @
cf3fb259
...
@@ -442,9 +442,9 @@ it is 8-bit-clean save for some problems with ASCII NUL characters. So you can
...
@@ -442,9 +442,9 @@ it is 8-bit-clean save for some problems with ASCII NUL characters. So you can
write functions or classes that handle the encoding and decoding for you as long
write functions or classes that handle the encoding and decoding for you as long
as you avoid encodings like UTF-16 that use NULs. UTF-8 is recommended.
as you avoid encodings like UTF-16 that use NULs. UTF-8 is recommended.
:func:`unicode_csv_reader` below is a
generator
that wraps :class:`csv.reader`
:func:`unicode_csv_reader` below is a
:term:`generator`
that wraps :class:`csv.reader`
to handle Unicode CSV data (a list of Unicode strings). :func:`utf_8_encoder`
to handle Unicode CSV data (a list of Unicode strings). :func:`utf_8_encoder`
is a
generator
that encodes the Unicode strings as UTF-8, one string (or row) at
is a
:term:`generator`
that encodes the Unicode strings as UTF-8, one string (or row) at
a time. The encoded strings are parsed by the CSV reader, and
a time. The encoded strings are parsed by the CSV reader, and
:func:`unicode_csv_reader` decodes the UTF-8-encoded cells back into Unicode::
:func:`unicode_csv_reader` decodes the UTF-8-encoded cells back into Unicode::
...
...
Doc/library/difflib.rst
View file @
cf3fb259
...
@@ -126,8 +126,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
...
@@ -126,8 +126,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
.. function:: context_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])
.. function:: context_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])
Compare *a* and *b* (lists of strings); return a delta (a
generator generating
Compare *a* and *b* (lists of strings); return a delta (a
:term:`generator`
the delta lines) in context diff format.
generating
the delta lines) in context diff format.
Context diffs are a compact way of showing just the lines that have changed plus
Context diffs are a compact way of showing just the lines that have changed plus
a few lines of context. The changes are shown in a before/after style. The
a few lines of context. The changes are shown in a before/after style. The
...
@@ -181,8 +181,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
...
@@ -181,8 +181,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
.. function:: ndiff(a, b[, linejunk][, charjunk])
.. function:: ndiff(a, b[, linejunk][, charjunk])
Compare *a* and *b* (lists of strings); return a :class:`Differ`\ -style
delta
Compare *a* and *b* (lists of strings); return a :class:`Differ`\ -style
(a generator
generating the delta lines).
delta (a :term:`generator`
generating the delta lines).
Optional keyword parameters *linejunk* and *charjunk* are for filter functions
Optional keyword parameters *linejunk* and *charjunk* are for filter functions
(or ``None``):
(or ``None``):
...
@@ -242,8 +242,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
...
@@ -242,8 +242,8 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
.. function:: unified_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])
.. function:: unified_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])
Compare *a* and *b* (lists of strings); return a delta (a
generator generating
Compare *a* and *b* (lists of strings); return a delta (a
:term:`generator`
the delta lines) in unified diff format.
generating
the delta lines) in unified diff format.
Unified diffs are a compact way of showing just the lines that have changed plus
Unified diffs are a compact way of showing just the lines that have changed plus
a few lines of context. The changes are shown in a inline style (instead of
a few lines of context. The changes are shown in a inline style (instead of
...
@@ -442,7 +442,7 @@ use :meth:`set_seq2` to set the commonly used sequence once and call
...
@@ -442,7 +442,7 @@ use :meth:`set_seq2` to set the commonly used sequence once and call
.. method:: SequenceMatcher.get_grouped_opcodes([n])
.. method:: SequenceMatcher.get_grouped_opcodes([n])
Return a
generator
of groups with up to *n* lines of context.
Return a
:term:`generator`
of groups with up to *n* lines of context.
Starting with the groups returned by :meth:`get_opcodes`, this method splits out
Starting with the groups returned by :meth:`get_opcodes`, this method splits out
smaller change clusters and eliminates intervening ranges which have no changes.
smaller change clusters and eliminates intervening ranges which have no changes.
...
...
Doc/library/dis.rst
View file @
cf3fb259
...
@@ -482,7 +482,7 @@ Miscellaneous opcodes.
...
@@ -482,7 +482,7 @@ Miscellaneous opcodes.
.. opcode:: YIELD_VALUE ()
.. opcode:: YIELD_VALUE ()
Pops ``TOS`` and yields it from a
generator
.
Pops ``TOS`` and yields it from a
:term:`generator`
.
.. opcode:: IMPORT_STAR ()
.. opcode:: IMPORT_STAR ()
...
...
Doc/library/exceptions.rst
View file @
cf3fb259
...
@@ -152,9 +152,9 @@ The following exceptions are the exceptions that are actually raised.
...
@@ -152,9 +152,9 @@ The following exceptions are the exceptions that are actually raised.
.. exception:: GeneratorExit
.. exception:: GeneratorExit
Raise when a
generator's :meth:`close` method is called. It directly inherits
Raise when a
:term:`generator`\'s :meth:`close` method is called. It
from :exc:`Exception` instead of :exc:`StandardError` since it is technically
directly inherits from :exc:`Exception` instead of :exc:`StandardError` since
not an error.
it is technically
not an error.
.. versionadded:: 2.5
.. versionadded:: 2.5
...
...
Doc/library/itertools.rst
View file @
cf3fb259
...
@@ -460,8 +460,8 @@ The superior memory performance is kept by processing elements one at a time
...
@@ -460,8 +460,8 @@ The superior memory performance is kept by processing elements one at a time
rather than bringing the whole iterable into memory all at once. Code volume is
rather than bringing the whole iterable into memory all at once. Code volume is
kept small by linking the tools together in a functional style which helps
kept small by linking the tools together in a functional style which helps
eliminate temporary variables. High speed is retained by preferring
eliminate temporary variables. High speed is retained by preferring
"vectorized" building blocks over the use of for-loops and
generators which
"vectorized" building blocks over the use of for-loops and
:term:`generator`\s
incur interpreter overhead. ::
which
incur interpreter overhead. ::
def take(n, seq):
def take(n, seq):
return list(islice(seq, n))
return list(islice(seq, n))
...
...
Doc/library/os.path.rst
View file @
cf3fb259
...
@@ -303,8 +303,8 @@ write files see :func:`open`, and for accessing the filesystem see the
...
@@ -303,8 +303,8 @@ write files see :func:`open`, and for accessing the filesystem see the
.. note::
.. note::
The newer :func:`os.walk`
generator supplies similar functionality and can be
The newer :func:`os.walk`
:term:`generator` supplies similar functionality
easier to use.
and can be
easier to use.
.. data:: supports_unicode_filenames
.. data:: supports_unicode_filenames
...
...
Doc/library/sqlite3.rst
View file @
cf3fb259
...
@@ -416,7 +416,7 @@ A :class:`Cursor` instance has the following attributes and methods:
...
@@ -416,7 +416,7 @@ A :class:`Cursor` instance has the following attributes and methods:
.. literalinclude:: ../includes/sqlite3/executemany_1.py
.. literalinclude:: ../includes/sqlite3/executemany_1.py
Here's a shorter example using a
generator
:
Here's a shorter example using a
:term:`generator`
:
.. literalinclude:: ../includes/sqlite3/executemany_2.py
.. literalinclude:: ../includes/sqlite3/executemany_2.py
...
...
Doc/library/stdtypes.rst
View file @
cf3fb259
...
@@ -479,10 +479,10 @@ Implementations that do not obey this property are deemed broken. (This
...
@@ -479,10 +479,10 @@ Implementations that do not obey this property are deemed broken. (This
constraint was added in Python 2.3; in Python 2.2, various iterators are broken
constraint was added in Python 2.3; in Python 2.2, various iterators are broken
according to this rule.)
according to this rule.)
Python's
generators provide a convenient way to implement the iterator protocol.
Python's
:term:`generator`\s provide a convenient way to implement the iterator
If a container object's :meth:`__iter__` method is implemented as a generator,
protocol. If a container object's :meth:`__iter__` method is implemented as a
it will automatically return an iterator object (technically, a generator
generator, it will automatically return an iterator object (technically, a
object) supplying the :meth:`__iter__` and :meth:`next` methods.
generator
object) supplying the :meth:`__iter__` and :meth:`next` methods.
.. _typesseq:
.. _typesseq:
...
@@ -2183,7 +2183,7 @@ decimal arithmetic context. The specific types are not treated specially beyond
...
@@ -2183,7 +2183,7 @@ decimal arithmetic context. The specific types are not treated specially beyond
their implementation of the context management protocol. See the
their implementation of the context management protocol. See the
:mod:`contextlib` module for some examples.
:mod:`contextlib` module for some examples.
Python's
generator
s and the ``contextlib.contextfactory`` decorator provide a
Python's
:term:`generator`\
s and the ``contextlib.contextfactory`` decorator provide a
convenient way to implement these protocols. If a generator function is
convenient way to implement these protocols. If a generator function is
decorated with the ``contextlib.contextfactory`` decorator, it will return a
decorated with the ``contextlib.contextfactory`` decorator, it will return a
context manager implementing the necessary :meth:`__enter__` and
context manager implementing the necessary :meth:`__enter__` and
...
...
Doc/library/tokenize.rst
View file @
cf3fb259
...
@@ -13,7 +13,7 @@ implemented in Python. The scanner in this module returns comments as tokens as
...
@@ -13,7 +13,7 @@ implemented in Python. The scanner in this module returns comments as tokens as
well, making it useful for implementing "pretty-printers," including colorizers
well, making it useful for implementing "pretty-printers," including colorizers
for on-screen displays.
for on-screen displays.
The primary entry point is a
generator
:
The primary entry point is a
:term:`generator`
:
.. function:: generate_tokens(readline)
.. function:: generate_tokens(readline)
...
...
Doc/library/types.rst
View file @
cf3fb259
...
@@ -128,8 +128,8 @@ The module defines the following names:
...
@@ -128,8 +128,8 @@ The module defines the following names:
.. data:: GeneratorType
.. data:: GeneratorType
The type of
generator-iterator objects, produced by calling a generator
The type of
:term:`generator`-iterator objects, produced by calling a
function.
generator
function.
.. versionadded:: 2.2
.. versionadded:: 2.2
...
...
Doc/library/weakref.rst
View file @
cf3fb259
...
@@ -50,9 +50,9 @@ benefit of advanced uses.
...
@@ -50,9 +50,9 @@ benefit of advanced uses.
Not all objects can be weakly referenced; those objects which can include class
Not all objects can be weakly referenced; those objects which can include class
instances, functions written in Python (but not in C), methods (both bound and
instances, functions written in Python (but not in C), methods (both bound and
unbound), sets, frozensets, file objects,
generators, type objects, DBcursor
unbound), sets, frozensets, file objects,
:term:`generator`\s, type objects,
objects from the :mod:`bsddb` module, sockets, arrays, deques, and regular
:class:`DBcursor` objects from the :mod:`bsddb` module, sockets, arrays, deques,
expression pattern objects.
and regular
expression pattern objects.
.. versionchanged:: 2.4
.. versionchanged:: 2.4
Added support for files, sockets, arrays, and patterns.
Added support for files, sockets, arrays, and patterns.
...
...
Doc/library/xmlrpclib.rst
View file @
cf3fb259
...
@@ -325,7 +325,8 @@ encapsulate multiple calls to a remote server into a single request.
...
@@ -325,7 +325,8 @@ encapsulate multiple calls to a remote server into a single request.
return ``None``, and only store the call name and parameters in the
return ``None``, and only store the call name and parameters in the
:class:`MultiCall` object. Calling the object itself causes all stored calls to
:class:`MultiCall` object. Calling the object itself causes all stored calls to
be transmitted as a single ``system.multicall`` request. The result of this call
be transmitted as a single ``system.multicall`` request. The result of this call
is a generator; iterating over this generator yields the individual results.
is a :term:`generator`; iterating over this generator yields the individual
results.
A usage example of this class is ::
A usage example of this class is ::
...
...
Doc/tutorial/classes.rst
View file @
cf3fb259
...
@@ -711,12 +711,12 @@ returns an object with a :meth:`next` method. If the class defines
...
@@ -711,12 +711,12 @@ returns an object with a :meth:`next` method. If the class defines
Generators
Generators
==========
==========
Generators are a simple and powerful tool for creating iterators. They are
:term:`Generator`\s are a simple and powerful tool for creating iterators. They
written like regular functions but use the :keyword:`yield` statement whenever
are written like regular functions but use the :keyword:`yield` statement
they want to return data. Each time :meth:`next` is called, the generator
whenever they want to return data. Each time :meth:`next` is called, the
resumes where it left-off (it remembers all the data values and which statement
generator resumes where it left-off (it remembers all the data values and which
was last executed). An example shows that generators can be trivially easy to
statement was last executed). An example shows that generators can be trivially
create::
easy to
create::
def reverse(data):
def reverse(data):
for index in range(len(data)-1, -1, -1):
for index in range(len(data)-1, -1, -1):
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment