Issue 23008: pydoc enum.{,Int}Enum fails (original) (raw)

Created on 2014-12-08 06:04 by Antony.Lee, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
pydoc_resolve_false.patch serhiy.storchaka,2015-04-11 18:22 review
pydoc_resolve_false_2.patch serhiy.storchaka,2015-04-14 08:00 review
Messages (8)
msg232298 - (view) Author: Antony Lee (Antony.Lee) * Date: 2014-12-08 06:04
Not a big deal, but "$ pydoc enum.Enum" and "$ pydoc enum.IntEnum" fail to retrieve the docstrings, while they are visible with "$ pydoc enum".
msg240490 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2015-04-11 18:22
This is because bool(enum.Enum) is False. Other example: $ pydoc3 builtins.False no Python documentation found for 'builtins.False' $ pydoc3 builtins.True Help on bool in builtins object: builtins.True = class bool(int) ... Here is simple fix.
msg240495 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2015-04-11 21:38
Lgtm, needs a test case.
msg240511 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-04-11 23:34
The fix is definitely an improvement. Though there is still one obvious flaw remaining, which applies to any attribute that is set to None: $ ~/proj/python/cpython/python -bWall -m pydoc builtins.None No Python documentation found for 'builtins.None'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
msg240543 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2015-04-12 05:53
In 3.5 at least 'pydoc None' works.
msg240855 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2015-04-14 08:00
I think we can ignore this flaw. 'pydoc None' works, and any solution for None aliases could break existing code that use private pydoc functions. Here is a patch with a test.
msg241727 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2015-04-21 17:29
Patch looks good, get it in! :)
msg241728 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-04-21 18:11
New changeset d1b9eb9de8af by Serhiy Storchaka in branch '2.7': Issue #23008: Fixed resolving attributes with boolean value is False in pydoc. https://hg.python.org/cpython/rev/d1b9eb9de8af New changeset a480f470c469 by Serhiy Storchaka in branch '3.4': Issue #23008: Fixed resolving attributes with boolean value is False in pydoc. https://hg.python.org/cpython/rev/a480f470c469 New changeset 03330e5edb37 by Serhiy Storchaka in branch 'default': Issue #23008: Fixed resolving attributes with boolean value is False in pydoc. https://hg.python.org/cpython/rev/03330e5edb37
History
Date User Action Args
2022-04-11 14:58:10 admin set github: 67197
2015-04-21 18:12:13 serhiy.storchaka set status: open -> closedassignee: serhiy.storchakaresolution: fixedstage: patch review -> resolved
2015-04-21 18:11:48 python-dev set nosy: + python-devmessages: +
2015-04-21 17:29:51 ethan.furman set messages: +
2015-04-14 08:00:55 serhiy.storchaka set files: + pydoc_resolve_false_2.patchmessages: + stage: test needed -> patch review
2015-04-12 05:53:39 ethan.furman set messages: + stage: patch review -> test needed
2015-04-11 23:34:22 martin.panter set nosy: + martin.pantermessages: +
2015-04-11 21:38:39 r.david.murray set nosy: + r.david.murraymessages: +
2015-04-11 18:22:21 serhiy.storchaka set files: + pydoc_resolve_false.patchversions: + Python 2.7, Python 3.5keywords: + patchnosy: + serhiy.storchakamessages: + stage: patch review
2015-04-11 16:52:47 ethan.furman set nosy: + barry, eli.bendersky
2015-03-08 17:08:07 BreamoreBoy set type: behavior
2014-12-08 16:14:47 berker.peksag set nosy: + ethan.furman
2014-12-08 06:04:08 Antony.Lee create