gh-102013: Add PyUnstable_GC_VisitObjects #102014

jbower-fb · 2023-02-18T00:47:13Z

Issue: Add a public C-API function to iterate over GC’able objects #102013

Co-authored-by: Brett Simmers <bsimmers@meta.com>

cpython-cla-bot · 2023-02-18T00:47:16Z

All commit authors signed the Contributor License Agreement.

bedevere-bot · 2023-02-18T00:47:20Z

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

…tion, add ability to terminate iteration early with test.

…owerfb into gcvisitobjs

Misc/NEWS.d/next/C API/2023-02-18-00-55-14.gh-issue-102013.83mrtI.rst

Modules/_testcapimodule.c

Modules/gcmodule.c

Include/objimpl.h

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

jbower-fb · 2023-02-24T03:03:04Z

Thank you for the feedback @erlend-aasland. I'll try to get better at PEP-7 compliance in future!

jbower-fb · 2023-03-08T03:11:31Z

Hey @pablogsal, any thoughts on this?

encukou

API-wise, this looks good!

encukou · 2023-03-08T09:49:58Z

Include/objimpl.h

@@ -157,6 +157,25 @@ PyAPI_FUNC(int) PyGC_Enable(void);
 PyAPI_FUNC(int) PyGC_Disable(void);
 PyAPI_FUNC(int) PyGC_IsEnabled(void);

+
+#if !defined(Py_LIMITED_API)


You can put this in Include/cpython/objimpl.h, which is only included for non-limited API. But that's not a blocker.

I'm not very familiar with the conventions here, is that what we should do with public API (even if it's unstable)?

Yes.

Details are in the Devguide.

pablogsal · 2023-03-08T11:37:11Z

Hey @pablogsal, any thoughts on this?

Will make a review later this week. Apologies for the delay but I am a bit swamped recently

Doc/c-api/gcsupport.rst

Modules/_testcapimodule.c

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

pablogsal

Apologies for the delay although the advantage of being late is that everyone has already done an excellent job with the reviews.

LGTM

Thanks a lot for the patience and understanding @jbower-fb and thanks for the great work :)

