classification
Title: Update pydoc tool to support generic types
Type: enhancement Stage:
Components: Documentation, Library (Lib) Versions: Python 3.7, Python 3.6, Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, levkivskyi
Priority: normal Keywords:

Created on 2016-10-24 12:03 by levkivskyi, last changed 2016-10-24 12:03 by levkivskyi.

Messages (1)
msg279304 - (view) Author: Ivan Levkivskyi (levkivskyi) * (Python committer) Date: 2016-10-24 12:03
It was proposed in the discussion of #27989 to update pydoc rendering of documentation of classes supporting generic types.

Currently there are two ideas:
1. Keep the class header intact (i.e. listing actual runtime __bases__)
and adding a separate section describing generic info using __orig_bases__ and __parameters__. For example:

"""
class MyClass(typing.List, typing.Mapping):
...
(usual info)
...
This is a generic class consistent with List[~T], Mapping[str, +VT_co]
Type parameters: invariant T, covariant VT_co
"""

2. Do not add a separate section, but modify the header to display __orig_bases__. For example:


"""
class MyClass(List[~T], Mapping[str, +VT_co]):
...
(usual info)
...

"""

Guido prefers the second option. I am a bit afraid that this will cause people to use issubclass() with parameterized generics, but now issubclass(cls, List[T]) is a TypeError, only issubclass(cls, List) is allowed. So that I am more inclined towards first option.
History
Date User Action Args
2016-10-24 12:03:04levkivskyicreate