Message279304
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. |
|
Date |
User |
Action |
Args |
2016-10-24 12:03:04 | levkivskyi | set | recipients:
+ levkivskyi, gvanrossum, docs@python |
2016-10-24 12:03:04 | levkivskyi | set | messageid: <1477310584.34.0.261643270956.issue28519@psf.upfronthosting.co.za> |
2016-10-24 12:03:04 | levkivskyi | link | issue28519 messages |
2016-10-24 12:03:03 | levkivskyi | create | |
|