Skip to content

General improvements to the itertools docs #98408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhettinger merged 15 commits into from
Oct 18, 2022
Merged

General improvements to the itertools docs #98408

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9a81333
Remove distracting and wordy logostic_map example.
rhettinger Oct 18, 2022
655e624
Make the groupby() code equivalent more readable
rhettinger Oct 18, 2022
b1a632a
Break islice() docs into smaller paragraphs
rhettinger Oct 18, 2022
f874f0c
Minor wording improvements for the combinatoric iterators
rhettinger Oct 18, 2022
2cd06a0
Remove redundant text covered by the example below.
rhettinger Oct 18, 2022
6e655d6
Break string of sentences into two paragraphs
rhettinger Oct 18, 2022
62f4ff6
Remove unnecessary words in tee() docs
rhettinger Oct 18, 2022
81e294a
Improve iter_index() recipe to handle non-sequence iterable inputs
rhettinger Oct 18, 2022
78d49a4
Describe the purpose of the recipes section
rhettinger Oct 18, 2022
3019dfc
Note better alternative for unique_everseen()
rhettinger Oct 18, 2022
256bb59
Missing article
rhettinger Oct 18, 2022
ac0cc45
Markup
rhettinger Oct 18, 2022
78f0586
Add imports for the new doctests
rhettinger Oct 18, 2022
1dff762
Doctest the example
rhettinger Oct 18, 2022
5138ddd
Sphinx requires an actual unicode em dash
rhettinger Oct 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Describe the purpose of the recipes section
  • Loading branch information
@rhettinger
rhettinger committed Oct 18, 2022
commit 78d49a47a8968a66cf1242e42ac2a977f1f037ed
18 changes: 16 additions & 2 deletions Doc/library/itertools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,14 +752,28 @@ Itertools Recipes
This section shows recipes for creating an extended toolset using the existing
itertools as building blocks.

The primary purpose of the itertools recipes is educational. The recipes show
various ways of thinking about individual tools -- for example, that
``chain.from_iterable`` is related to the concept of flattening. The recipes
also give ideas about ways that the tools can be combined -- for example, how
`compress()` and `range()` can work together. The recipes also show patterns
for using itertools with the :mod:`operator` and :mod:`collections` modules as
well as with the built-in itertools such as ``map()``, ``filter()``,
``reversed()``, and `enumerate()`.

A secondary purpose of the recipes is to serve as an incubator. The
``accumulate()``, ``compress()``, and ``pairwise()`` itertools started out as
recipes. Currently, the ``iter_index()`` recipe is being tested to see
whether it proves its worth.

Substantially all of these recipes and many, many others can be installed from
the `more-itertools project <https://pypi.org/project/more-itertools/>`_ found
on the Python Package Index::

python -m pip install more-itertools

The extended tools offer the same high performance as the underlying toolset.
The superior memory performance is kept by processing elements one at a time
Many of the recipes offer the same high performance as the underlying toolset.
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
kept small by linking the tools together in a functional style which helps
eliminate temporary variables. High speed is retained by preferring
Expand Down