Information about CodeType in inspect documentation is outdated

[zhangyangyu]

BPO	26985
Nosy	@berkerpeksag, @zhangyangyu
PRs	bpo-26985: Add missing info of code object in inspect documentation #1090 [3.6] bpo-26985: Add missing info of code object in inspect documentation #1099 [3.5] bpo-26985: Add missing info of code object in inspect documentation #1100
Files	inspect_doc.patch

^{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 2017-04-13.03:38:14.900>
created_at = <Date 2016-05-09.14:11:42.209>
labels = ['3.7', 'docs']
title = 'Information about CodeType in inspect documentation is outdated'
updated_at = <Date 2017-04-13.03:38:14.899>
user = 'https://github.com/zhangyangyu'

bugs.python.org fields:

activity = <Date 2017-04-13.03:38:14.899>
actor = 'xiang.zhang'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-04-13.03:38:14.900>
closer = 'xiang.zhang'
components = ['Documentation']
creation = <Date 2016-05-09.14:11:42.209>
creator = 'xiang.zhang'
dependencies = []
files = ['42793']
hgrepos = []
issue_num = 26985
keywords = ['patch']
message_count = 9.0
messages = ['265197', '265222', '267841', '268030', '268033', '268672', '291581', '291586', '291588']
nosy_count = 3.0
nosy_names = ['docs@python', 'berker.peksag', 'xiang.zhang']
pr_nums = ['1090', '1099', '1100']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue26985'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7']

[zhangyangyu]

Information about CodeType in inspect documentation is outdated. It lacks attributes: co_kwonlyargcount, co_freevars, co_cellvars. And co_flags lacks many more options. These also apply to the comments of inspect.iscode source code.

[zhangyangyu]

Attach patch.

[berkerpeksag]

I prefer to not duplicate the list in Lib/inspect.py. We did similar docstring cleanups in several modules (venv for example) recently.

[zhangyangyu]

So maybe remove the docstring entirely?

[berkerpeksag]

"Return true if the object is a code object." should stay. We can add a short sentence to refer people to the inspect documentation for the list of co_* attributes.

[zhangyangyu]

Hmm, when I am going to delete the list in the docstring, I find other functions get lists too in inspect.py. So maybe we should open another issue to clean them after first merging this thread?

[zhangyangyu]

New changeset a6902e6 by Xiang Zhang in branch 'master':
bpo-26985: Add missing info of code object in inspect documentation (GH-1090)
a6902e6

[zhangyangyu]

New changeset 14944c6 by Xiang Zhang in branch '3.6':
bpo-26985: Add missing info of code object in inspect documentation (GH-1090) (GH-1099)
14944c6

[zhangyangyu]

New changeset 72b1d41 by Xiang Zhang in branch '3.5':
bpo-26985: Add missing info of code object in inspect documentation (GH-1090) (GH-1100)
72b1d41