diff options
author | Raymond Hettinger <python@rcn.com> | 2015-08-18 22:25:16 -0700 |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2015-08-18 22:25:16 -0700 |
commit | 161585817b3f8aa994b4ccfe02961c5238d1d5b8 (patch) | |
tree | 62ed5095695e653bda2cabf20bc5983dfda5291f /Lib/pydoc.py | |
parent | acedfd119e133823b987f4f09ba08da2c22de612 (diff) | |
download | cpython-161585817b3f8aa994b4ccfe02961c5238d1d5b8.tar.gz |
Issue #24879: Teach pydoc to display named tuple fields in the order they were defined.
Diffstat (limited to 'Lib/pydoc.py')
-rwxr-xr-x | Lib/pydoc.py | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/Lib/pydoc.py b/Lib/pydoc.py index ee558bfea3..f4f253010f 100755 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -209,6 +209,18 @@ def classify_class_attrs(object): results.append((name, kind, cls, value)) return results +def sort_attributes(attrs, object): + 'Sort the attrs list in-place by _fields and then alphabetically by name' + # This allows data descriptors to be ordered according + # to a _fields attribute if present. + fields = getattr(object, '_fields', []) + try: + field_order = {name : i-len(fields) for (i, name) in enumerate(fields)} + except TypeError: + field_order = {} + keyfunc = lambda attr: (field_order.get(attr[0], 0), attr[0]) + attrs.sort(key=keyfunc) + # ----------------------------------------------------- module manipulation def ispackage(path): @@ -867,8 +879,7 @@ class HTMLDoc(Doc): object.__module__) tag += ':<br>\n' - # Sort attrs by name. - attrs.sort(key=lambda t: t[0]) + sort_attributes(attrs, object) # Pump out the attrs, segregated by kind. attrs = spill('Methods %s' % tag, attrs, @@ -1286,8 +1297,8 @@ location listed above. else: tag = "inherited from %s" % classname(thisclass, object.__module__) - # Sort attrs by name. - attrs.sort() + + sort_attributes(attrs, object) # Pump out the attrs, segregated by kind. attrs = spill("Methods %s:\n" % tag, attrs, |