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.

classification
Title: Direct access to tp_dict can lead to stale attributes
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: benjamin.peterson, docs@python, gagern, python-dev
Priority: normal Keywords:

Created on 2011-08-09 20:16 by gagern, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
setup.py gagern, 2011-08-09 20:16 Testcase, all in one file
Messages (3)
msg141840 - (view) Author: Martin von Gagern (gagern) Date: 2011-08-09 20:16
The attached C extension provides a way to manually set an element in the dict of an extension type. As the test case exposes, this can result in a discrepancy between cls.__dict__['key'] and cls.key.

Please tell me up front if my extension simply does something explixitely forbidden, and point me at the documentation saying so.
http://docs.python.org/py3k/c-api/typeobj.html#PyTypeObject.tp_dict at least doesn't appear to explicitely forbid my approach, even if it probably is not the preferred way.

If you consider what I'm doing to be really evil, you might want to ban that practice more clearly, by adding a suitable note to the documentation of the tp_dict member.

In case you cannot reproduce, running the attached testcase script with "test" as its sole command line argument, I get the following lines, among others:

Traceback (most recent call last):
  File ".../setDictTest.py", line 10, in test1
    self.assertEqual(setDictCls.__dict__['key'], setDictCls.key)
AssertionError: 'bar' != 'foo'

I assume that the attribute-style setDictCls.key access will somehow cache its result, thus missing the modification to the underlying dict. Just a guess, though.

I've had this issue involved in segmentation faults, where the stale object had already been finalized. But as the code involved there might have been broken in other ways as well, I'll not classify this as type "crash" but only as "behaviour".
msg141841 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2011-08-09 20:22
This is forbidden, and I agree there should be a doc note. See #1878.
msg141845 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-08-09 21:17
New changeset 6ef65516fd7a by Benjamin Peterson in branch '3.2':
note mutating tp_dict is bad (closes #12719)
http://hg.python.org/cpython/rev/6ef65516fd7a

New changeset 69df5a8d164e by Benjamin Peterson in branch 'default':
merge 3.2 (#12719)
http://hg.python.org/cpython/rev/69df5a8d164e
History
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56928
2011-08-09 21:17:24python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg141845

resolution: fixed
stage: resolved
2011-08-09 20:22:50benjamin.petersonsetnosy: + docs@python, benjamin.peterson
messages: + msg141841

assignee: docs@python
components: + Documentation, - Extension Modules
2011-08-09 20:16:29gagerncreate