gh-141004: Document descriptor and dict proxy type objects #141803
+51
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bedevere-app
bot
added
awaiting review
docs
| The type object for member descriptor objects created from | ||
| :c:type:`PyMemberDef` structures. These descriptors expose fields of a | ||
| C struct as attributes on a type, and correspond to ``member_descriptor`` |
Member
There was a problem hiding this comment.
Please link to :class:`types.MemberDescriptorType` instead.
Comment on lines
+39
to
+40
| methods on a type, and correspond to ``method_descriptor`` objects in the | ||
| Python layer. |
Comment on lines
+51
to
+52
| via wrapper structures, and appear in Python as ``wrapper_descriptor`` | ||
| objects. |
Member
There was a problem hiding this comment.
Use :class:`types.WrapperDescriptorType` here.
Comment on lines
+91
to
+96
| .. c:var:: PyTypeObject PyGetSetDescr_Type | ||
| The type object for get/set descriptor objects created from | ||
| :c:type:`PyGetSetDef` structures. These descriptors implement attributes | ||
| whose value is computed by C getter and setter functions, and are used | ||
| for many built-in type attributes. |
Member
There was a problem hiding this comment.
This one is in the wrong section, so please move it. The "Built-in descriptors" section is for objects like classmethod and super.
Comment on lines
+52
to
+53
| underlying dictionary are reflected in the proxy, but the proxy itself | ||
| does not support mutation operations. |
Member
There was a problem hiding this comment.
Could you point to types.MappingProxyType somewhere?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds C API documentation for six previously undocumented type objects:
In
Doc/c-api/descriptor.rst:PyClassMethodDescr_Type- type for class method descriptorsPyGetSetDescr_Type- type for get/set descriptorsPyMemberDescr_Type- type for member descriptorsPyMethodDescr_Type- type for method descriptorsPyWrapperDescr_Type- type for wrapper descriptorsIn
Doc/c-api/dict.rst:PyDictProxy_Type- type for mapping proxy objectsEach entry follows the existing documentation style and includes a brief description of the type's purpose and its relationship to the Python layer.
Contributes to #141004.
📚 Documentation preview 📚: https://cpython-previews--141803.org.readthedocs.build/