This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author levkivskyi
Recipients docs@python, gvanrossum, levkivskyi
Date 2016-10-24.12:03:03
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1477310584.34.0.261643270956.issue28519@psf.upfronthosting.co.za>
In-reply-to
Content
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:04levkivskyisetrecipients: + levkivskyi, gvanrossum, docs@python
2016-10-24 12:03:04levkivskyisetmessageid: <1477310584.34.0.261643270956.issue28519@psf.upfronthosting.co.za>
2016-10-24 12:03:04levkivskyilinkissue28519 messages
2016-10-24 12:03:03levkivskyicreate