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: No documentation for Py_TPFLAGS_HAVE_STACKLESS_EXTENSION or Py_TPFLAGS_HAVE_VERSION_TAG.
Type: Stage:
Components: Documentation Versions: Python 3.10, Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, pitrou, pmpp, stutzbach
Priority: normal Keywords:

Created on 2010-03-02 15:34 by stutzbach, last changed 2022-04-11 14:56 by admin.

Messages (4)
msg100298 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-03-02 15:34
The documentation for Py_TPFLAGS_DEFAULT mentions Py_TPFLAGS_HAVE_STACKLESS_EXTENSION and Py_TPFLAGS_HAVE_VERSION_TAG, but neither of them is documented.  They aren't mentioned in the 2.6 documentation (presumably because they were introduced in 3.x?).

http://docs.python.org/dev/py3k/c-api/typeobj.html?highlight=py_tpflags_have_gc#Py_TPFLAGS_DEFAULT
msg112972 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2010-08-05 12:02
I don't think these flags need documenting or even deserve mentioning. Py_TPFLAGS_HAVE_STACKLESS_EXTENSION seems to be two bits reserved for use by Stackless, while Py_TPFLAGS_HAVE_VERSION_TAG should be considered by extension authors an internal implementation detail (in normal circumstances, it won't impact how they have to write their code or the semantics of their extension types).
msg113491 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-08-09 22:18
I think if they are mentioned, they should be documented.  Removing mention of them would be fine with me.

Looking at this again, I think the description of Py_TPFLAGS_DEFAULT is no longer accurate.  It reads: "This is a bitmask of all the bits that pertain to the existence of certain fields in the type object and its extension structures. Currently, it includes the following bits: Py_TPFLAGS_HAVE_STACKLESS_EXTENSION, Py_TPFLAGS_HAVE_VERSION_TAG."

But neither of those flags pertain to the existence of certain fields, do they?

Perhaps it should simply read: "This bitmask should be set by all types to define certain bits used internally by Python."
msg227971 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2014-09-30 18:39
@Daniel could you supply a patch for this?
History
Date User Action Args
2022-04-11 14:56:58adminsetgithub: 52289
2020-11-08 11:23:53pmppsetnosy: + pmpp
2020-11-06 19:49:13iritkatrielsetversions: + Python 3.8, Python 3.9, Python 3.10, - Python 3.1, Python 3.2, Python 3.3
2019-04-26 20:40:25BreamoreBoysetnosy: - BreamoreBoy
2014-09-30 18:39:03BreamoreBoysetnosy: + BreamoreBoy
messages: + msg227971
2010-08-09 22:18:18stutzbachsetmessages: + msg113491
2010-08-05 12:02:54pitrousetnosy: + pitrou
messages: + msg112972
2010-08-05 03:33:38BreamoreBoysetassignee: georg.brandl -> docs@python

nosy: + docs@python
2010-03-02 15:34:57stutzbachcreate