bpo-44301: Docs: Note that tp_clear and m_clear are not always called#27581
Merged
Conversation
encukou
added
docs
Member
Author
|
I still intend to write some better tutorial-style docs on supporting GC. For the reference docs, I think this quick note is useful enough. |
pablogsal
approved these changes
Aug 3, 2021
Member
pablogsal
left a comment
pablogsal
left a comment
There was a problem hiding this comment.
LGTM
A common pattern thought is to invoke tp_clear in tp_dealloc
Member
Author
That's mentioned in the paragraph below (for types; for modules there's a link to |
Contributor
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 4, 2021
(cherry picked from commit 10faada) Co-authored-by: Petr Viktorin <encukou@gmail.com>
|
GH-27596 is a backport of this pull request to the 3.10 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 4, 2021
(cherry picked from commit 10faada) Co-authored-by: Petr Viktorin <encukou@gmail.com>
|
GH-27597 is a backport of this pull request to the 3.9 branch. |
miss-islington
added a commit
that referenced
this pull request
Aug 4, 2021
(cherry picked from commit 10faada) Co-authored-by: Petr Viktorin <encukou@gmail.com>
ambv
pushed a commit
that referenced
this pull request
Aug 4, 2021
Member
|
Thanks @encukou, implementing a type in C is complex, and better documentation is very valuable! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 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.
It was not clear from the documentation that
tp_clear(or in this case,m_clearof modules) is only called by the cyclic GC; when the object reaches zero refcount,tp_clearisn't called.https://bugs.python.org/issue44301