mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-30 12:21:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Minor doc clean-up.

Browse source 
* Show list of fields option before showing the single string alternative.
* Remove the PS2 prompts so that the examples become cut-and-pastable.
This commit is contained in:
Raymond Hettinger 2011-03-19 15:09:00 -07:00
parent 374274db7f
commit dbc5e1280f
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/library/collections.rst
View file

@ -565,9 +565,9 @@ they add the ability to access fields by name instead of position index.
helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` helpful docstring (with typename and field_names) and a helpful :meth:`__repr__`
method which lists the tuple contents in a ``name=value`` format. method which lists the tuple contents in a ``name=value`` format.
The *field_names* are a single string with each fieldname separated by whitespace The *field_names* are a sequence of strings such as ``['x', 'y']``.
and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names* Alternatively, *field_names* can be a single string with each fieldname
can be a sequence of strings such as ``['x', 'y']``. separated by whitespace and/or commas, for example ``'x y'`` or ``'x, y'``.
Any valid Python identifier may be used for a fieldname except for names Any valid Python identifier may be used for a fieldname except for names
starting with an underscore. Valid identifiers consist of letters, digits, starting with an underscore. Valid identifiers consist of letters, digits,
@ -595,7 +595,7 @@ Example:
.. doctest:: .. doctest::
:options: +NORMALIZE_WHITESPACE :options: +NORMALIZE_WHITESPACE
>>> Point = namedtuple('Point', 'x y', verbose=True) >>> Point = namedtuple('Point', ['x', 'y'], verbose=True)
class Point(tuple): class Point(tuple):
'Point(x, y)' 'Point(x, y)'
<BLANKLINE> <BLANKLINE>
@ -699,7 +699,7 @@ field names, the method and attribute names start with an underscore.
Point(x=33, y=22) Point(x=33, y=22)
>>> for partnum, record in inventory.items(): >>> for partnum, record in inventory.items():
... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now()) inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
.. attribute:: somenamedtuple._fields .. attribute:: somenamedtuple._fields
@ -734,15 +734,15 @@ functionality with a subclass. Here is how to add a calculated field and
a fixed-width print format: a fixed-width print format:
>>> class Point(namedtuple('Point', 'x y')): >>> class Point(namedtuple('Point', 'x y')):
... __slots__ = () __slots__ = ()
... @property @property
... def hypot(self): def hypot(self):
... return (self.x ** 2 + self.y ** 2) ** 0.5 return (self.x ** 2 + self.y ** 2) ** 0.5
... def __str__(self): def __str__(self):
... return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot) return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot)
>>> for p in Point(3, 4), Point(14, 5/7.): >>> for p in Point(3, 4), Point(14, 5/7.):
... print p print p
Point: x= 3.000 y= 4.000 hypot= 5.000 Point: x= 3.000 y= 4.000 hypot= 5.000
Point: x=14.000 y= 0.714 hypot=14.018 Point: x=14.000 y= 0.714 hypot=14.018
@ -768,7 +768,7 @@ and more efficient to use a simple class declaration:
>>> Status.open, Status.pending, Status.closed >>> Status.open, Status.pending, Status.closed
(0, 1, 2) (0, 1, 2)
>>> class Status: >>> class Status:
... open, pending, closed = range(3) open, pending, closed = range(3)
.. seealso:: .. seealso::