Build-out help() to support a class level data dictionary

[rhettinger]

BPO	36325
Nosy	@rhettinger

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-03-17.09:52:49.346>
created_at = <Date 2019-03-17.09:28:43.842>
labels = ['3.8', 'library']
title = 'Build-out help() to support a class level data dictionary'
updated_at = <Date 2019-03-17.09:52:49.345>
user = 'https://github.com/rhettinger'

bugs.python.org fields:

activity = <Date 2019-03-17.09:52:49.345>
actor = 'rhettinger'
assignee = 'none'
closed = True
closed_date = <Date 2019-03-17.09:52:49.346>
closer = 'rhettinger'
components = ['Library (Lib)']
creation = <Date 2019-03-17.09:28:43.842>
creator = 'rhettinger'
dependencies = []
files = []
hgrepos = []
issue_num = 36325
keywords = []
message_count = 3.0
messages = ['338121', '338122', '338123']
nosy_count = 1.0
nosy_names = ['rhettinger']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue36325'
versions = ['Python 3.8']

[rhettinger]

class Bicycle:

   __data_dictionary__ = dict(
      category = 'Primary use: road, cross-over, or hybrid',
      model = 'Unique six digit vendor-supplied code',
      size = 'Rider size: child, small, medium, large, extra-large',
      price = 'Manufacturer suggested retail price', 
   )

>>> help(Bicycle)
class Bicycle(builtins.object)
 |  Data fields defined here:
 |
 |  category
 |      Primary use: road, cross-over, or hybrid
 |
 |  model
 |      Unique six digit vendor-supplied code
 |
 |  size
 |      Rider size: child, small, medium, large, extra-large
 |
 |  price
 |      Manufacturer suggested retail price
 |
 |  

---

|
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __data_dictionary__ = {'category': 'Primary use: road, cross-over, or .

[rhettinger]

Something like this would be especially helpful for classes using __slots__.

The member objects show-up in help(), but there is no way to attach an explanation like we can with property objects.

So there is a slots only alternative that would only involve modifying help() and nothing else:

   class Bicycle:

       __slots__ = dict(
           category = 'Primary use: road, cross-over, or hybrid',
           model = 'Unique six digit vendor-supplied code',
           size = 'Rider size: child, small, medium, large, extra-large',
           price = 'Manufacturer suggested retail price', 
       )

[rhettinger]

Moving to a fresh issue.