Skip to content

gh-116935: Document that heap types need to support garbage collection #118021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 8 commits into from
Apr 19, 2024
Merged

gh-116935: Document that heap types need to support garbage collection #118021

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
daba4dd
Add note about heap type gc requirement
savannahostrowski Apr 18, 2024
8ff77ca
Merge branch 'main' into fix-116935
savannahostrowski Apr 19, 2024
0717c15
add reference to cyclic gc
savannahostrowski Apr 19, 2024
15d6111
Merge branch 'main' into fix-116935
savannahostrowski Apr 19, 2024
8e8ff20
Merge branch 'main' into fix-116935
savannahostrowski Apr 19, 2024
c6609a8
update reference
savannahostrowski Apr 19, 2024
e0bc46b
line length
savannahostrowski Apr 19, 2024
4ebe973
“should”
encukou Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1034,7 +1034,8 @@ and :c:data:`PyType_Type` effectively act as defaults.)
the type, and the type object is INCREF'ed when a new instance is created, and
DECREF'ed when an instance is destroyed (this does not apply to instances of
subtypes; only the type referenced by the instance's ob_type gets INCREF'ed or
DECREF'ed).
DECREF'ed). Heap types should also :ref:`support garbage collection <supporting-cycle-detection>`
as they can form a reference cycle with their own module object.

**Inheritance:**

Expand Down