* main: (50 commits) pythongh-102674: Remove _specialization_stats from Lib/opcode.py (python#102685) pythongh-102660: Handle m_copy Specially for the sys and builtins Modules (pythongh-102661) pythongh-102354: change python3 to python in docs examples (python#102696) pythongh-81057: Add a CI Check for New Unsupported C Global Variables (pythongh-102506) pythonGH-94851: check unicode consistency of static strings in debug mode (python#102684) pythongh-100315: clarification to `__slots__` docs. (python#102621) pythonGH-100227: cleanup initialization of global interned dict (python#102682) doc: Remove a duplicate 'versionchanged' in library/asyncio-task (pythongh-102677) pythongh-102013: Add PyUnstable_GC_VisitObjects (python#102014) pythonGH-102670: Use sumprod() to simplify, speed up, and improve accuracy of statistics functions (pythonGH-102649) pythongh-102627: Replace address pointing toward malicious web page (python#102630) pythongh-98831: Use DECREF_INPUTS() more (python#102409) pythongh-101659: Avoid Allocation for Shared Exceptions in the _xxsubinterpreters Module (pythongh-102659) pythongh-101524: Fix the ChannelID tp_name (pythongh-102655) pythongh-102069: Fix `__weakref__` descriptor generation for custom dataclasses (python#102075) pythongh-98169 dataclasses.astuple support DefaultDict (python#98170) pythongh-102650: Remove duplicate include directives from multiple source files (python#102651) pythonGH-100987: Don't cache references to the names and consts array in `_PyEval_EvalFrameDefault`. (python#102640) pythongh-87092: refactor assemble() to a number of separate functions, which do not need the compiler struct (python#102562) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives (python#102631) ...

Add PyGC_VisitObjects

c4a91e0

Co-authored-by: Brett Simmers <bsimmers@meta.com>

jbower-fb requested a review from pablogsal as a code owner February 18, 2023 00:47

bedevere-bot added the awaiting review label Feb 18, 2023

bedevere-bot mentioned this pull request Feb 18, 2023

Add a public C-API function to iterate over GC’able objects #102013

Closed

blurb-it bot and others added 2 commits February 18, 2023 00:55

📜🤖 Added by blurb_it.

57edf6d

Remove from Limited API

447bb53

pablogsal self-assigned this Feb 19, 2023

hauntsaninja and others added 3 commits February 20, 2023 11:39

Merge branch 'main' into gcvisitobjs

d4f9505

Updated to "unstable" API, protect against GC and current object dele…

d34a900

…tion, add ability to terminate iteration early with test.

Merge branch 'gcvisitobjs' of https://github.com/jbower-fb/cpython-jb…

7c1fbbb

…owerfb into gcvisitobjs

erlend-aasland reviewed Feb 23, 2023

View reviewed changes

jbower-fb and others added 10 commits February 23, 2023 11:53

Fix formatting in Modules/_testcapimodule.c

9b0c461

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/_testcapimodule.c

29f7f88

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/_testcapimodule.c

e16f1e3

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/_testcapimodule.c

024ee30

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/gcmodule.c

bd65abb

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/gcmodule.c

f03e581

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Fix formatting in Modules/gcmodule.c

16ea0d6

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Simplify test in Modules/_testcapimodule.c

369e199

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Address minor review comments and add documentation.

219154a

Merge branch 'main' into gcvisitobjs

be5b7f0

encukou approved these changes Mar 8, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Mar 8, 2023

erlend-aasland reviewed Mar 10, 2023

View reviewed changes

jbower-fb and others added 5 commits March 11, 2023 10:54

Update Doc/c-api/gcsupport.rst

5752f1c

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Update Modules/_testcapimodule.c

1512004

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Update Modules/_testcapimodule.c

87a5b56

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Minor doc tweaks from review

295f7dd

Merge branch 'python:main' into gcvisitobjs

ed06dff

pablogsal approved these changes Mar 13, 2023

View reviewed changes

Merge branch 'main' into gcvisitobjs

620043b

pablogsal changed the title ~~gh-102013: Add PyGC_VisitObjects~~ gh-102013: Add PyUnstable_GC_VisitObjects Mar 14, 2023

pablogsal merged commit cbd3fbf into python:main Mar 14, 2023

bedevere-bot removed the awaiting merge label Mar 14, 2023

Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this pull request Mar 27, 2023

pythongh-102013: Add PyUnstable_GC_VisitObjects (python#102014)

91a5bd4

warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023

pythongh-102013: Add PyUnstable_GC_VisitObjects (python#102014)

a69eb22

jbower-fb deleted the gcvisitobjs branch May 1, 2023 22:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-102013: Add PyUnstable_GC_VisitObjects #102014

gh-102013: Add PyUnstable_GC_VisitObjects #102014

jbower-fb commented Feb 18, 2023 •

edited by bedevere-bot

Loading

cpython-cla-bot bot commented Feb 18, 2023 •

edited

Loading

bedevere-bot commented Feb 18, 2023

jbower-fb commented Feb 24, 2023

jbower-fb commented Mar 8, 2023

encukou left a comment

encukou Mar 8, 2023

jbower-fb Mar 11, 2023

encukou Mar 21, 2023

pablogsal commented Mar 8, 2023

pablogsal left a comment

gh-102013: Add PyUnstable_GC_VisitObjects #102014

gh-102013: Add PyUnstable_GC_VisitObjects #102014

Conversation

jbower-fb commented Feb 18, 2023 • edited by bedevere-bot Loading

cpython-cla-bot bot commented Feb 18, 2023 • edited Loading

bedevere-bot commented Feb 18, 2023

jbower-fb commented Feb 24, 2023

jbower-fb commented Mar 8, 2023

encukou left a comment

Choose a reason for hiding this comment

encukou Mar 8, 2023

Choose a reason for hiding this comment

jbower-fb Mar 11, 2023

Choose a reason for hiding this comment

encukou Mar 21, 2023

Choose a reason for hiding this comment

pablogsal commented Mar 8, 2023

pablogsal left a comment

Choose a reason for hiding this comment

jbower-fb commented Feb 18, 2023 •

edited by bedevere-bot

Loading

cpython-cla-bot bot commented Feb 18, 2023 •

edited

Loading