Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 1 | :mod:`collections` --- Container datatypes |
| 2 | ========================================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: collections |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 5 | :synopsis: Container datatypes |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 6 | .. moduleauthor:: Raymond Hettinger <python@rcn.com> |
| 7 | .. sectionauthor:: Raymond Hettinger <python@rcn.com> |
| 8 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 9 | .. testsetup:: * |
| 10 | |
| 11 | from collections import * |
| 12 | import itertools |
| 13 | __name__ = '<doctest>' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | |
Raymond Hettinger | f56c9cd | 2010-08-08 00:32:32 +0000 | [diff] [blame] | 15 | This module implements specialized container datatypes providing alternatives to |
| 16 | Python's general purpose built-in containers, :class:`dict`, :class:`list`, |
| 17 | :class:`set`, and :class:`tuple`. |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 18 | |
Raymond Hettinger | f56c9cd | 2010-08-08 00:32:32 +0000 | [diff] [blame] | 19 | ===================== ==================================================================== |
| 20 | :func:`namedtuple` factory function for creating tuple subclasses with named fields |
| 21 | :class:`deque` list-like container with fast appends and pops on either end |
| 22 | :class:`Counter` dict subclass for counting hashable objects |
| 23 | :class:`OrderedDict` dict subclass that remembers the order entries were added |
| 24 | :class:`defaultdict` dict subclass that calls a factory function to supply missing values |
| 25 | :class:`UserDict` wrapper around dictionary objects for easier dict subclassing |
| 26 | :class:`UserList` wrapper around list objects for easier list subclassing |
| 27 | :class:`UserString` wrapper around string objects for easier string subclassing |
| 28 | ===================== ==================================================================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 29 | |
Raymond Hettinger | f56c9cd | 2010-08-08 00:32:32 +0000 | [diff] [blame] | 30 | In addition to the concrete container classes, the collections module provides |
| 31 | ABCs (abstract base classes) that can be used to test whether a class provides a |
| 32 | particular interface, for example, whether it is hashable or a mapping. |
Mark Summerfield | 08898b4 | 2007-09-05 08:43:04 +0000 | [diff] [blame] | 33 | |
| 34 | |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 35 | :class:`Counter` objects |
| 36 | ------------------------ |
| 37 | |
| 38 | A counter tool is provided to support convenient and rapid tallies. |
| 39 | For example:: |
| 40 | |
Raymond Hettinger | 1c62dc9 | 2009-02-04 11:41:45 +0000 | [diff] [blame] | 41 | >>> # Tally occurrences of words in a list |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 42 | >>> cnt = Counter() |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 43 | >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 44 | ... cnt[word] += 1 |
| 45 | >>> cnt |
| 46 | Counter({'blue': 3, 'red': 2, 'green': 1}) |
| 47 | |
Raymond Hettinger | 1c62dc9 | 2009-02-04 11:41:45 +0000 | [diff] [blame] | 48 | >>> # Find the ten most common words in Hamlet |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 49 | >>> import re |
| 50 | >>> words = re.findall('\w+', open('hamlet.txt').read().lower()) |
Raymond Hettinger | 0bae662 | 2009-01-20 13:00:59 +0000 | [diff] [blame] | 51 | >>> Counter(words).most_common(10) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 52 | [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631), |
| 53 | ('you', 554), ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)] |
| 54 | |
| 55 | .. class:: Counter([iterable-or-mapping]) |
| 56 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 57 | A :class:`Counter` is a :class:`dict` subclass for counting hashable objects. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 58 | It is an unordered collection where elements are stored as dictionary keys |
| 59 | and their counts are stored as dictionary values. Counts are allowed to be |
| 60 | any integer value including zero or negative counts. The :class:`Counter` |
| 61 | class is similar to bags or multisets in other languages. |
| 62 | |
| 63 | Elements are counted from an *iterable* or initialized from another |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 64 | *mapping* (or counter): |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 65 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 66 | >>> c = Counter() # a new, empty counter |
| 67 | >>> c = Counter('gallahad') # a new counter from an iterable |
| 68 | >>> c = Counter({'red': 4, 'blue': 2}) # a new counter from a mapping |
| 69 | >>> c = Counter(cats=4, dogs=8) # a new counter from keyword args |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 70 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 71 | Counter objects have a dictionary interface except that they return a zero |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 72 | count for missing items instead of raising a :exc:`KeyError`: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 73 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 74 | >>> c = Counter(['eggs', 'ham']) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 75 | >>> c['bacon'] # count of a missing element is zero |
| 76 | 0 |
| 77 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 78 | Setting a count to zero does not remove an element from a counter. |
| 79 | Use ``del`` to remove it entirely: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 80 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 81 | >>> c['sausage'] = 0 # counter entry with a zero count |
| 82 | >>> del c['sausage'] # del actually removes the entry |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 83 | |
Benjamin Peterson | d45bf58 | 2009-03-02 21:44:54 +0000 | [diff] [blame] | 84 | .. versionadded:: 3.1 |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 85 | |
| 86 | |
| 87 | Counter objects support two methods beyond those available for all |
| 88 | dictionaries: |
| 89 | |
| 90 | .. method:: elements() |
| 91 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 92 | Return an iterator over elements repeating each as many times as its |
| 93 | count. Elements are returned in arbitrary order. If an element's count |
| 94 | is less than one, :meth:`elements` will ignore it. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 95 | |
Raymond Hettinger | 0bae662 | 2009-01-20 13:00:59 +0000 | [diff] [blame] | 96 | >>> c = Counter(a=4, b=2, c=0, d=-2) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 97 | >>> list(c.elements()) |
| 98 | ['a', 'a', 'a', 'a', 'b', 'b'] |
| 99 | |
| 100 | .. method:: most_common([n]) |
| 101 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 102 | Return a list of the *n* most common elements and their counts from the |
Raymond Hettinger | d04fa31 | 2009-02-04 19:45:13 +0000 | [diff] [blame] | 103 | most common to the least. If *n* is not specified, :func:`most_common` |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 104 | returns *all* elements in the counter. Elements with equal counts are |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 105 | ordered arbitrarily: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 106 | |
| 107 | >>> Counter('abracadabra').most_common(3) |
| 108 | [('a', 5), ('r', 2), ('b', 2)] |
| 109 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 110 | The usual dictionary methods are available for :class:`Counter` objects |
| 111 | except for two which work differently for counters. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 112 | |
| 113 | .. method:: fromkeys(iterable) |
| 114 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 115 | This class method is not implemented for :class:`Counter` objects. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 116 | |
| 117 | .. method:: update([iterable-or-mapping]) |
| 118 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 119 | Elements are counted from an *iterable* or added-in from another |
| 120 | *mapping* (or counter). Like :meth:`dict.update` but adds counts |
| 121 | instead of replacing them. Also, the *iterable* is expected to be a |
| 122 | sequence of elements, not a sequence of ``(key, value)`` pairs. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 123 | |
| 124 | Common patterns for working with :class:`Counter` objects:: |
| 125 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 126 | sum(c.values()) # total of all counts |
| 127 | c.clear() # reset all counts |
| 128 | list(c) # list unique elements |
| 129 | set(c) # convert to a set |
| 130 | dict(c) # convert to a regular dictionary |
| 131 | c.items() # convert to a list of (elem, cnt) pairs |
| 132 | Counter(dict(list_of_pairs)) # convert from a list of (elem, cnt) pairs |
| 133 | c.most_common()[:-n:-1] # n least common elements |
| 134 | c += Counter() # remove zero and negative counts |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 135 | |
Raymond Hettinger | 72a95cc | 2009-02-25 22:51:40 +0000 | [diff] [blame] | 136 | Several mathematical operations are provided for combining :class:`Counter` |
| 137 | objects to produce multisets (counters that have counts greater than zero). |
| 138 | Addition and subtraction combine counters by adding or subtracting the counts |
| 139 | of corresponding elements. Intersection and union return the minimum and |
| 140 | maximum of corresponding counts. Each operation can accept inputs with signed |
| 141 | counts, but the output will exclude results with counts of zero or less. |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 142 | |
Raymond Hettinger | e0d1b9f | 2009-01-21 20:36:27 +0000 | [diff] [blame] | 143 | >>> c = Counter(a=3, b=1) |
| 144 | >>> d = Counter(a=1, b=2) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 145 | >>> c + d # add two counters together: c[x] + d[x] |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 146 | Counter({'a': 4, 'b': 3}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 147 | >>> c - d # subtract (keeping only positive counts) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 148 | Counter({'a': 2}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 149 | >>> c & d # intersection: min(c[x], d[x]) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 150 | Counter({'a': 1, 'b': 1}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 151 | >>> c | d # union: max(c[x], d[x]) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 152 | Counter({'a': 3, 'b': 2}) |
| 153 | |
Raymond Hettinger | 4c4d3b1 | 2010-04-12 21:47:14 +0000 | [diff] [blame] | 154 | .. note:: |
| 155 | |
| 156 | Counters were primarily designed to work with positive integers to represent |
| 157 | running counts; however, care was taken to not unnecessarily preclude use |
| 158 | cases needing other types or negative values. To help with those use cases, |
| 159 | this section documents the minimum range and type restrictions. |
| 160 | |
| 161 | * The :class:`Counter` class itself is a dictionary subclass with no |
| 162 | restrictions on its keys and values. The values are intended to be numbers |
| 163 | representing counts, but you *could* store anything in the value field. |
| 164 | |
| 165 | * The :meth:`most_common` method requires only that the values be orderable. |
| 166 | |
| 167 | * For in-place operations such as ``c[key] += 1``, the value type need only |
| 168 | support addition and subtraction. So fractions, floats, and decimals would |
| 169 | work and negative values are supported. The same is also true for |
| 170 | :meth:`update` and :meth:`subtract` which allow negative and zero values |
| 171 | for both inputs and outputs. |
| 172 | |
| 173 | * The multiset methods are designed only for use cases with positive values. |
| 174 | The inputs may be negative or zero, but only outputs with positive values |
| 175 | are created. There are no type restrictions, but the value type needs to |
| 176 | support support addition, subtraction, and comparison. |
| 177 | |
| 178 | * The :meth:`elements` method requires integer counts. It ignores zero and |
| 179 | negative counts. |
| 180 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 181 | .. seealso:: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 182 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 183 | * `Counter class <http://code.activestate.com/recipes/576611/>`_ |
| 184 | adapted for Python 2.5 and an early `Bag recipe |
| 185 | <http://code.activestate.com/recipes/259174/>`_ for Python 2.4. |
| 186 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 187 | * `Bag class <http://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html>`_ |
| 188 | in Smalltalk. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 189 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 190 | * Wikipedia entry for `Multisets <http://en.wikipedia.org/wiki/Multiset>`_\. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 191 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 192 | * `C++ multisets <http://www.demo2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm>`_ |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 193 | tutorial with examples. |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 194 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 195 | * For mathematical operations on multisets and their use cases, see |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 196 | *Knuth, Donald. The Art of Computer Programming Volume II, |
| 197 | Section 4.6.3, Exercise 19*\. |
| 198 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 199 | * To enumerate all distinct multisets of a given size over a given set of |
Raymond Hettinger | d07d939 | 2009-01-27 04:20:44 +0000 | [diff] [blame] | 200 | elements, see :func:`itertools.combinations_with_replacement`. |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 201 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 202 | map(Counter, combinations_with_replacement('ABC', 2)) --> AA AB AC BB BC CC |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 203 | |
| 204 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 205 | :class:`deque` objects |
| 206 | ---------------------- |
| 207 | |
Georg Brandl | c2a4f4f | 2009-04-10 09:03:43 +0000 | [diff] [blame] | 208 | .. class:: deque([iterable, [maxlen]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 209 | |
| 210 | Returns a new deque object initialized left-to-right (using :meth:`append`) with |
| 211 | data from *iterable*. If *iterable* is not specified, the new deque is empty. |
| 212 | |
| 213 | Deques are a generalization of stacks and queues (the name is pronounced "deck" |
| 214 | and is short for "double-ended queue"). Deques support thread-safe, memory |
| 215 | efficient appends and pops from either side of the deque with approximately the |
| 216 | same O(1) performance in either direction. |
| 217 | |
| 218 | Though :class:`list` objects support similar operations, they are optimized for |
| 219 | fast fixed-length operations and incur O(n) memory movement costs for |
| 220 | ``pop(0)`` and ``insert(0, v)`` operations which change both the size and |
| 221 | position of the underlying data representation. |
| 222 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 224 | If *maxlen* is not specified or is *None*, deques may grow to an |
| 225 | arbitrary length. Otherwise, the deque is bounded to the specified maximum |
| 226 | length. Once a bounded length deque is full, when new items are added, a |
| 227 | corresponding number of items are discarded from the opposite end. Bounded |
| 228 | length deques provide functionality similar to the ``tail`` filter in |
| 229 | Unix. They are also useful for tracking transactions and other pools of data |
| 230 | where only the most recent activity is of interest. |
| 231 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 232 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 233 | Deque objects support the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 234 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 235 | .. method:: append(x) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 236 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 237 | Add *x* to the right side of the deque. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 238 | |
| 239 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 240 | .. method:: appendleft(x) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 241 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 242 | Add *x* to the left side of the deque. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 243 | |
| 244 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 245 | .. method:: clear() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 246 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 247 | Remove all elements from the deque leaving it with length 0. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 248 | |
| 249 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 250 | .. method:: extend(iterable) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 251 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 252 | Extend the right side of the deque by appending elements from the iterable |
| 253 | argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 254 | |
| 255 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 256 | .. method:: extendleft(iterable) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 257 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 258 | Extend the left side of the deque by appending elements from *iterable*. |
| 259 | Note, the series of left appends results in reversing the order of |
| 260 | elements in the iterable argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 261 | |
| 262 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 263 | .. method:: pop() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 264 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 265 | Remove and return an element from the right side of the deque. If no |
| 266 | elements are present, raises an :exc:`IndexError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 267 | |
| 268 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 269 | .. method:: popleft() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 270 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 271 | Remove and return an element from the left side of the deque. If no |
| 272 | elements are present, raises an :exc:`IndexError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 273 | |
| 274 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 275 | .. method:: remove(value) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 276 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 277 | Removed the first occurrence of *value*. If not found, raises a |
| 278 | :exc:`ValueError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 279 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 280 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 281 | .. method:: rotate(n) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 282 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 283 | Rotate the deque *n* steps to the right. If *n* is negative, rotate to |
| 284 | the left. Rotating one step to the right is equivalent to: |
| 285 | ``d.appendleft(d.pop())``. |
| 286 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 287 | |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 288 | Deque objects also provide one read-only attribute: |
| 289 | |
| 290 | .. attribute:: maxlen |
| 291 | |
| 292 | Maximum size of a deque or *None* if unbounded. |
| 293 | |
Raymond Hettinger | 150fb9c | 2009-03-10 22:48:06 +0000 | [diff] [blame] | 294 | .. versionadded:: 3.1 |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 295 | |
| 296 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 297 | In addition to the above, deques support iteration, pickling, ``len(d)``, |
| 298 | ``reversed(d)``, ``copy.copy(d)``, ``copy.deepcopy(d)``, membership testing with |
Benjamin Peterson | 206e307 | 2008-10-19 14:07:49 +0000 | [diff] [blame] | 299 | the :keyword:`in` operator, and subscript references such as ``d[-1]``. Indexed |
| 300 | access is O(1) at both ends but slows to O(n) in the middle. For fast random |
| 301 | access, use lists instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 302 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 303 | Example: |
| 304 | |
| 305 | .. doctest:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 306 | |
| 307 | >>> from collections import deque |
| 308 | >>> d = deque('ghi') # make a new deque with three items |
| 309 | >>> for elem in d: # iterate over the deque's elements |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 310 | ... print(elem.upper()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 311 | G |
| 312 | H |
| 313 | I |
| 314 | |
| 315 | >>> d.append('j') # add a new entry to the right side |
| 316 | >>> d.appendleft('f') # add a new entry to the left side |
| 317 | >>> d # show the representation of the deque |
| 318 | deque(['f', 'g', 'h', 'i', 'j']) |
| 319 | |
| 320 | >>> d.pop() # return and remove the rightmost item |
| 321 | 'j' |
| 322 | >>> d.popleft() # return and remove the leftmost item |
| 323 | 'f' |
| 324 | >>> list(d) # list the contents of the deque |
| 325 | ['g', 'h', 'i'] |
| 326 | >>> d[0] # peek at leftmost item |
| 327 | 'g' |
| 328 | >>> d[-1] # peek at rightmost item |
| 329 | 'i' |
| 330 | |
| 331 | >>> list(reversed(d)) # list the contents of a deque in reverse |
| 332 | ['i', 'h', 'g'] |
| 333 | >>> 'h' in d # search the deque |
| 334 | True |
| 335 | >>> d.extend('jkl') # add multiple elements at once |
| 336 | >>> d |
| 337 | deque(['g', 'h', 'i', 'j', 'k', 'l']) |
| 338 | >>> d.rotate(1) # right rotation |
| 339 | >>> d |
| 340 | deque(['l', 'g', 'h', 'i', 'j', 'k']) |
| 341 | >>> d.rotate(-1) # left rotation |
| 342 | >>> d |
| 343 | deque(['g', 'h', 'i', 'j', 'k', 'l']) |
| 344 | |
| 345 | >>> deque(reversed(d)) # make a new deque in reverse order |
| 346 | deque(['l', 'k', 'j', 'i', 'h', 'g']) |
| 347 | >>> d.clear() # empty the deque |
| 348 | >>> d.pop() # cannot pop from an empty deque |
| 349 | Traceback (most recent call last): |
| 350 | File "<pyshell#6>", line 1, in -toplevel- |
| 351 | d.pop() |
| 352 | IndexError: pop from an empty deque |
| 353 | |
| 354 | >>> d.extendleft('abc') # extendleft() reverses the input order |
| 355 | >>> d |
| 356 | deque(['c', 'b', 'a']) |
| 357 | |
| 358 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 359 | :class:`deque` Recipes |
| 360 | ^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 361 | |
| 362 | This section shows various approaches to working with deques. |
| 363 | |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 364 | Bounded length deques provide functionality similar to the ``tail`` filter |
| 365 | in Unix:: |
| 366 | |
| 367 | def tail(filename, n=10): |
| 368 | 'Return the last n lines of a file' |
| 369 | return deque(open(filename), n) |
| 370 | |
| 371 | Another approach to using deques is to maintain a sequence of recently |
| 372 | added elements by appending to the right and popping to the left:: |
| 373 | |
| 374 | def moving_average(iterable, n=3): |
| 375 | # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0 |
| 376 | # http://en.wikipedia.org/wiki/Moving_average |
| 377 | it = iter(iterable) |
Raymond Hettinger | d40285a | 2009-05-22 01:11:26 +0000 | [diff] [blame] | 378 | d = deque(itertools.islice(it, n-1)) |
| 379 | d.appendleft(0) |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 380 | s = sum(d) |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 381 | for elem in it: |
| 382 | s += elem - d.popleft() |
| 383 | d.append(elem) |
| 384 | yield s / n |
| 385 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 386 | The :meth:`rotate` method provides a way to implement :class:`deque` slicing and |
Ezio Melotti | 890c193 | 2009-12-19 23:33:46 +0000 | [diff] [blame] | 387 | deletion. For example, a pure Python implementation of ``del d[n]`` relies on |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 388 | the :meth:`rotate` method to position elements to be popped:: |
| 389 | |
| 390 | def delete_nth(d, n): |
| 391 | d.rotate(-n) |
| 392 | d.popleft() |
| 393 | d.rotate(n) |
| 394 | |
| 395 | To implement :class:`deque` slicing, use a similar approach applying |
| 396 | :meth:`rotate` to bring a target element to the left side of the deque. Remove |
| 397 | old entries with :meth:`popleft`, add new entries with :meth:`extend`, and then |
| 398 | reverse the rotation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 399 | With minor variations on that approach, it is easy to implement Forth style |
| 400 | stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``, |
| 401 | ``rot``, and ``roll``. |
| 402 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 403 | |
| 404 | :class:`defaultdict` objects |
| 405 | ---------------------------- |
| 406 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 407 | .. class:: defaultdict([default_factory[, ...]]) |
| 408 | |
| 409 | Returns a new dictionary-like object. :class:`defaultdict` is a subclass of the |
Georg Brandl | c5605df | 2009-08-13 08:26:44 +0000 | [diff] [blame] | 410 | built-in :class:`dict` class. It overrides one method and adds one writable |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 411 | instance variable. The remaining functionality is the same as for the |
| 412 | :class:`dict` class and is not documented here. |
| 413 | |
| 414 | The first argument provides the initial value for the :attr:`default_factory` |
| 415 | attribute; it defaults to ``None``. All remaining arguments are treated the same |
| 416 | as if they were passed to the :class:`dict` constructor, including keyword |
| 417 | arguments. |
| 418 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 419 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 420 | :class:`defaultdict` objects support the following method in addition to the |
| 421 | standard :class:`dict` operations: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 422 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 423 | .. method:: __missing__(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 424 | |
Benjamin Peterson | 5478b47 | 2008-09-17 22:25:09 +0000 | [diff] [blame] | 425 | If the :attr:`default_factory` attribute is ``None``, this raises a |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 426 | :exc:`KeyError` exception with the *key* as argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 427 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 428 | If :attr:`default_factory` is not ``None``, it is called without arguments |
| 429 | to provide a default value for the given *key*, this value is inserted in |
| 430 | the dictionary for the *key*, and returned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 431 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 432 | If calling :attr:`default_factory` raises an exception this exception is |
| 433 | propagated unchanged. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 434 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 435 | This method is called by the :meth:`__getitem__` method of the |
| 436 | :class:`dict` class when the requested key is not found; whatever it |
| 437 | returns or raises is then returned or raised by :meth:`__getitem__`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 438 | |
| 439 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 440 | :class:`defaultdict` objects support the following instance variable: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 441 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 442 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 443 | .. attribute:: default_factory |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 444 | |
| 445 | This attribute is used by the :meth:`__missing__` method; it is |
| 446 | initialized from the first argument to the constructor, if present, or to |
| 447 | ``None``, if absent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 448 | |
| 449 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 450 | :class:`defaultdict` Examples |
| 451 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 452 | |
| 453 | Using :class:`list` as the :attr:`default_factory`, it is easy to group a |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 454 | sequence of key-value pairs into a dictionary of lists: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 455 | |
| 456 | >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)] |
| 457 | >>> d = defaultdict(list) |
| 458 | >>> for k, v in s: |
| 459 | ... d[k].append(v) |
| 460 | ... |
Ezio Melotti | 306afd3 | 2009-09-12 19:50:05 +0000 | [diff] [blame] | 461 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 462 | [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] |
| 463 | |
| 464 | When each key is encountered for the first time, it is not already in the |
| 465 | mapping; so an entry is automatically created using the :attr:`default_factory` |
| 466 | function which returns an empty :class:`list`. The :meth:`list.append` |
| 467 | operation then attaches the value to the new list. When keys are encountered |
| 468 | again, the look-up proceeds normally (returning the list for that key) and the |
| 469 | :meth:`list.append` operation adds another value to the list. This technique is |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 470 | simpler and faster than an equivalent technique using :meth:`dict.setdefault`: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 471 | |
| 472 | >>> d = {} |
| 473 | >>> for k, v in s: |
| 474 | ... d.setdefault(k, []).append(v) |
| 475 | ... |
Ezio Melotti | 306afd3 | 2009-09-12 19:50:05 +0000 | [diff] [blame] | 476 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 477 | [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] |
| 478 | |
| 479 | Setting the :attr:`default_factory` to :class:`int` makes the |
| 480 | :class:`defaultdict` useful for counting (like a bag or multiset in other |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 481 | languages): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 482 | |
| 483 | >>> s = 'mississippi' |
| 484 | >>> d = defaultdict(int) |
| 485 | >>> for k in s: |
| 486 | ... d[k] += 1 |
| 487 | ... |
Ezio Melotti | 306afd3 | 2009-09-12 19:50:05 +0000 | [diff] [blame] | 488 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 489 | [('i', 4), ('p', 2), ('s', 4), ('m', 1)] |
| 490 | |
| 491 | When a letter is first encountered, it is missing from the mapping, so the |
| 492 | :attr:`default_factory` function calls :func:`int` to supply a default count of |
| 493 | zero. The increment operation then builds up the count for each letter. |
| 494 | |
| 495 | The function :func:`int` which always returns zero is just a special case of |
| 496 | constant functions. A faster and more flexible way to create constant functions |
| 497 | is to use a lambda function which can supply any constant value (not just |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 498 | zero): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 499 | |
| 500 | >>> def constant_factory(value): |
| 501 | ... return lambda: value |
| 502 | >>> d = defaultdict(constant_factory('<missing>')) |
| 503 | >>> d.update(name='John', action='ran') |
| 504 | >>> '%(name)s %(action)s to %(object)s' % d |
| 505 | 'John ran to <missing>' |
| 506 | |
| 507 | Setting the :attr:`default_factory` to :class:`set` makes the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 508 | :class:`defaultdict` useful for building a dictionary of sets: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 509 | |
| 510 | >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)] |
| 511 | >>> d = defaultdict(set) |
| 512 | >>> for k, v in s: |
| 513 | ... d[k].add(v) |
| 514 | ... |
Ezio Melotti | 306afd3 | 2009-09-12 19:50:05 +0000 | [diff] [blame] | 515 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 516 | [('blue', set([2, 4])), ('red', set([1, 3]))] |
| 517 | |
| 518 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 519 | :func:`namedtuple` Factory Function for Tuples with Named Fields |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 520 | ---------------------------------------------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 521 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 522 | Named tuples assign meaning to each position in a tuple and allow for more readable, |
| 523 | self-documenting code. They can be used wherever regular tuples are used, and |
| 524 | they add the ability to access fields by name instead of position index. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 525 | |
Georg Brandl | c2a4f4f | 2009-04-10 09:03:43 +0000 | [diff] [blame] | 526 | .. function:: namedtuple(typename, field_names, verbose=False, rename=False) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 527 | |
| 528 | Returns a new tuple subclass named *typename*. The new subclass is used to |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 529 | create tuple-like objects that have fields accessible by attribute lookup as |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 530 | well as being indexable and iterable. Instances of the subclass also have a |
Benjamin Peterson | 4469d0c | 2008-11-30 22:46:23 +0000 | [diff] [blame] | 531 | helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 532 | method which lists the tuple contents in a ``name=value`` format. |
| 533 | |
Benjamin Peterson | 4469d0c | 2008-11-30 22:46:23 +0000 | [diff] [blame] | 534 | The *field_names* are a single string with each fieldname separated by whitespace |
| 535 | and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names* |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 536 | can be a sequence of strings such as ``['x', 'y']``. |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 537 | |
| 538 | Any valid Python identifier may be used for a fieldname except for names |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 539 | starting with an underscore. Valid identifiers consist of letters, digits, |
| 540 | and underscores but do not start with a digit or underscore and cannot be |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 541 | a :mod:`keyword` such as *class*, *for*, *return*, *global*, *pass*, |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 542 | or *raise*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 543 | |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 544 | If *rename* is true, invalid fieldnames are automatically replaced |
| 545 | with positional names. For example, ``['abc', 'def', 'ghi', 'abc']`` is |
Raymond Hettinger | 85737b8 | 2009-04-02 22:37:59 +0000 | [diff] [blame] | 546 | converted to ``['abc', '_1', 'ghi', '_3']``, eliminating the keyword |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 547 | ``def`` and the duplicate fieldname ``abc``. |
| 548 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 549 | If *verbose* is true, the class definition is printed just before being built. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 550 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 551 | Named tuple instances do not have per-instance dictionaries, so they are |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 552 | lightweight and require no more memory than regular tuples. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 553 | |
Raymond Hettinger | b62ad24 | 2009-03-02 22:16:43 +0000 | [diff] [blame] | 554 | .. versionchanged:: 3.1 |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 555 | added support for *rename*. |
| 556 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 557 | Example: |
| 558 | |
| 559 | .. doctest:: |
| 560 | :options: +NORMALIZE_WHITESPACE |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 561 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 562 | >>> Point = namedtuple('Point', 'x y', verbose=True) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 563 | class Point(tuple): |
| 564 | 'Point(x, y)' |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 565 | <BLANKLINE> |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 566 | __slots__ = () |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 567 | <BLANKLINE> |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 568 | _fields = ('x', 'y') |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 569 | <BLANKLINE> |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 570 | def __new__(_cls, x, y): |
| 571 | return _tuple.__new__(_cls, (x, y)) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 572 | <BLANKLINE> |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 573 | @classmethod |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 574 | def _make(cls, iterable, new=tuple.__new__, len=len): |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 575 | 'Make a new Point object from a sequence or iterable' |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 576 | result = new(cls, iterable) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 577 | if len(result) != 2: |
| 578 | raise TypeError('Expected 2 arguments, got %d' % len(result)) |
| 579 | return result |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 580 | <BLANKLINE> |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 581 | def __repr__(self): |
| 582 | return 'Point(x=%r, y=%r)' % self |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 583 | <BLANKLINE> |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 584 | def _asdict(self): |
| 585 | 'Return a new OrderedDict which maps field names to their values' |
| 586 | return OrderedDict(zip(self._fields, self)) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 587 | <BLANKLINE> |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 588 | def _replace(_self, **kwds): |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 589 | 'Return a new Point object replacing specified fields with new values' |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 590 | result = _self._make(map(kwds.pop, ('x', 'y'), _self)) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 591 | if kwds: |
Ezio Melotti | 2befd9a | 2009-09-13 08:08:32 +0000 | [diff] [blame] | 592 | raise ValueError('Got unexpected field names: %r' % list(kwds.keys())) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 593 | return result |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 594 | <BLANKLINE> |
| 595 | def __getnewargs__(self): |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 596 | return tuple(self) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 597 | <BLANKLINE> |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 598 | x = _property(_itemgetter(0)) |
| 599 | y = _property(_itemgetter(1)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 600 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 601 | >>> p = Point(11, y=22) # instantiate with positional or keyword arguments |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 602 | >>> p[0] + p[1] # indexable like the plain tuple (11, 22) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 603 | 33 |
| 604 | >>> x, y = p # unpack like a regular tuple |
| 605 | >>> x, y |
| 606 | (11, 22) |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 607 | >>> p.x + p.y # fields also accessible by name |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 608 | 33 |
| 609 | >>> p # readable __repr__ with a name=value style |
| 610 | Point(x=11, y=22) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 611 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 612 | Named tuples are especially useful for assigning field names to result tuples returned |
| 613 | by the :mod:`csv` or :mod:`sqlite3` modules:: |
| 614 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 615 | EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade') |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 616 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 617 | import csv |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 618 | for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 619 | print(emp.name, emp.title) |
| 620 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 621 | import sqlite3 |
| 622 | conn = sqlite3.connect('/companydata') |
| 623 | cursor = conn.cursor() |
| 624 | cursor.execute('SELECT name, age, title, department, paygrade FROM employees') |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 625 | for emp in map(EmployeeRecord._make, cursor.fetchall()): |
Christian Heimes | 0041223 | 2008-01-10 16:02:19 +0000 | [diff] [blame] | 626 | print(emp.name, emp.title) |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 627 | |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 628 | In addition to the methods inherited from tuples, named tuples support |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 629 | three additional methods and one attribute. To prevent conflicts with |
| 630 | field names, the method and attribute names start with an underscore. |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 631 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 632 | .. classmethod:: somenamedtuple._make(iterable) |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 633 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 634 | Class method that makes a new instance from an existing sequence or iterable. |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 635 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 636 | .. doctest:: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 637 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 638 | >>> t = [11, 22] |
| 639 | >>> Point._make(t) |
| 640 | Point(x=11, y=22) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 641 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 642 | .. method:: somenamedtuple._asdict() |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 643 | |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 644 | Return a new :class:`OrderedDict` which maps field names to their corresponding |
| 645 | values:: |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 646 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 647 | >>> p._asdict() |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 648 | OrderedDict([('x', 11), ('y', 22)]) |
| 649 | |
Raymond Hettinger | a88e4da | 2009-03-03 05:12:27 +0000 | [diff] [blame] | 650 | .. versionchanged:: 3.1 |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 651 | Returns an :class:`OrderedDict` instead of a regular :class:`dict`. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 652 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 653 | .. method:: somenamedtuple._replace(kwargs) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 654 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 655 | Return a new instance of the named tuple replacing specified fields with new |
| 656 | values: |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 657 | |
| 658 | :: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 659 | |
| 660 | >>> p = Point(x=11, y=22) |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 661 | >>> p._replace(x=33) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 662 | Point(x=33, y=22) |
| 663 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 664 | >>> for partnum, record in inventory.items(): |
Christian Heimes | 454f37b | 2008-01-10 00:10:02 +0000 | [diff] [blame] | 665 | ... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 666 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 667 | .. attribute:: somenamedtuple._fields |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 668 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 669 | Tuple of strings listing the field names. Useful for introspection |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 670 | and for creating new named tuple types from existing named tuples. |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 671 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 672 | .. doctest:: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 673 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 674 | >>> p._fields # view the field names |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 675 | ('x', 'y') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 676 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 677 | >>> Color = namedtuple('Color', 'red green blue') |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 678 | >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 679 | >>> Pixel(11, 22, 128, 255, 0) |
Christian Heimes | 454f37b | 2008-01-10 00:10:02 +0000 | [diff] [blame] | 680 | Pixel(x=11, y=22, red=128, green=255, blue=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 681 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 682 | To retrieve a field whose name is stored in a string, use the :func:`getattr` |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 683 | function: |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 684 | |
| 685 | >>> getattr(p, 'x') |
| 686 | 11 |
| 687 | |
Raymond Hettinger | 651453a | 2009-02-11 00:20:02 +0000 | [diff] [blame] | 688 | To convert a dictionary to a named tuple, use the double-star-operator |
| 689 | (as described in :ref:`tut-unpacking-arguments`): |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 690 | |
| 691 | >>> d = {'x': 11, 'y': 22} |
| 692 | >>> Point(**d) |
| 693 | Point(x=11, y=22) |
| 694 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 695 | Since a named tuple is a regular Python class, it is easy to add or change |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 696 | functionality with a subclass. Here is how to add a calculated field and |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 697 | a fixed-width print format: |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 698 | |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 699 | >>> class Point(namedtuple('Point', 'x y')): |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 700 | ... __slots__ = () |
Christian Heimes | 454f37b | 2008-01-10 00:10:02 +0000 | [diff] [blame] | 701 | ... @property |
| 702 | ... def hypot(self): |
| 703 | ... return (self.x ** 2 + self.y ** 2) ** 0.5 |
| 704 | ... def __str__(self): |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 705 | ... return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot) |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 706 | |
Georg Brandl | 0df7979 | 2008-10-04 18:33:26 +0000 | [diff] [blame] | 707 | >>> for p in Point(3, 4), Point(14, 5/7): |
Christian Heimes | 0041223 | 2008-01-10 16:02:19 +0000 | [diff] [blame] | 708 | ... print(p) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 709 | Point: x= 3.000 y= 4.000 hypot= 5.000 |
| 710 | Point: x=14.000 y= 0.714 hypot=14.018 |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 711 | |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame] | 712 | The subclass shown above sets ``__slots__`` to an empty tuple. This keeps |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 713 | keep memory requirements low by preventing the creation of instance dictionaries. |
| 714 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 715 | |
| 716 | Subclassing is not useful for adding new, stored fields. Instead, simply |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 717 | create a new named tuple type from the :attr:`_fields` attribute: |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 718 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 719 | >>> Point3D = namedtuple('Point3D', Point._fields + ('z',)) |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 720 | |
| 721 | Default values can be implemented by using :meth:`_replace` to |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 722 | customize a prototype instance: |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 723 | |
| 724 | >>> Account = namedtuple('Account', 'owner balance transaction_count') |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 725 | >>> default_account = Account('<owner name>', 0.0, 0) |
| 726 | >>> johns_account = default_account._replace(owner='John') |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 727 | |
Christian Heimes | e4ca815 | 2008-05-08 17:18:53 +0000 | [diff] [blame] | 728 | Enumerated constants can be implemented with named tuples, but it is simpler |
| 729 | and more efficient to use a simple class declaration: |
| 730 | |
| 731 | >>> Status = namedtuple('Status', 'open pending closed')._make(range(3)) |
| 732 | >>> Status.open, Status.pending, Status.closed |
| 733 | (0, 1, 2) |
| 734 | >>> class Status: |
| 735 | ... open, pending, closed = range(3) |
| 736 | |
Raymond Hettinger | 651453a | 2009-02-11 00:20:02 +0000 | [diff] [blame] | 737 | .. seealso:: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 738 | |
Raymond Hettinger | 651453a | 2009-02-11 00:20:02 +0000 | [diff] [blame] | 739 | `Named tuple recipe <http://code.activestate.com/recipes/500261/>`_ |
| 740 | adapted for Python 2.4. |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 741 | |
| 742 | |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 743 | :class:`OrderedDict` objects |
| 744 | ---------------------------- |
| 745 | |
| 746 | Ordered dictionaries are just like regular dictionaries but they remember the |
| 747 | order that items were inserted. When iterating over an ordered dictionary, |
| 748 | the items are returned in the order their keys were first added. |
| 749 | |
| 750 | .. class:: OrderedDict([items]) |
| 751 | |
| 752 | Return an instance of a dict subclass, supporting the usual :class:`dict` |
| 753 | methods. An *OrderedDict* is a dict that remembers the order that keys |
| 754 | were first inserted. If a new entry overwrites an existing entry, the |
| 755 | original insertion position is left unchanged. Deleting an entry and |
| 756 | reinserting it will move it to the end. |
| 757 | |
Benjamin Peterson | d45bf58 | 2009-03-02 21:44:54 +0000 | [diff] [blame] | 758 | .. versionadded:: 3.1 |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 759 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 760 | .. method:: popitem(last=True) |
Raymond Hettinger | dc879f0 | 2009-03-19 20:30:56 +0000 | [diff] [blame] | 761 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 762 | The :meth:`popitem` method for ordered dictionaries returns and removes a |
| 763 | (key, value) pair. The pairs are returned in LIFO order if *last* is true |
| 764 | or FIFO order if false. |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 765 | |
Raymond Hettinger | e909150 | 2009-05-19 17:40:07 +0000 | [diff] [blame] | 766 | In addition to the usual mapping methods, ordered dictionaries also support |
| 767 | reverse iteration using :func:`reversed`. |
| 768 | |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 769 | Equality tests between :class:`OrderedDict` objects are order-sensitive |
| 770 | and are implemented as ``list(od1.items())==list(od2.items())``. |
| 771 | Equality tests between :class:`OrderedDict` objects and other |
| 772 | :class:`Mapping` objects are order-insensitive like regular dictionaries. |
| 773 | This allows :class:`OrderedDict` objects to be substituted anywhere a |
| 774 | regular dictionary is used. |
| 775 | |
Raymond Hettinger | 3618078 | 2009-04-09 22:34:23 +0000 | [diff] [blame] | 776 | The :class:`OrderedDict` constructor and :meth:`update` method both accept |
| 777 | keyword arguments, but their order is lost because Python's function call |
| 778 | semantics pass-in keyword arguments using a regular unordered dictionary. |
| 779 | |
Raymond Hettinger | dc879f0 | 2009-03-19 20:30:56 +0000 | [diff] [blame] | 780 | .. seealso:: |
| 781 | |
| 782 | `Equivalent OrderedDict recipe <http://code.activestate.com/recipes/576693/>`_ |
| 783 | that runs on Python 2.4 or later. |
| 784 | |
Raymond Hettinger | c529c2f | 2009-11-10 18:21:06 +0000 | [diff] [blame] | 785 | Since an ordered dictionary remembers its insertion order, it can be used |
| 786 | in conjuction with sorting to make a sorted dictionary:: |
| 787 | |
| 788 | >>> # regular unsorted dictionary |
| 789 | >>> d = {'banana': 3, 'apple':4, 'pear': 1, 'orange': 2} |
| 790 | |
| 791 | >>> # dictionary sorted by key |
| 792 | >>> OrderedDict(sorted(d.items(), key=lambda t: t[0])) |
| 793 | OrderedDict([('apple', 4), ('banana', 3), ('orange', 2), ('pear', 1)]) |
| 794 | |
| 795 | >>> # dictionary sorted by value |
| 796 | >>> OrderedDict(sorted(d.items(), key=lambda t: t[1])) |
| 797 | OrderedDict([('pear', 1), ('orange', 2), ('banana', 3), ('apple', 4)]) |
| 798 | |
| 799 | >>> # dictionary sorted by length of the key string |
| 800 | >>> OrderedDict(sorted(d.items(), key=lambda t: len(t[0]))) |
| 801 | OrderedDict([('pear', 1), ('apple', 4), ('orange', 2), ('banana', 3)]) |
| 802 | |
| 803 | The new sorted dictionaries maintain their sort order when entries |
| 804 | are deleted. But when new keys are added, the keys are appended |
| 805 | to the end and the sort is not maintained. |
| 806 | |
Raymond Hettinger | 5a34b7f | 2010-07-31 10:16:57 +0000 | [diff] [blame] | 807 | It is also straight-forward to create an ordered dictionary variant |
| 808 | that the remembers the order the keys were *last* inserted. |
| 809 | If a new entry overwrites an existing entry, the |
| 810 | original insertion position is changed and moved to the end:: |
| 811 | |
| 812 | class LastUpdatedOrderedDict(OrderedDict): |
| 813 | 'Store items is the order the keys were last added' |
| 814 | def __setitem__(self, key, value): |
| 815 | if key in self: |
| 816 | del self[key] |
| 817 | OrderedDict.__setitem__(self, key, value) |
| 818 | |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 819 | |
| 820 | :class:`UserDict` objects |
Mark Summerfield | 8f2d006 | 2008-02-06 13:30:44 +0000 | [diff] [blame] | 821 | ------------------------- |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 822 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 823 | The class, :class:`UserDict` acts as a wrapper around dictionary objects. |
| 824 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 825 | subclass directly from :class:`dict`; however, this class can be easier |
| 826 | to work with because the underlying dictionary is accessible as an |
| 827 | attribute. |
| 828 | |
| 829 | .. class:: UserDict([initialdata]) |
| 830 | |
| 831 | Class that simulates a dictionary. The instance's contents are kept in a |
| 832 | regular dictionary, which is accessible via the :attr:`data` attribute of |
| 833 | :class:`UserDict` instances. If *initialdata* is provided, :attr:`data` is |
| 834 | initialized with its contents; note that a reference to *initialdata* will not |
| 835 | be kept, allowing it be used for other purposes. |
| 836 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 837 | In addition to supporting the methods and operations of mappings, |
| 838 | :class:`UserDict` instances provide the following attribute: |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 839 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 840 | .. attribute:: data |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 841 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 842 | A real dictionary used to store the contents of the :class:`UserDict` |
| 843 | class. |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 844 | |
| 845 | |
| 846 | |
| 847 | :class:`UserList` objects |
| 848 | ------------------------- |
| 849 | |
| 850 | This class acts as a wrapper around list objects. It is a useful base class |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 851 | for your own list-like classes which can inherit from them and override |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 852 | existing methods or add new ones. In this way, one can add new behaviors to |
| 853 | lists. |
| 854 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 855 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 856 | subclass directly from :class:`list`; however, this class can be easier |
| 857 | to work with because the underlying list is accessible as an attribute. |
| 858 | |
| 859 | .. class:: UserList([list]) |
| 860 | |
| 861 | Class that simulates a list. The instance's contents are kept in a regular |
| 862 | list, which is accessible via the :attr:`data` attribute of :class:`UserList` |
| 863 | instances. The instance's contents are initially set to a copy of *list*, |
| 864 | defaulting to the empty list ``[]``. *list* can be any iterable, for |
| 865 | example a real Python list or a :class:`UserList` object. |
| 866 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 867 | In addition to supporting the methods and operations of mutable sequences, |
| 868 | :class:`UserList` instances provide the following attribute: |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 869 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 870 | .. attribute:: data |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 871 | |
Benjamin Peterson | 7a502de | 2010-07-18 14:28:26 +0000 | [diff] [blame] | 872 | A real :class:`list` object used to store the contents of the |
| 873 | :class:`UserList` class. |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 874 | |
| 875 | **Subclassing requirements:** Subclasses of :class:`UserList` are expect to |
| 876 | offer a constructor which can be called with either no arguments or one |
| 877 | argument. List operations which return a new sequence attempt to create an |
| 878 | instance of the actual implementation class. To do so, it assumes that the |
| 879 | constructor can be called with a single parameter, which is a sequence object |
| 880 | used as a data source. |
| 881 | |
| 882 | If a derived class does not wish to comply with this requirement, all of the |
| 883 | special methods supported by this class will need to be overridden; please |
| 884 | consult the sources for information about the methods which need to be provided |
| 885 | in that case. |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 886 | |
| 887 | :class:`UserString` objects |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 888 | --------------------------- |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 889 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 890 | The class, :class:`UserString` acts as a wrapper around string objects. |
| 891 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 892 | subclass directly from :class:`str`; however, this class can be easier |
| 893 | to work with because the underlying string is accessible as an |
| 894 | attribute. |
| 895 | |
| 896 | .. class:: UserString([sequence]) |
| 897 | |
| 898 | Class that simulates a string or a Unicode string object. The instance's |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 899 | content is kept in a regular string object, which is accessible via the |
| 900 | :attr:`data` attribute of :class:`UserString` instances. The instance's |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 901 | contents are initially set to a copy of *sequence*. The *sequence* can |
| 902 | be an instance of :class:`bytes`, :class:`str`, :class:`UserString` (or a |
| 903 | subclass) or an arbitrary sequence which can be converted into a string using |
| 904 | the built-in :func:`str` function. |
Raymond Hettinger | f56c9cd | 2010-08-08 00:32:32 +0000 | [diff] [blame] | 905 | |
| 906 | |
| 907 | ABCs - abstract base classes |
| 908 | ---------------------------- |
| 909 | |
| 910 | The collections module offers the following ABCs: |
| 911 | |
| 912 | ========================= ===================== ====================== ==================================================== |
| 913 | ABC Inherits Abstract Methods Mixin Methods |
| 914 | ========================= ===================== ====================== ==================================================== |
| 915 | :class:`Container` ``__contains__`` |
| 916 | :class:`Hashable` ``__hash__`` |
| 917 | :class:`Iterable` ``__iter__`` |
| 918 | :class:`Iterator` :class:`Iterable` ``__next__`` ``__iter__`` |
| 919 | :class:`Sized` ``__len__`` |
| 920 | :class:`Callable` ``__call__`` |
| 921 | |
| 922 | :class:`Sequence` :class:`Sized`, ``__getitem__`` ``__contains__``. ``__iter__``, ``__reversed__``. |
| 923 | :class:`Iterable`, ``index``, and ``count`` |
| 924 | :class:`Container` |
| 925 | |
| 926 | :class:`MutableSequence` :class:`Sequence` ``__setitem__`` Inherited Sequence methods and |
| 927 | ``__delitem__``, ``append``, ``reverse``, ``extend``, ``pop``, |
| 928 | and ``insert`` ``remove``, and ``__iadd__`` |
| 929 | |
| 930 | :class:`Set` :class:`Sized`, ``__le__``, ``__lt__``, ``__eq__``, ``__ne__``, |
| 931 | :class:`Iterable`, ``__gt__``, ``__ge__``, ``__and__``, ``__or__`` |
| 932 | :class:`Container` ``__sub__``, ``__xor__``, and ``isdisjoint`` |
| 933 | |
| 934 | :class:`MutableSet` :class:`Set` ``add`` and Inherited Set methods and |
| 935 | ``discard`` ``clear``, ``pop``, ``remove``, ``__ior__``, |
| 936 | ``__iand__``, ``__ixor__``, and ``__isub__`` |
| 937 | |
| 938 | :class:`Mapping` :class:`Sized`, ``__getitem__`` ``__contains__``, ``keys``, ``items``, ``values``, |
| 939 | :class:`Iterable`, ``get``, ``__eq__``, and ``__ne__`` |
| 940 | :class:`Container` |
| 941 | |
| 942 | :class:`MutableMapping` :class:`Mapping` ``__setitem__`` and Inherited Mapping methods and |
| 943 | ``__delitem__`` ``pop``, ``popitem``, ``clear``, ``update``, |
| 944 | and ``setdefault`` |
| 945 | |
| 946 | |
| 947 | :class:`MappingView` :class:`Sized` ``__len__`` |
| 948 | :class:`KeysView` :class:`MappingView`, ``__contains__``, |
| 949 | :class:`Set` ``__iter__`` |
| 950 | :class:`ItemsView` :class:`MappingView`, ``__contains__``, |
| 951 | :class:`Set` ``__iter__`` |
| 952 | :class:`ValuesView` :class:`MappingView` ``__contains__``, ``__iter__`` |
| 953 | ========================= ===================== ====================== ==================================================== |
| 954 | |
| 955 | These ABCs allow us to ask classes or instances if they provide |
| 956 | particular functionality, for example:: |
| 957 | |
| 958 | size = None |
| 959 | if isinstance(myvar, collections.Sized): |
| 960 | size = len(myvar) |
| 961 | |
| 962 | Several of the ABCs are also useful as mixins that make it easier to develop |
| 963 | classes supporting container APIs. For example, to write a class supporting |
| 964 | the full :class:`Set` API, it only necessary to supply the three underlying |
| 965 | abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`. |
| 966 | The ABC supplies the remaining methods such as :meth:`__and__` and |
| 967 | :meth:`isdisjoint` :: |
| 968 | |
| 969 | class ListBasedSet(collections.Set): |
| 970 | ''' Alternate set implementation favoring space over speed |
| 971 | and not requiring the set elements to be hashable. ''' |
| 972 | def __init__(self, iterable): |
| 973 | self.elements = lst = [] |
| 974 | for value in iterable: |
| 975 | if value not in lst: |
| 976 | lst.append(value) |
| 977 | def __iter__(self): |
| 978 | return iter(self.elements) |
| 979 | def __contains__(self, value): |
| 980 | return value in self.elements |
| 981 | def __len__(self): |
| 982 | return len(self.elements) |
| 983 | |
| 984 | s1 = ListBasedSet('abcdef') |
| 985 | s2 = ListBasedSet('defghi') |
| 986 | overlap = s1 & s2 # The __and__() method is supported automatically |
| 987 | |
| 988 | Notes on using :class:`Set` and :class:`MutableSet` as a mixin: |
| 989 | |
| 990 | (1) |
| 991 | Since some set operations create new sets, the default mixin methods need |
| 992 | a way to create new instances from an iterable. The class constructor is |
| 993 | assumed to have a signature in the form ``ClassName(iterable)``. |
| 994 | That assumption is factored-out to an internal classmethod called |
| 995 | :meth:`_from_iterable` which calls ``cls(iterable)`` to produce a new set. |
| 996 | If the :class:`Set` mixin is being used in a class with a different |
| 997 | constructor signature, you will need to override :meth:`from_iterable` |
| 998 | with a classmethod that can construct new instances from |
| 999 | an iterable argument. |
| 1000 | |
| 1001 | (2) |
| 1002 | To override the comparisons (presumably for speed, as the |
| 1003 | semantics are fixed), redefine :meth:`__le__` and |
| 1004 | then the other operations will automatically follow suit. |
| 1005 | |
| 1006 | (3) |
| 1007 | The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value |
| 1008 | for the set; however, :meth:`__hash__` is not defined because not all sets |
| 1009 | are hashable or immutable. To add set hashabilty using mixins, |
| 1010 | inherit from both :meth:`Set` and :meth:`Hashable`, then define |
| 1011 | ``__hash__ = Set._hash``. |
| 1012 | |
| 1013 | .. seealso:: |
| 1014 | |
| 1015 | * `OrderedSet recipe <http://code.activestate.com/recipes/576694/>`_ for an |
| 1016 | example built on :class:`MutableSet`. |
| 1017 | |
| 1018 | * For more about ABCs, see the :mod:`abc` module and :pep:`3119`. |