diff options
author | Raymond Hettinger <python@rcn.com> | 2007-09-17 00:55:00 (GMT) |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2007-09-17 00:55:00 (GMT) |
commit | d36a60e1e3410450d337d4de732e127e48a6a042 (patch) | |
tree | 00c975e8766388d640629ec794061a33e96c3366 /Doc | |
parent | bf10c47389d13b97e75855b262e077bfa688968c (diff) | |
download | cpython-d36a60e1e3410450d337d4de732e127e48a6a042.zip cpython-d36a60e1e3410450d337d4de732e127e48a6a042.tar.gz cpython-d36a60e1e3410450d337d4de732e127e48a6a042.tar.bz2 |
Sync-up named tuples with the latest version of the ASPN recipe.
Allows optional commas in the field-name spec (help when named tuples are used in conjuction with sql queries).
Adds the __fields__ attribute for introspection and to support conversion to dictionary form.
Adds a __replace__() method similar to str.replace() but using a named field as a target.
Clean-up spelling and presentation in doc-strings.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/collections.rst | 38 |
1 files changed, 35 insertions, 3 deletions
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index 28d48bf..7b639b3 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -374,8 +374,8 @@ Setting the :attr:`default_factory` to :class:`set` makes the .. versionadded:: 2.6 - The *fieldnames* are specified in a single string and are separated by spaces. - Any valid Python identifier may be used for a field name. + The *fieldnames* are specified in a single string and are separated by spaces + and/or commas. Any valid Python identifier may be used for a field name. Example:: @@ -395,7 +395,7 @@ Setting the :attr:`default_factory` to :class:`set` makes the The use cases are the same as those for tuples. The named factories assign meaning to each tuple position and allow for more readable, self-documenting - code. Named tuples can also be used to assign field names to tuples returned + code. Named tuples can also be used to assign field names to tuples returned by the :mod:`csv` or :mod:`sqlite3` modules. For example:: from itertools import starmap @@ -412,6 +412,38 @@ Setting the :attr:`default_factory` to :class:`set` makes the >>> print Color(*m.popitem()) Color(name='blue', code=3) +In addition to the methods inherited from tuples, named tuples support +an additonal method and an informational read-only attribute. + +.. method:: somenamedtuple.replace(field, value) + + Return a new instance of the named tuple with *field* replaced with *value*. + + Examples:: + + >>> p = Point(x=11, y=22) + >>> p.__replace__('x', 33) + Point(x=33, y=22) + + >>> for recordnum, record in inventory: + ... inventory[recordnum] = record.replace('total', record.price * record.quantity) + + +.. attribute:: somenamedtuple.__fields__ + + Return a tuple of strings listing the field names. This is useful for introspection, + for converting a named tuple instance to a dictionary, and for creating new named tuple + types from existing types. + + Examples:: + + >>> dict(zip(p.__fields__, p)) # make a dictionary from a named tuple instance + {'y': 20, 'x': 10} + + >>> ColorPoint = NamedTuple('ColorPoint', ' '.join(Point.__fields__) + ' color') + >>> ColorPoint(10, 20, 'red') + ColorPoint(x=10, y=20, color='red') + .. rubric:: Footnotes .. [#] For information on the star-operator see |