[Python-checkins] r78811 - in python/trunk: Doc/library/collections.rst Lib/collections.py

Tue Mar 9 10:01:46 CET 2010

Author: raymond.hettinger
Date: Tue Mar 9 10:01:46 2010
New Revision: 78811
Log:
Add nicer docstrings to namedtuples().
Provides better tooltips and looks better in help().
Modified:
 python/trunk/Doc/library/collections.rst
 python/trunk/Lib/collections.py
Modified: python/trunk/Doc/library/collections.rst
==============================================================================

--- python/trunk/Doc/library/collections.rst	(original)
+++ python/trunk/Doc/library/collections.rst	Tue Mar 9 10:01:46 2010
@@ -679,6 +679,7 @@
 _fields = ('x', 'y')
 <BLANKLINE>
 def __new__(_cls, x, y):
+ 'Create a new instance of Point(x, y)'
 return _tuple.__new__(_cls, (x, y))
 <BLANKLINE>
 @classmethod
@@ -690,6 +691,7 @@
 return result
 <BLANKLINE>
 def __repr__(self):
+ 'Return a nicely formatted representation string'
 return 'Point(x=%r, y=%r)' % self
 <BLANKLINE>
 def _asdict(self):
@@ -704,10 +706,11 @@
 return result
 <BLANKLINE>
 def __getnewargs__(self):
+ 'Return self as a plain tuple. Used by copy and pickle.'
 return tuple(self)
 <BLANKLINE>
- x = _property(_itemgetter(0))
- y = _property(_itemgetter(1))
+ x = _property(_itemgetter(0), doc='Alias for field number 0')
+ y = _property(_itemgetter(1), doc='Alias for field number 1')
 
 >>> p = Point(11, y=22) # instantiate with positional or keyword arguments
 >>> p[0] + p[1] # indexable like the plain tuple (11, 22)
Modified: python/trunk/Lib/collections.py
==============================================================================
--- python/trunk/Lib/collections.py	(original)
+++ python/trunk/Lib/collections.py	Tue Mar 9 10:01:46 2010
@@ -230,6 +230,7 @@
 __slots__ = () \n
 _fields = %(field_names)r \n
 def __new__(_cls, %(argtxt)s):
+ 'Create new instance of %(typename)s(%(argtxt)s)'
 return _tuple.__new__(_cls, (%(argtxt)s)) \n
 @classmethod
 def _make(cls, iterable, new=tuple.__new__, len=len):
@@ -239,6 +240,7 @@
 raise TypeError('Expected %(numfields)d arguments, got %%d' %% len(result))
 return result \n
 def __repr__(self):
+ 'Return a nicely formatted representation string'
 return '%(typename)s(%(reprtxt)s)' %% self \n
 def _asdict(self):
 'Return a new OrderedDict which maps field names to their values'
@@ -250,9 +252,10 @@
 raise ValueError('Got unexpected field names: %%r' %% kwds.keys())
 return result \n
 def __getnewargs__(self):
+ 'Return self as a plain tuple. Used by copy and pickle.'
 return tuple(self) \n\n''' % locals()
 for i, name in enumerate(field_names):
- template += ' %s = _property(_itemgetter(%d))\n' % (name, i)
+ template += " %s = _property(_itemgetter(%d), doc='Alias for field number %d')\n" % (name, i, i)
 if verbose:
 print template
 
