Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | ******************************** |
| 2 | Functional Programming HOWTO |
| 3 | ******************************** |
| 4 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 5 | :Author: A. M. Kuchling |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 6 | :Release: 0.31 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 7 | |
| 8 | (This is a first draft. Please send comments/error reports/suggestions to |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 9 | amk@amk.ca.) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | |
| 11 | In this document, we'll take a tour of Python's features suitable for |
| 12 | implementing programs in a functional style. After an introduction to the |
| 13 | concepts of functional programming, we'll look at language features such as |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 14 | :term:`iterator`\s and :term:`generator`\s and relevant library modules such as |
| 15 | :mod:`itertools` and :mod:`functools`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 16 | |
| 17 | |
| 18 | Introduction |
| 19 | ============ |
| 20 | |
| 21 | This section explains the basic concept of functional programming; if you're |
| 22 | just interested in learning about Python language features, skip to the next |
| 23 | section. |
| 24 | |
| 25 | Programming languages support decomposing problems in several different ways: |
| 26 | |
| 27 | * Most programming languages are **procedural**: programs are lists of |
| 28 | instructions that tell the computer what to do with the program's input. C, |
| 29 | Pascal, and even Unix shells are procedural languages. |
| 30 | |
| 31 | * In **declarative** languages, you write a specification that describes the |
| 32 | problem to be solved, and the language implementation figures out how to |
| 33 | perform the computation efficiently. SQL is the declarative language you're |
| 34 | most likely to be familiar with; a SQL query describes the data set you want |
| 35 | to retrieve, and the SQL engine decides whether to scan tables or use indexes, |
| 36 | which subclauses should be performed first, etc. |
| 37 | |
| 38 | * **Object-oriented** programs manipulate collections of objects. Objects have |
| 39 | internal state and support methods that query or modify this internal state in |
| 40 | some way. Smalltalk and Java are object-oriented languages. C++ and Python |
| 41 | are languages that support object-oriented programming, but don't force the |
| 42 | use of object-oriented features. |
| 43 | |
| 44 | * **Functional** programming decomposes a problem into a set of functions. |
| 45 | Ideally, functions only take inputs and produce outputs, and don't have any |
| 46 | internal state that affects the output produced for a given input. Well-known |
| 47 | functional languages include the ML family (Standard ML, OCaml, and other |
| 48 | variants) and Haskell. |
| 49 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 50 | The designers of some computer languages choose to emphasize one |
| 51 | particular approach to programming. This often makes it difficult to |
| 52 | write programs that use a different approach. Other languages are |
| 53 | multi-paradigm languages that support several different approaches. |
| 54 | Lisp, C++, and Python are multi-paradigm; you can write programs or |
| 55 | libraries that are largely procedural, object-oriented, or functional |
| 56 | in all of these languages. In a large program, different sections |
| 57 | might be written using different approaches; the GUI might be |
| 58 | object-oriented while the processing logic is procedural or |
| 59 | functional, for example. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 60 | |
| 61 | In a functional program, input flows through a set of functions. Each function |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 62 | operates on its input and produces some output. Functional style discourages |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 63 | functions with side effects that modify internal state or make other changes |
| 64 | that aren't visible in the function's return value. Functions that have no side |
| 65 | effects at all are called **purely functional**. Avoiding side effects means |
| 66 | not using data structures that get updated as a program runs; every function's |
| 67 | output must only depend on its input. |
| 68 | |
| 69 | Some languages are very strict about purity and don't even have assignment |
| 70 | statements such as ``a=3`` or ``c = a + b``, but it's difficult to avoid all |
| 71 | side effects. Printing to the screen or writing to a disk file are side |
Georg Brandl | 0df7979 | 2008-10-04 18:33:26 +0000 | [diff] [blame^] | 72 | effects, for example. For example, in Python a call to the :func:`print` or |
| 73 | :func:`time.sleep` function both return no useful value; they're only called for |
| 74 | their side effects of sending some text to the screen or pausing execution for a |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 75 | second. |
| 76 | |
| 77 | Python programs written in functional style usually won't go to the extreme of |
| 78 | avoiding all I/O or all assignments; instead, they'll provide a |
| 79 | functional-appearing interface but will use non-functional features internally. |
| 80 | For example, the implementation of a function will still use assignments to |
| 81 | local variables, but won't modify global variables or have other side effects. |
| 82 | |
| 83 | Functional programming can be considered the opposite of object-oriented |
| 84 | programming. Objects are little capsules containing some internal state along |
| 85 | with a collection of method calls that let you modify this state, and programs |
| 86 | consist of making the right set of state changes. Functional programming wants |
| 87 | to avoid state changes as much as possible and works with data flowing between |
| 88 | functions. In Python you might combine the two approaches by writing functions |
| 89 | that take and return instances representing objects in your application (e-mail |
| 90 | messages, transactions, etc.). |
| 91 | |
| 92 | Functional design may seem like an odd constraint to work under. Why should you |
| 93 | avoid objects and side effects? There are theoretical and practical advantages |
| 94 | to the functional style: |
| 95 | |
| 96 | * Formal provability. |
| 97 | * Modularity. |
| 98 | * Composability. |
| 99 | * Ease of debugging and testing. |
| 100 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 101 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 102 | Formal provability |
| 103 | ------------------ |
| 104 | |
| 105 | A theoretical benefit is that it's easier to construct a mathematical proof that |
| 106 | a functional program is correct. |
| 107 | |
| 108 | For a long time researchers have been interested in finding ways to |
| 109 | mathematically prove programs correct. This is different from testing a program |
| 110 | on numerous inputs and concluding that its output is usually correct, or reading |
| 111 | a program's source code and concluding that the code looks right; the goal is |
| 112 | instead a rigorous proof that a program produces the right result for all |
| 113 | possible inputs. |
| 114 | |
| 115 | The technique used to prove programs correct is to write down **invariants**, |
| 116 | properties of the input data and of the program's variables that are always |
| 117 | true. For each line of code, you then show that if invariants X and Y are true |
| 118 | **before** the line is executed, the slightly different invariants X' and Y' are |
| 119 | true **after** the line is executed. This continues until you reach the end of |
| 120 | the program, at which point the invariants should match the desired conditions |
| 121 | on the program's output. |
| 122 | |
| 123 | Functional programming's avoidance of assignments arose because assignments are |
| 124 | difficult to handle with this technique; assignments can break invariants that |
| 125 | were true before the assignment without producing any new invariants that can be |
| 126 | propagated onward. |
| 127 | |
| 128 | Unfortunately, proving programs correct is largely impractical and not relevant |
| 129 | to Python software. Even trivial programs require proofs that are several pages |
| 130 | long; the proof of correctness for a moderately complicated program would be |
| 131 | enormous, and few or none of the programs you use daily (the Python interpreter, |
| 132 | your XML parser, your web browser) could be proven correct. Even if you wrote |
| 133 | down or generated a proof, there would then be the question of verifying the |
| 134 | proof; maybe there's an error in it, and you wrongly believe you've proved the |
| 135 | program correct. |
| 136 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 137 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 138 | Modularity |
| 139 | ---------- |
| 140 | |
| 141 | A more practical benefit of functional programming is that it forces you to |
| 142 | break apart your problem into small pieces. Programs are more modular as a |
| 143 | result. It's easier to specify and write a small function that does one thing |
| 144 | than a large function that performs a complicated transformation. Small |
| 145 | functions are also easier to read and to check for errors. |
| 146 | |
| 147 | |
| 148 | Ease of debugging and testing |
| 149 | ----------------------------- |
| 150 | |
| 151 | Testing and debugging a functional-style program is easier. |
| 152 | |
| 153 | Debugging is simplified because functions are generally small and clearly |
| 154 | specified. When a program doesn't work, each function is an interface point |
| 155 | where you can check that the data are correct. You can look at the intermediate |
| 156 | inputs and outputs to quickly isolate the function that's responsible for a bug. |
| 157 | |
| 158 | Testing is easier because each function is a potential subject for a unit test. |
| 159 | Functions don't depend on system state that needs to be replicated before |
| 160 | running a test; instead you only have to synthesize the right input and then |
| 161 | check that the output matches expectations. |
| 162 | |
| 163 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 164 | Composability |
| 165 | ------------- |
| 166 | |
| 167 | As you work on a functional-style program, you'll write a number of functions |
| 168 | with varying inputs and outputs. Some of these functions will be unavoidably |
| 169 | specialized to a particular application, but others will be useful in a wide |
| 170 | variety of programs. For example, a function that takes a directory path and |
| 171 | returns all the XML files in the directory, or a function that takes a filename |
| 172 | and returns its contents, can be applied to many different situations. |
| 173 | |
| 174 | Over time you'll form a personal library of utilities. Often you'll assemble |
| 175 | new programs by arranging existing functions in a new configuration and writing |
| 176 | a few functions specialized for the current task. |
| 177 | |
| 178 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 179 | Iterators |
| 180 | ========= |
| 181 | |
| 182 | I'll start by looking at a Python language feature that's an important |
| 183 | foundation for writing functional-style programs: iterators. |
| 184 | |
| 185 | An iterator is an object representing a stream of data; this object returns the |
| 186 | data one element at a time. A Python iterator must support a method called |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 187 | ``__next__()`` that takes no arguments and always returns the next element of |
| 188 | the stream. If there are no more elements in the stream, ``__next__()`` must |
| 189 | raise the ``StopIteration`` exception. Iterators don't have to be finite, |
| 190 | though; it's perfectly reasonable to write an iterator that produces an infinite |
| 191 | stream of data. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 192 | |
| 193 | The built-in :func:`iter` function takes an arbitrary object and tries to return |
| 194 | an iterator that will return the object's contents or elements, raising |
| 195 | :exc:`TypeError` if the object doesn't support iteration. Several of Python's |
| 196 | built-in data types support iteration, the most common being lists and |
| 197 | dictionaries. An object is called an **iterable** object if you can get an |
| 198 | iterator for it. |
| 199 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 200 | You can experiment with the iteration interface manually: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 201 | |
| 202 | >>> L = [1,2,3] |
| 203 | >>> it = iter(L) |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 204 | >>> it |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 205 | <...iterator object at ...> |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 206 | >>> it.__next__() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 207 | 1 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 208 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 209 | 2 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 210 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 211 | 3 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 212 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 213 | Traceback (most recent call last): |
| 214 | File "<stdin>", line 1, in ? |
| 215 | StopIteration |
| 216 | >>> |
| 217 | |
| 218 | Python expects iterable objects in several different contexts, the most |
| 219 | important being the ``for`` statement. In the statement ``for X in Y``, Y must |
| 220 | be an iterator or some object for which ``iter()`` can create an iterator. |
| 221 | These two statements are equivalent:: |
| 222 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 224 | for i in iter(obj): |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 225 | print(i) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 226 | |
| 227 | for i in obj: |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 228 | print(i) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 229 | |
| 230 | Iterators can be materialized as lists or tuples by using the :func:`list` or |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 231 | :func:`tuple` constructor functions: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 232 | |
| 233 | >>> L = [1,2,3] |
| 234 | >>> iterator = iter(L) |
| 235 | >>> t = tuple(iterator) |
| 236 | >>> t |
| 237 | (1, 2, 3) |
| 238 | |
| 239 | Sequence unpacking also supports iterators: if you know an iterator will return |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 240 | N elements, you can unpack them into an N-tuple: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 241 | |
| 242 | >>> L = [1,2,3] |
| 243 | >>> iterator = iter(L) |
| 244 | >>> a,b,c = iterator |
| 245 | >>> a,b,c |
| 246 | (1, 2, 3) |
| 247 | |
| 248 | Built-in functions such as :func:`max` and :func:`min` can take a single |
| 249 | iterator argument and will return the largest or smallest element. The ``"in"`` |
| 250 | and ``"not in"`` operators also support iterators: ``X in iterator`` is true if |
| 251 | X is found in the stream returned by the iterator. You'll run into obvious |
| 252 | problems if the iterator is infinite; ``max()``, ``min()``, and ``"not in"`` |
| 253 | will never return, and if the element X never appears in the stream, the |
| 254 | ``"in"`` operator won't return either. |
| 255 | |
| 256 | Note that you can only go forward in an iterator; there's no way to get the |
| 257 | previous element, reset the iterator, or make a copy of it. Iterator objects |
| 258 | can optionally provide these additional capabilities, but the iterator protocol |
| 259 | only specifies the ``next()`` method. Functions may therefore consume all of |
| 260 | the iterator's output, and if you need to do something different with the same |
| 261 | stream, you'll have to create a new iterator. |
| 262 | |
| 263 | |
| 264 | |
| 265 | Data Types That Support Iterators |
| 266 | --------------------------------- |
| 267 | |
| 268 | We've already seen how lists and tuples support iterators. In fact, any Python |
| 269 | sequence type, such as strings, will automatically support creation of an |
| 270 | iterator. |
| 271 | |
| 272 | Calling :func:`iter` on a dictionary returns an iterator that will loop over the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 273 | dictionary's keys: |
| 274 | |
| 275 | .. not a doctest since dict ordering varies across Pythons |
| 276 | |
| 277 | :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 278 | |
| 279 | >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6, |
| 280 | ... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12} |
| 281 | >>> for key in m: |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 282 | ... print(key, m[key]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 283 | Mar 3 |
| 284 | Feb 2 |
| 285 | Aug 8 |
| 286 | Sep 9 |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 287 | Apr 4 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 288 | Jun 6 |
| 289 | Jul 7 |
| 290 | Jan 1 |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 291 | May 5 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 292 | Nov 11 |
| 293 | Dec 12 |
| 294 | Oct 10 |
| 295 | |
| 296 | Note that the order is essentially random, because it's based on the hash |
| 297 | ordering of the objects in the dictionary. |
| 298 | |
Fred Drake | 2e74878 | 2007-09-04 17:33:11 +0000 | [diff] [blame] | 299 | Applying :func:`iter` to a dictionary always loops over the keys, but |
| 300 | dictionaries have methods that return other iterators. If you want to iterate |
| 301 | over values or key/value pairs, you can explicitly call the |
| 302 | :meth:`values` or :meth:`items` methods to get an appropriate iterator. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 303 | |
| 304 | The :func:`dict` constructor can accept an iterator that returns a finite stream |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 305 | of ``(key, value)`` tuples: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 306 | |
| 307 | >>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')] |
| 308 | >>> dict(iter(L)) |
| 309 | {'Italy': 'Rome', 'US': 'Washington DC', 'France': 'Paris'} |
| 310 | |
| 311 | Files also support iteration by calling the ``readline()`` method until there |
| 312 | are no more lines in the file. This means you can read each line of a file like |
| 313 | this:: |
| 314 | |
| 315 | for line in file: |
| 316 | # do something for each line |
| 317 | ... |
| 318 | |
| 319 | Sets can take their contents from an iterable and let you iterate over the set's |
| 320 | elements:: |
| 321 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 322 | S = {2, 3, 5, 7, 11, 13} |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 323 | for i in S: |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 324 | print(i) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 325 | |
| 326 | |
| 327 | |
| 328 | Generator expressions and list comprehensions |
| 329 | ============================================= |
| 330 | |
| 331 | Two common operations on an iterator's output are 1) performing some operation |
| 332 | for every element, 2) selecting a subset of elements that meet some condition. |
| 333 | For example, given a list of strings, you might want to strip off trailing |
| 334 | whitespace from each line or extract all the strings containing a given |
| 335 | substring. |
| 336 | |
| 337 | List comprehensions and generator expressions (short form: "listcomps" and |
| 338 | "genexps") are a concise notation for such operations, borrowed from the |
| 339 | functional programming language Haskell (http://www.haskell.org). You can strip |
| 340 | all the whitespace from a stream of strings with the following code:: |
| 341 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 342 | line_list = [' line 1\n', 'line 2 \n', ...] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 343 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 344 | # Generator expression -- returns iterator |
| 345 | stripped_iter = (line.strip() for line in line_list) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 346 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 347 | # List comprehension -- returns list |
| 348 | stripped_list = [line.strip() for line in line_list] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 349 | |
| 350 | You can select only certain elements by adding an ``"if"`` condition:: |
| 351 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 352 | stripped_list = [line.strip() for line in line_list |
| 353 | if line != ""] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 354 | |
| 355 | With a list comprehension, you get back a Python list; ``stripped_list`` is a |
| 356 | list containing the resulting lines, not an iterator. Generator expressions |
| 357 | return an iterator that computes the values as necessary, not needing to |
| 358 | materialize all the values at once. This means that list comprehensions aren't |
| 359 | useful if you're working with iterators that return an infinite stream or a very |
| 360 | large amount of data. Generator expressions are preferable in these situations. |
| 361 | |
| 362 | Generator expressions are surrounded by parentheses ("()") and list |
| 363 | comprehensions are surrounded by square brackets ("[]"). Generator expressions |
| 364 | have the form:: |
| 365 | |
| 366 | ( expression for expr in sequence1 |
| 367 | if condition1 |
| 368 | for expr2 in sequence2 |
| 369 | if condition2 |
| 370 | for expr3 in sequence3 ... |
| 371 | if condition3 |
| 372 | for exprN in sequenceN |
| 373 | if conditionN ) |
| 374 | |
| 375 | Again, for a list comprehension only the outside brackets are different (square |
| 376 | brackets instead of parentheses). |
| 377 | |
| 378 | The elements of the generated output will be the successive values of |
| 379 | ``expression``. The ``if`` clauses are all optional; if present, ``expression`` |
| 380 | is only evaluated and added to the result when ``condition`` is true. |
| 381 | |
| 382 | Generator expressions always have to be written inside parentheses, but the |
| 383 | parentheses signalling a function call also count. If you want to create an |
| 384 | iterator that will be immediately passed to a function you can write:: |
| 385 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 386 | obj_total = sum(obj.count for obj in list_all_objects()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 387 | |
| 388 | The ``for...in`` clauses contain the sequences to be iterated over. The |
| 389 | sequences do not have to be the same length, because they are iterated over from |
| 390 | left to right, **not** in parallel. For each element in ``sequence1``, |
| 391 | ``sequence2`` is looped over from the beginning. ``sequence3`` is then looped |
| 392 | over for each resulting pair of elements from ``sequence1`` and ``sequence2``. |
| 393 | |
| 394 | To put it another way, a list comprehension or generator expression is |
| 395 | equivalent to the following Python code:: |
| 396 | |
| 397 | for expr1 in sequence1: |
| 398 | if not (condition1): |
| 399 | continue # Skip this element |
| 400 | for expr2 in sequence2: |
| 401 | if not (condition2): |
| 402 | continue # Skip this element |
| 403 | ... |
| 404 | for exprN in sequenceN: |
| 405 | if not (conditionN): |
| 406 | continue # Skip this element |
| 407 | |
| 408 | # Output the value of |
| 409 | # the expression. |
| 410 | |
| 411 | This means that when there are multiple ``for...in`` clauses but no ``if`` |
| 412 | clauses, the length of the resulting output will be equal to the product of the |
| 413 | lengths of all the sequences. If you have two lists of length 3, the output |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 414 | list is 9 elements long: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 415 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 416 | .. doctest:: |
| 417 | :options: +NORMALIZE_WHITESPACE |
| 418 | |
| 419 | >>> seq1 = 'abc' |
| 420 | >>> seq2 = (1,2,3) |
| 421 | >>> [(x,y) for x in seq1 for y in seq2] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 422 | [('a', 1), ('a', 2), ('a', 3), |
| 423 | ('b', 1), ('b', 2), ('b', 3), |
| 424 | ('c', 1), ('c', 2), ('c', 3)] |
| 425 | |
| 426 | To avoid introducing an ambiguity into Python's grammar, if ``expression`` is |
| 427 | creating a tuple, it must be surrounded with parentheses. The first list |
| 428 | comprehension below is a syntax error, while the second one is correct:: |
| 429 | |
| 430 | # Syntax error |
| 431 | [ x,y for x in seq1 for y in seq2] |
| 432 | # Correct |
| 433 | [ (x,y) for x in seq1 for y in seq2] |
| 434 | |
| 435 | |
| 436 | Generators |
| 437 | ========== |
| 438 | |
| 439 | Generators are a special class of functions that simplify the task of writing |
| 440 | iterators. Regular functions compute a value and return it, but generators |
| 441 | return an iterator that returns a stream of values. |
| 442 | |
| 443 | You're doubtless familiar with how regular function calls work in Python or C. |
| 444 | When you call a function, it gets a private namespace where its local variables |
| 445 | are created. When the function reaches a ``return`` statement, the local |
| 446 | variables are destroyed and the value is returned to the caller. A later call |
| 447 | to the same function creates a new private namespace and a fresh set of local |
| 448 | variables. But, what if the local variables weren't thrown away on exiting a |
| 449 | function? What if you could later resume the function where it left off? This |
| 450 | is what generators provide; they can be thought of as resumable functions. |
| 451 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 452 | Here's the simplest example of a generator function: |
| 453 | |
| 454 | .. testcode:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 455 | |
| 456 | def generate_ints(N): |
| 457 | for i in range(N): |
| 458 | yield i |
| 459 | |
| 460 | Any function containing a ``yield`` keyword is a generator function; this is |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 461 | detected by Python's :term:`bytecode` compiler which compiles the function |
| 462 | specially as a result. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 463 | |
| 464 | When you call a generator function, it doesn't return a single value; instead it |
| 465 | returns a generator object that supports the iterator protocol. On executing |
| 466 | the ``yield`` expression, the generator outputs the value of ``i``, similar to a |
| 467 | ``return`` statement. The big difference between ``yield`` and a ``return`` |
| 468 | statement is that on reaching a ``yield`` the generator's state of execution is |
| 469 | suspended and local variables are preserved. On the next call to the |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 470 | generator's ``.__next__()`` method, the function will resume executing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 471 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 472 | Here's a sample usage of the ``generate_ints()`` generator: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 473 | |
| 474 | >>> gen = generate_ints(3) |
| 475 | >>> gen |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 476 | <generator object at ...> |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 477 | >>> next(gen) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 478 | 0 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 479 | >>> next(gen) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 480 | 1 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 481 | >>> next(gen) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 482 | 2 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 483 | >>> next(gen) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 484 | Traceback (most recent call last): |
| 485 | File "stdin", line 1, in ? |
| 486 | File "stdin", line 2, in generate_ints |
| 487 | StopIteration |
| 488 | |
| 489 | You could equally write ``for i in generate_ints(5)``, or ``a,b,c = |
| 490 | generate_ints(3)``. |
| 491 | |
| 492 | Inside a generator function, the ``return`` statement can only be used without a |
| 493 | value, and signals the end of the procession of values; after executing a |
| 494 | ``return`` the generator cannot return any further values. ``return`` with a |
| 495 | value, such as ``return 5``, is a syntax error inside a generator function. The |
| 496 | end of the generator's results can also be indicated by raising |
| 497 | ``StopIteration`` manually, or by just letting the flow of execution fall off |
| 498 | the bottom of the function. |
| 499 | |
| 500 | You could achieve the effect of generators manually by writing your own class |
| 501 | and storing all the local variables of the generator as instance variables. For |
| 502 | example, returning a list of integers could be done by setting ``self.count`` to |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 503 | 0, and having the ``__next__()`` method increment ``self.count`` and return it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 504 | However, for a moderately complicated generator, writing a corresponding class |
| 505 | can be much messier. |
| 506 | |
| 507 | The test suite included with Python's library, ``test_generators.py``, contains |
| 508 | a number of more interesting examples. Here's one generator that implements an |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 509 | in-order traversal of a tree using generators recursively. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 510 | |
| 511 | # A recursive generator that generates Tree leaves in in-order. |
| 512 | def inorder(t): |
| 513 | if t: |
| 514 | for x in inorder(t.left): |
| 515 | yield x |
| 516 | |
| 517 | yield t.label |
| 518 | |
| 519 | for x in inorder(t.right): |
| 520 | yield x |
| 521 | |
| 522 | Two other examples in ``test_generators.py`` produce solutions for the N-Queens |
| 523 | problem (placing N queens on an NxN chess board so that no queen threatens |
| 524 | another) and the Knight's Tour (finding a route that takes a knight to every |
| 525 | square of an NxN chessboard without visiting any square twice). |
| 526 | |
| 527 | |
| 528 | |
| 529 | Passing values into a generator |
| 530 | ------------------------------- |
| 531 | |
| 532 | In Python 2.4 and earlier, generators only produced output. Once a generator's |
| 533 | code was invoked to create an iterator, there was no way to pass any new |
| 534 | information into the function when its execution is resumed. You could hack |
| 535 | together this ability by making the generator look at a global variable or by |
| 536 | passing in some mutable object that callers then modify, but these approaches |
| 537 | are messy. |
| 538 | |
| 539 | In Python 2.5 there's a simple way to pass values into a generator. |
| 540 | :keyword:`yield` became an expression, returning a value that can be assigned to |
| 541 | a variable or otherwise operated on:: |
| 542 | |
| 543 | val = (yield i) |
| 544 | |
| 545 | I recommend that you **always** put parentheses around a ``yield`` expression |
| 546 | when you're doing something with the returned value, as in the above example. |
| 547 | The parentheses aren't always necessary, but it's easier to always add them |
| 548 | instead of having to remember when they're needed. |
| 549 | |
| 550 | (PEP 342 explains the exact rules, which are that a ``yield``-expression must |
| 551 | always be parenthesized except when it occurs at the top-level expression on the |
| 552 | right-hand side of an assignment. This means you can write ``val = yield i`` |
| 553 | but have to use parentheses when there's an operation, as in ``val = (yield i) |
| 554 | + 12``.) |
| 555 | |
| 556 | Values are sent into a generator by calling its ``send(value)`` method. This |
| 557 | method resumes the generator's code and the ``yield`` expression returns the |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 558 | specified value. If the regular ``__next__()`` method is called, the ``yield`` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 559 | returns ``None``. |
| 560 | |
| 561 | Here's a simple counter that increments by 1 and allows changing the value of |
| 562 | the internal counter. |
| 563 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 564 | .. testcode:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 565 | |
| 566 | def counter (maximum): |
| 567 | i = 0 |
| 568 | while i < maximum: |
| 569 | val = (yield i) |
| 570 | # If value provided, change counter |
| 571 | if val is not None: |
| 572 | i = val |
| 573 | else: |
| 574 | i += 1 |
| 575 | |
| 576 | And here's an example of changing the counter: |
| 577 | |
| 578 | >>> it = counter(10) |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 579 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 580 | 0 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 581 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 582 | 1 |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 583 | >>> it.send(8) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 584 | 8 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 585 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 586 | 9 |
Benjamin Peterson | e7c78b2 | 2008-07-03 20:28:26 +0000 | [diff] [blame] | 587 | >>> next(it) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 588 | Traceback (most recent call last): |
| 589 | File ``t.py'', line 15, in ? |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 590 | it.next() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 591 | StopIteration |
| 592 | |
| 593 | Because ``yield`` will often be returning ``None``, you should always check for |
| 594 | this case. Don't just use its value in expressions unless you're sure that the |
| 595 | ``send()`` method will be the only method used resume your generator function. |
| 596 | |
| 597 | In addition to ``send()``, there are two other new methods on generators: |
| 598 | |
| 599 | * ``throw(type, value=None, traceback=None)`` is used to raise an exception |
| 600 | inside the generator; the exception is raised by the ``yield`` expression |
| 601 | where the generator's execution is paused. |
| 602 | |
| 603 | * ``close()`` raises a :exc:`GeneratorExit` exception inside the generator to |
| 604 | terminate the iteration. On receiving this exception, the generator's code |
| 605 | must either raise :exc:`GeneratorExit` or :exc:`StopIteration`; catching the |
| 606 | exception and doing anything else is illegal and will trigger a |
| 607 | :exc:`RuntimeError`. ``close()`` will also be called by Python's garbage |
| 608 | collector when the generator is garbage-collected. |
| 609 | |
| 610 | If you need to run cleanup code when a :exc:`GeneratorExit` occurs, I suggest |
| 611 | using a ``try: ... finally:`` suite instead of catching :exc:`GeneratorExit`. |
| 612 | |
| 613 | The cumulative effect of these changes is to turn generators from one-way |
| 614 | producers of information into both producers and consumers. |
| 615 | |
| 616 | Generators also become **coroutines**, a more generalized form of subroutines. |
| 617 | Subroutines are entered at one point and exited at another point (the top of the |
| 618 | function, and a ``return`` statement), but coroutines can be entered, exited, |
| 619 | and resumed at many different points (the ``yield`` statements). |
| 620 | |
| 621 | |
| 622 | Built-in functions |
| 623 | ================== |
| 624 | |
| 625 | Let's look in more detail at built-in functions often used with iterators. |
| 626 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 627 | Two of Python's built-in functions, :func:`map` and :func:`filter` duplicate the |
| 628 | features of generator expressions: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 629 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 630 | ``map(f, iterA, iterB, ...)`` returns an iterator over the sequence |
| 631 | ``f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ...``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 632 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 633 | >>> def upper(s): |
| 634 | ... return s.upper() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 635 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 636 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 637 | >>> map(upper, ['sentence', 'fragment']) |
| 638 | ['SENTENCE', 'FRAGMENT'] |
| 639 | >>> [upper(s) for s in ['sentence', 'fragment']] |
| 640 | ['SENTENCE', 'FRAGMENT'] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 641 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 642 | You can of course achieve the same effect with a list comprehension. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 643 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 644 | ``filter(predicate, iter)`` returns an iterator over all the sequence elements |
| 645 | that meet a certain condition, and is similarly duplicated by list |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 646 | comprehensions. A **predicate** is a function that returns the truth value of |
| 647 | some condition; for use with :func:`filter`, the predicate must take a single |
| 648 | value. |
| 649 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 650 | >>> def is_even(x): |
| 651 | ... return (x % 2) == 0 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 652 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 653 | >>> filter(is_even, range(10)) |
| 654 | [0, 2, 4, 6, 8] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 655 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 656 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 657 | This can also be written as a list comprehension: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 658 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 659 | >>> list(x for x in range(10) if is_even(x)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 660 | [0, 2, 4, 6, 8] |
| 661 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 662 | ``functools.reduce(func, iter, [initial_value])`` cumulatively performs an |
| 663 | operation on all the iterable's elements and, therefore, can't be applied to |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 664 | infinite iterables. (Note it is not in :mod:`builtins`, but in the |
| 665 | :mod:`functools` module.) ``func`` must be a function that takes two elements |
| 666 | and returns a single value. :func:`functools.reduce` takes the first two |
| 667 | elements A and B returned by the iterator and calculates ``func(A, B)``. It |
| 668 | then requests the third element, C, calculates ``func(func(A, B), C)``, combines |
| 669 | this result with the fourth element returned, and continues until the iterable |
| 670 | is exhausted. If the iterable returns no values at all, a :exc:`TypeError` |
| 671 | exception is raised. If the initial value is supplied, it's used as a starting |
| 672 | point and ``func(initial_value, A)`` is the first calculation. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 673 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 674 | >>> import operator, functools |
| 675 | >>> functools.reduce(operator.concat, ['A', 'BB', 'C']) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 676 | 'ABBC' |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 677 | >>> functools.reduce(operator.concat, []) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 678 | Traceback (most recent call last): |
| 679 | ... |
| 680 | TypeError: reduce() of empty sequence with no initial value |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 681 | >>> functools.reduce(operator.mul, [1,2,3], 1) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 682 | 6 |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 683 | >>> functools.reduce(operator.mul, [], 1) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 684 | 1 |
| 685 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 686 | If you use :func:`operator.add` with :func:`functools.reduce`, you'll add up all the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 687 | elements of the iterable. This case is so common that there's a special |
| 688 | built-in called :func:`sum` to compute it: |
| 689 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 690 | >>> import functools |
| 691 | >>> functools.reduce(operator.add, [1,2,3,4], 0) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 692 | 10 |
| 693 | >>> sum([1,2,3,4]) |
| 694 | 10 |
| 695 | >>> sum([]) |
| 696 | 0 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 697 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 698 | For many uses of :func:`functools.reduce`, though, it can be clearer to just write the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 699 | obvious :keyword:`for` loop:: |
| 700 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 701 | import functools |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 702 | # Instead of: |
| 703 | product = functools.reduce(operator.mul, [1,2,3], 1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 704 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 705 | # You can write: |
| 706 | product = 1 |
| 707 | for i in [1,2,3]: |
| 708 | product *= i |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 709 | |
| 710 | |
| 711 | ``enumerate(iter)`` counts off the elements in the iterable, returning 2-tuples |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 712 | containing the count and each element. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 713 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 714 | >>> for item in enumerate(['subject', 'verb', 'object']): |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 715 | ... print(item) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 716 | (0, 'subject') |
| 717 | (1, 'verb') |
| 718 | (2, 'object') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 719 | |
| 720 | :func:`enumerate` is often used when looping through a list and recording the |
| 721 | indexes at which certain conditions are met:: |
| 722 | |
| 723 | f = open('data.txt', 'r') |
| 724 | for i, line in enumerate(f): |
| 725 | if line.strip() == '': |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 726 | print('Blank line at line #%i' % i) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 727 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 728 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 729 | ``sorted(iterable, [cmp=None], [key=None], [reverse=False)`` collects all the |
| 730 | elements of the iterable into a list, sorts the list, and returns the sorted |
| 731 | result. The ``cmp``, ``key``, and ``reverse`` arguments are passed through to |
| 732 | the constructed list's ``.sort()`` method. :: |
| 733 | |
| 734 | >>> import random |
| 735 | >>> # Generate 8 random numbers between [0, 10000) |
| 736 | >>> rand_list = random.sample(range(10000), 8) |
| 737 | >>> rand_list |
| 738 | [769, 7953, 9828, 6431, 8442, 9878, 6213, 2207] |
| 739 | >>> sorted(rand_list) |
| 740 | [769, 2207, 6213, 6431, 7953, 8442, 9828, 9878] |
| 741 | >>> sorted(rand_list, reverse=True) |
| 742 | [9878, 9828, 8442, 7953, 6431, 6213, 2207, 769] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 743 | |
| 744 | (For a more detailed discussion of sorting, see the Sorting mini-HOWTO in the |
| 745 | Python wiki at http://wiki.python.org/moin/HowTo/Sorting.) |
| 746 | |
| 747 | The ``any(iter)`` and ``all(iter)`` built-ins look at the truth values of an |
| 748 | iterable's contents. :func:`any` returns True if any element in the iterable is |
| 749 | a true value, and :func:`all` returns True if all of the elements are true |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 750 | values: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 751 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 752 | >>> any([0,1,0]) |
| 753 | True |
| 754 | >>> any([0,0,0]) |
| 755 | False |
| 756 | >>> any([1,1,1]) |
| 757 | True |
| 758 | >>> all([0,1,0]) |
| 759 | False |
| 760 | >>> all([0,0,0]) |
| 761 | False |
| 762 | >>> all([1,1,1]) |
| 763 | True |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 764 | |
| 765 | |
| 766 | Small functions and the lambda expression |
| 767 | ========================================= |
| 768 | |
| 769 | When writing functional-style programs, you'll often need little functions that |
| 770 | act as predicates or that combine elements in some way. |
| 771 | |
| 772 | If there's a Python built-in or a module function that's suitable, you don't |
| 773 | need to define a new function at all:: |
| 774 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 775 | stripped_lines = [line.strip() for line in lines] |
| 776 | existing_files = filter(os.path.exists, file_list) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 777 | |
| 778 | If the function you need doesn't exist, you need to write it. One way to write |
| 779 | small functions is to use the ``lambda`` statement. ``lambda`` takes a number |
| 780 | of parameters and an expression combining these parameters, and creates a small |
| 781 | function that returns the value of the expression:: |
| 782 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 783 | lowercase = lambda x: x.lower() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 784 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 785 | print_assign = lambda name, value: name + '=' + str(value) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 786 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 787 | adder = lambda x, y: x+y |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 788 | |
| 789 | An alternative is to just use the ``def`` statement and define a function in the |
| 790 | usual way:: |
| 791 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 792 | def lowercase(x): |
| 793 | return x.lower() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 794 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 795 | def print_assign(name, value): |
| 796 | return name + '=' + str(value) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 797 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 798 | def adder(x,y): |
| 799 | return x + y |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 800 | |
| 801 | Which alternative is preferable? That's a style question; my usual course is to |
| 802 | avoid using ``lambda``. |
| 803 | |
| 804 | One reason for my preference is that ``lambda`` is quite limited in the |
| 805 | functions it can define. The result has to be computable as a single |
| 806 | expression, which means you can't have multiway ``if... elif... else`` |
| 807 | comparisons or ``try... except`` statements. If you try to do too much in a |
| 808 | ``lambda`` statement, you'll end up with an overly complicated expression that's |
| 809 | hard to read. Quick, what's the following code doing? |
| 810 | |
| 811 | :: |
| 812 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 813 | import functools |
| 814 | total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 815 | |
| 816 | You can figure it out, but it takes time to disentangle the expression to figure |
| 817 | out what's going on. Using a short nested ``def`` statements makes things a |
| 818 | little bit better:: |
| 819 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 820 | import functools |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 821 | def combine (a, b): |
| 822 | return 0, a[1] + b[1] |
| 823 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 824 | total = functools.reduce(combine, items)[1] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 825 | |
| 826 | But it would be best of all if I had simply used a ``for`` loop:: |
| 827 | |
| 828 | total = 0 |
| 829 | for a, b in items: |
| 830 | total += b |
| 831 | |
| 832 | Or the :func:`sum` built-in and a generator expression:: |
| 833 | |
| 834 | total = sum(b for a,b in items) |
| 835 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 836 | Many uses of :func:`functools.reduce` are clearer when written as ``for`` loops. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 837 | |
| 838 | Fredrik Lundh once suggested the following set of rules for refactoring uses of |
| 839 | ``lambda``: |
| 840 | |
| 841 | 1) Write a lambda function. |
| 842 | 2) Write a comment explaining what the heck that lambda does. |
| 843 | 3) Study the comment for a while, and think of a name that captures the essence |
| 844 | of the comment. |
| 845 | 4) Convert the lambda to a def statement, using that name. |
| 846 | 5) Remove the comment. |
| 847 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 848 | I really like these rules, but you're free to disagree |
| 849 | about whether this lambda-free style is better. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 850 | |
| 851 | |
| 852 | The itertools module |
| 853 | ==================== |
| 854 | |
| 855 | The :mod:`itertools` module contains a number of commonly-used iterators as well |
| 856 | as functions for combining several iterators. This section will introduce the |
| 857 | module's contents by showing small examples. |
| 858 | |
| 859 | The module's functions fall into a few broad classes: |
| 860 | |
| 861 | * Functions that create a new iterator based on an existing iterator. |
| 862 | * Functions for treating an iterator's elements as function arguments. |
| 863 | * Functions for selecting portions of an iterator's output. |
| 864 | * A function for grouping an iterator's output. |
| 865 | |
| 866 | Creating new iterators |
| 867 | ---------------------- |
| 868 | |
| 869 | ``itertools.count(n)`` returns an infinite stream of integers, increasing by 1 |
| 870 | each time. You can optionally supply the starting number, which defaults to 0:: |
| 871 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 872 | itertools.count() => |
| 873 | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... |
| 874 | itertools.count(10) => |
| 875 | 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ... |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 876 | |
| 877 | ``itertools.cycle(iter)`` saves a copy of the contents of a provided iterable |
| 878 | and returns a new iterator that returns its elements from first to last. The |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 879 | new iterator will repeat these elements infinitely. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 880 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 881 | itertools.cycle([1,2,3,4,5]) => |
| 882 | 1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ... |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 883 | |
| 884 | ``itertools.repeat(elem, [n])`` returns the provided element ``n`` times, or |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 885 | returns the element endlessly if ``n`` is not provided. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 886 | |
| 887 | itertools.repeat('abc') => |
| 888 | abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ... |
| 889 | itertools.repeat('abc', 5) => |
| 890 | abc, abc, abc, abc, abc |
| 891 | |
| 892 | ``itertools.chain(iterA, iterB, ...)`` takes an arbitrary number of iterables as |
| 893 | input, and returns all the elements of the first iterator, then all the elements |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 894 | of the second, and so on, until all of the iterables have been exhausted. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 895 | |
| 896 | itertools.chain(['a', 'b', 'c'], (1, 2, 3)) => |
| 897 | a, b, c, 1, 2, 3 |
| 898 | |
| 899 | ``itertools.izip(iterA, iterB, ...)`` takes one element from each iterable and |
| 900 | returns them in a tuple:: |
| 901 | |
| 902 | itertools.izip(['a', 'b', 'c'], (1, 2, 3)) => |
| 903 | ('a', 1), ('b', 2), ('c', 3) |
| 904 | |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 905 | It's similar to the built-in :func:`zip` function, but doesn't construct an |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 906 | in-memory list and exhaust all the input iterators before returning; instead |
| 907 | tuples are constructed and returned only if they're requested. (The technical |
| 908 | term for this behaviour is `lazy evaluation |
| 909 | <http://en.wikipedia.org/wiki/Lazy_evaluation>`__.) |
| 910 | |
| 911 | This iterator is intended to be used with iterables that are all of the same |
| 912 | length. If the iterables are of different lengths, the resulting stream will be |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 913 | the same length as the shortest iterable. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 914 | |
| 915 | itertools.izip(['a', 'b'], (1, 2, 3)) => |
| 916 | ('a', 1), ('b', 2) |
| 917 | |
| 918 | You should avoid doing this, though, because an element may be taken from the |
| 919 | longer iterators and discarded. This means you can't go on to use the iterators |
| 920 | further because you risk skipping a discarded element. |
| 921 | |
| 922 | ``itertools.islice(iter, [start], stop, [step])`` returns a stream that's a |
| 923 | slice of the iterator. With a single ``stop`` argument, it will return the |
| 924 | first ``stop`` elements. If you supply a starting index, you'll get |
| 925 | ``stop-start`` elements, and if you supply a value for ``step``, elements will |
| 926 | be skipped accordingly. Unlike Python's string and list slicing, you can't use |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 927 | negative values for ``start``, ``stop``, or ``step``. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 928 | |
| 929 | itertools.islice(range(10), 8) => |
| 930 | 0, 1, 2, 3, 4, 5, 6, 7 |
| 931 | itertools.islice(range(10), 2, 8) => |
| 932 | 2, 3, 4, 5, 6, 7 |
| 933 | itertools.islice(range(10), 2, 8, 2) => |
| 934 | 2, 4, 6 |
| 935 | |
| 936 | ``itertools.tee(iter, [n])`` replicates an iterator; it returns ``n`` |
| 937 | independent iterators that will all return the contents of the source iterator. |
| 938 | If you don't supply a value for ``n``, the default is 2. Replicating iterators |
| 939 | requires saving some of the contents of the source iterator, so this can consume |
| 940 | significant memory if the iterator is large and one of the new iterators is |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 941 | consumed more than the others. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 942 | |
| 943 | itertools.tee( itertools.count() ) => |
| 944 | iterA, iterB |
| 945 | |
| 946 | where iterA -> |
| 947 | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... |
| 948 | |
| 949 | and iterB -> |
| 950 | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... |
| 951 | |
| 952 | |
| 953 | Calling functions on elements |
| 954 | ----------------------------- |
| 955 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 956 | ``itertools.imap(func, iter)`` is the same as built-in :func:`map`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 957 | |
| 958 | The ``operator`` module contains a set of functions corresponding to Python's |
| 959 | operators. Some examples are ``operator.add(a, b)`` (adds two values), |
| 960 | ``operator.ne(a, b)`` (same as ``a!=b``), and ``operator.attrgetter('id')`` |
| 961 | (returns a callable that fetches the ``"id"`` attribute). |
| 962 | |
| 963 | ``itertools.starmap(func, iter)`` assumes that the iterable will return a stream |
| 964 | of tuples, and calls ``f()`` using these tuples as the arguments:: |
| 965 | |
| 966 | itertools.starmap(os.path.join, |
| 967 | [('/usr', 'bin', 'java'), ('/bin', 'python'), |
| 968 | ('/usr', 'bin', 'perl'),('/usr', 'bin', 'ruby')]) |
| 969 | => |
| 970 | /usr/bin/java, /bin/python, /usr/bin/perl, /usr/bin/ruby |
| 971 | |
| 972 | |
| 973 | Selecting elements |
| 974 | ------------------ |
| 975 | |
| 976 | Another group of functions chooses a subset of an iterator's elements based on a |
| 977 | predicate. |
| 978 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 979 | ``itertools.ifilter(predicate, iter)`` is the same as built-in :func:`filter`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 980 | |
| 981 | ``itertools.ifilterfalse(predicate, iter)`` is the opposite, returning all |
| 982 | elements for which the predicate returns false:: |
| 983 | |
| 984 | itertools.ifilterfalse(is_even, itertools.count()) => |
| 985 | 1, 3, 5, 7, 9, 11, 13, 15, ... |
| 986 | |
| 987 | ``itertools.takewhile(predicate, iter)`` returns elements for as long as the |
| 988 | predicate returns true. Once the predicate returns false, the iterator will |
| 989 | signal the end of its results. |
| 990 | |
| 991 | :: |
| 992 | |
| 993 | def less_than_10(x): |
| 994 | return (x < 10) |
| 995 | |
| 996 | itertools.takewhile(less_than_10, itertools.count()) => |
| 997 | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 |
| 998 | |
| 999 | itertools.takewhile(is_even, itertools.count()) => |
| 1000 | 0 |
| 1001 | |
| 1002 | ``itertools.dropwhile(predicate, iter)`` discards elements while the predicate |
| 1003 | returns true, and then returns the rest of the iterable's results. |
| 1004 | |
| 1005 | :: |
| 1006 | |
| 1007 | itertools.dropwhile(less_than_10, itertools.count()) => |
| 1008 | 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ... |
| 1009 | |
| 1010 | itertools.dropwhile(is_even, itertools.count()) => |
| 1011 | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ... |
| 1012 | |
| 1013 | |
| 1014 | Grouping elements |
| 1015 | ----------------- |
| 1016 | |
| 1017 | The last function I'll discuss, ``itertools.groupby(iter, key_func=None)``, is |
| 1018 | the most complicated. ``key_func(elem)`` is a function that can compute a key |
| 1019 | value for each element returned by the iterable. If you don't supply a key |
| 1020 | function, the key is simply each element itself. |
| 1021 | |
| 1022 | ``groupby()`` collects all the consecutive elements from the underlying iterable |
| 1023 | that have the same key value, and returns a stream of 2-tuples containing a key |
| 1024 | value and an iterator for the elements with that key. |
| 1025 | |
| 1026 | :: |
| 1027 | |
| 1028 | city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'), |
| 1029 | ('Anchorage', 'AK'), ('Nome', 'AK'), |
| 1030 | ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'), |
| 1031 | ... |
| 1032 | ] |
| 1033 | |
Georg Brandl | 0df7979 | 2008-10-04 18:33:26 +0000 | [diff] [blame^] | 1034 | def get_state (city_state): |
| 1035 | return city_state[1] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1036 | |
| 1037 | itertools.groupby(city_list, get_state) => |
| 1038 | ('AL', iterator-1), |
| 1039 | ('AK', iterator-2), |
| 1040 | ('AZ', iterator-3), ... |
| 1041 | |
| 1042 | where |
| 1043 | iterator-1 => |
| 1044 | ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL') |
| 1045 | iterator-2 => |
| 1046 | ('Anchorage', 'AK'), ('Nome', 'AK') |
| 1047 | iterator-3 => |
| 1048 | ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ') |
| 1049 | |
| 1050 | ``groupby()`` assumes that the underlying iterable's contents will already be |
| 1051 | sorted based on the key. Note that the returned iterators also use the |
| 1052 | underlying iterable, so you have to consume the results of iterator-1 before |
| 1053 | requesting iterator-2 and its corresponding key. |
| 1054 | |
| 1055 | |
| 1056 | The functools module |
| 1057 | ==================== |
| 1058 | |
| 1059 | The :mod:`functools` module in Python 2.5 contains some higher-order functions. |
| 1060 | A **higher-order function** takes one or more functions as input and returns a |
| 1061 | new function. The most useful tool in this module is the |
| 1062 | :func:`functools.partial` function. |
| 1063 | |
| 1064 | For programs written in a functional style, you'll sometimes want to construct |
| 1065 | variants of existing functions that have some of the parameters filled in. |
| 1066 | Consider a Python function ``f(a, b, c)``; you may wish to create a new function |
| 1067 | ``g(b, c)`` that's equivalent to ``f(1, b, c)``; you're filling in a value for |
| 1068 | one of ``f()``'s parameters. This is called "partial function application". |
| 1069 | |
| 1070 | The constructor for ``partial`` takes the arguments ``(function, arg1, arg2, |
| 1071 | ... kwarg1=value1, kwarg2=value2)``. The resulting object is callable, so you |
| 1072 | can just call it to invoke ``function`` with the filled-in arguments. |
| 1073 | |
| 1074 | Here's a small but realistic example:: |
| 1075 | |
| 1076 | import functools |
| 1077 | |
| 1078 | def log (message, subsystem): |
| 1079 | "Write the contents of 'message' to the specified subsystem." |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1080 | print('%s: %s' % (subsystem, message)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1081 | ... |
| 1082 | |
| 1083 | server_log = functools.partial(log, subsystem='server') |
| 1084 | server_log('Unable to open socket') |
| 1085 | |
| 1086 | |
| 1087 | The operator module |
| 1088 | ------------------- |
| 1089 | |
| 1090 | The :mod:`operator` module was mentioned earlier. It contains a set of |
| 1091 | functions corresponding to Python's operators. These functions are often useful |
| 1092 | in functional-style code because they save you from writing trivial functions |
| 1093 | that perform a single operation. |
| 1094 | |
| 1095 | Some of the functions in this module are: |
| 1096 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 1097 | * Math operations: ``add()``, ``sub()``, ``mul()``, ``floordiv()``, ``abs()``, ... |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1098 | * Logical operations: ``not_()``, ``truth()``. |
| 1099 | * Bitwise operations: ``and_()``, ``or_()``, ``invert()``. |
| 1100 | * Comparisons: ``eq()``, ``ne()``, ``lt()``, ``le()``, ``gt()``, and ``ge()``. |
| 1101 | * Object identity: ``is_()``, ``is_not()``. |
| 1102 | |
| 1103 | Consult the operator module's documentation for a complete list. |
| 1104 | |
| 1105 | |
| 1106 | |
| 1107 | The functional module |
| 1108 | --------------------- |
| 1109 | |
| 1110 | Collin Winter's `functional module <http://oakwinter.com/code/functional/>`__ |
| 1111 | provides a number of more advanced tools for functional programming. It also |
| 1112 | reimplements several Python built-ins, trying to make them more intuitive to |
| 1113 | those used to functional programming in other languages. |
| 1114 | |
| 1115 | This section contains an introduction to some of the most important functions in |
| 1116 | ``functional``; full documentation can be found at `the project's website |
| 1117 | <http://oakwinter.com/code/functional/documentation/>`__. |
| 1118 | |
| 1119 | ``compose(outer, inner, unpack=False)`` |
| 1120 | |
| 1121 | The ``compose()`` function implements function composition. In other words, it |
| 1122 | returns a wrapper around the ``outer`` and ``inner`` callables, such that the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1123 | return value from ``inner`` is fed directly to ``outer``. That is, :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1124 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1125 | >>> def add(a, b): |
| 1126 | ... return a + b |
| 1127 | ... |
| 1128 | >>> def double(a): |
| 1129 | ... return 2 * a |
| 1130 | ... |
| 1131 | >>> compose(double, add)(5, 6) |
| 1132 | 22 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1133 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1134 | is equivalent to :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1135 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1136 | >>> double(add(5, 6)) |
| 1137 | 22 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1138 | |
| 1139 | The ``unpack`` keyword is provided to work around the fact that Python functions |
| 1140 | are not always `fully curried <http://en.wikipedia.org/wiki/Currying>`__. By |
| 1141 | default, it is expected that the ``inner`` function will return a single object |
| 1142 | and that the ``outer`` function will take a single argument. Setting the |
| 1143 | ``unpack`` argument causes ``compose`` to expect a tuple from ``inner`` which |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1144 | will be expanded before being passed to ``outer``. Put simply, :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1145 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1146 | compose(f, g)(5, 6) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1147 | |
| 1148 | is equivalent to:: |
| 1149 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1150 | f(g(5, 6)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1151 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1152 | while :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1153 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1154 | compose(f, g, unpack=True)(5, 6) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1155 | |
| 1156 | is equivalent to:: |
| 1157 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1158 | f(*g(5, 6)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1159 | |
| 1160 | Even though ``compose()`` only accepts two functions, it's trivial to build up a |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 1161 | version that will compose any number of functions. We'll use |
| 1162 | :func:`functools.reduce`, ``compose()`` and ``partial()`` (the last of which is |
| 1163 | provided by both ``functional`` and ``functools``). :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1164 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1165 | from functional import compose, partial |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 1166 | import functools |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1167 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1168 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 1169 | multi_compose = partial(functools.reduce, compose) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1170 | |
| 1171 | |
| 1172 | We can also use ``map()``, ``compose()`` and ``partial()`` to craft a version of |
| 1173 | ``"".join(...)`` that converts its arguments to string:: |
| 1174 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1175 | from functional import compose, partial |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1176 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1177 | join = compose("".join, partial(map, str)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1178 | |
| 1179 | |
| 1180 | ``flip(func)`` |
| 1181 | |
| 1182 | ``flip()`` wraps the callable in ``func`` and causes it to receive its |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1183 | non-keyword arguments in reverse order. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1184 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1185 | >>> def triple(a, b, c): |
| 1186 | ... return (a, b, c) |
| 1187 | ... |
| 1188 | >>> triple(5, 6, 7) |
| 1189 | (5, 6, 7) |
| 1190 | >>> |
| 1191 | >>> flipped_triple = flip(triple) |
| 1192 | >>> flipped_triple(5, 6, 7) |
| 1193 | (7, 6, 5) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1194 | |
| 1195 | ``foldl(func, start, iterable)`` |
| 1196 | |
| 1197 | ``foldl()`` takes a binary function, a starting value (usually some kind of |
| 1198 | 'zero'), and an iterable. The function is applied to the starting value and the |
| 1199 | first element of the list, then the result of that and the second element of the |
| 1200 | list, then the result of that and the third element of the list, and so on. |
| 1201 | |
| 1202 | This means that a call such as:: |
| 1203 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1204 | foldl(f, 0, [1, 2, 3]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1205 | |
| 1206 | is equivalent to:: |
| 1207 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1208 | f(f(f(0, 1), 2), 3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1209 | |
| 1210 | |
| 1211 | ``foldl()`` is roughly equivalent to the following recursive function:: |
| 1212 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1213 | def foldl(func, start, seq): |
| 1214 | if len(seq) == 0: |
| 1215 | return start |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1216 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1217 | return foldl(func, func(start, seq[0]), seq[1:]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1218 | |
| 1219 | Speaking of equivalence, the above ``foldl`` call can be expressed in terms of |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 1220 | the built-in :func:`functools.reduce` like so:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1221 | |
Benjamin Peterson | 0931042 | 2008-09-23 13:44:44 +0000 | [diff] [blame] | 1222 | import functools |
| 1223 | functools.reduce(f, [1, 2, 3], 0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1224 | |
| 1225 | |
| 1226 | We can use ``foldl()``, ``operator.concat()`` and ``partial()`` to write a |
| 1227 | cleaner, more aesthetically-pleasing version of Python's ``"".join(...)`` |
| 1228 | idiom:: |
| 1229 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1230 | from functional import foldl, partial from operator import concat |
| 1231 | |
| 1232 | join = partial(foldl, concat, "") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1233 | |
| 1234 | |
| 1235 | Revision History and Acknowledgements |
| 1236 | ===================================== |
| 1237 | |
| 1238 | The author would like to thank the following people for offering suggestions, |
| 1239 | corrections and assistance with various drafts of this article: Ian Bicking, |
| 1240 | Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell, Leandro |
| 1241 | Lameiro, Jussi Salmela, Collin Winter, Blake Winton. |
| 1242 | |
| 1243 | Version 0.1: posted June 30 2006. |
| 1244 | |
| 1245 | Version 0.11: posted July 1 2006. Typo fixes. |
| 1246 | |
| 1247 | Version 0.2: posted July 10 2006. Merged genexp and listcomp sections into one. |
| 1248 | Typo fixes. |
| 1249 | |
| 1250 | Version 0.21: Added more references suggested on the tutor mailing list. |
| 1251 | |
| 1252 | Version 0.30: Adds a section on the ``functional`` module written by Collin |
| 1253 | Winter; adds short section on the operator module; a few other edits. |
| 1254 | |
| 1255 | |
| 1256 | References |
| 1257 | ========== |
| 1258 | |
| 1259 | General |
| 1260 | ------- |
| 1261 | |
| 1262 | **Structure and Interpretation of Computer Programs**, by Harold Abelson and |
| 1263 | Gerald Jay Sussman with Julie Sussman. Full text at |
| 1264 | http://mitpress.mit.edu/sicp/. In this classic textbook of computer science, |
| 1265 | chapters 2 and 3 discuss the use of sequences and streams to organize the data |
| 1266 | flow inside a program. The book uses Scheme for its examples, but many of the |
| 1267 | design approaches described in these chapters are applicable to functional-style |
| 1268 | Python code. |
| 1269 | |
| 1270 | http://www.defmacro.org/ramblings/fp.html: A general introduction to functional |
| 1271 | programming that uses Java examples and has a lengthy historical introduction. |
| 1272 | |
| 1273 | http://en.wikipedia.org/wiki/Functional_programming: General Wikipedia entry |
| 1274 | describing functional programming. |
| 1275 | |
| 1276 | http://en.wikipedia.org/wiki/Coroutine: Entry for coroutines. |
| 1277 | |
| 1278 | http://en.wikipedia.org/wiki/Currying: Entry for the concept of currying. |
| 1279 | |
| 1280 | Python-specific |
| 1281 | --------------- |
| 1282 | |
| 1283 | http://gnosis.cx/TPiP/: The first chapter of David Mertz's book |
| 1284 | :title-reference:`Text Processing in Python` discusses functional programming |
| 1285 | for text processing, in the section titled "Utilizing Higher-Order Functions in |
| 1286 | Text Processing". |
| 1287 | |
| 1288 | Mertz also wrote a 3-part series of articles on functional programming |
| 1289 | for IBM's DeveloperWorks site; see |
| 1290 | `part 1 <http://www-128.ibm.com/developerworks/library/l-prog.html>`__, |
| 1291 | `part 2 <http://www-128.ibm.com/developerworks/library/l-prog2.html>`__, and |
| 1292 | `part 3 <http://www-128.ibm.com/developerworks/linux/library/l-prog3.html>`__, |
| 1293 | |
| 1294 | |
| 1295 | Python documentation |
| 1296 | -------------------- |
| 1297 | |
| 1298 | Documentation for the :mod:`itertools` module. |
| 1299 | |
| 1300 | Documentation for the :mod:`operator` module. |
| 1301 | |
| 1302 | :pep:`289`: "Generator Expressions" |
| 1303 | |
| 1304 | :pep:`342`: "Coroutines via Enhanced Generators" describes the new generator |
| 1305 | features in Python 2.5. |
| 1306 | |
| 1307 | .. comment |
| 1308 | |
| 1309 | Topics to place |
| 1310 | ----------------------------- |
| 1311 | |
| 1312 | XXX os.walk() |
| 1313 | |
| 1314 | XXX Need a large example. |
| 1315 | |
| 1316 | But will an example add much? I'll post a first draft and see |
| 1317 | what the comments say. |
| 1318 | |
| 1319 | .. comment |
| 1320 | |
| 1321 | Original outline: |
| 1322 | Introduction |
| 1323 | Idea of FP |
| 1324 | Programs built out of functions |
| 1325 | Functions are strictly input-output, no internal state |
| 1326 | Opposed to OO programming, where objects have state |
| 1327 | |
| 1328 | Why FP? |
| 1329 | Formal provability |
| 1330 | Assignment is difficult to reason about |
| 1331 | Not very relevant to Python |
| 1332 | Modularity |
| 1333 | Small functions that do one thing |
| 1334 | Debuggability: |
| 1335 | Easy to test due to lack of state |
| 1336 | Easy to verify output from intermediate steps |
| 1337 | Composability |
| 1338 | You assemble a toolbox of functions that can be mixed |
| 1339 | |
| 1340 | Tackling a problem |
| 1341 | Need a significant example |
| 1342 | |
| 1343 | Iterators |
| 1344 | Generators |
| 1345 | The itertools module |
| 1346 | List comprehensions |
| 1347 | Small functions and the lambda statement |
| 1348 | Built-in functions |
| 1349 | map |
| 1350 | filter |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1351 | |
| 1352 | .. comment |
| 1353 | |
| 1354 | Handy little function for printing part of an iterator -- used |
| 1355 | while writing this document. |
| 1356 | |
| 1357 | import itertools |
| 1358 | def print_iter(it): |
| 1359 | slice = itertools.islice(it, 10) |
| 1360 | for elem in slice[:-1]: |
| 1361 | sys.stdout.write(str(elem)) |
| 1362 | sys.stdout.write(', ') |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1363 | print(elem[-1]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1364 | |
| 1365 | |