Skip to content
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

Jump to bottom

gh-103743: Add PyUnstable_Object_GC_NewWithExtraData #103744

Merged
merged 9 commits into from
May 2, 2023
Merged

gh-103743: Add PyUnstable_Object_GC_NewWithExtraData #103744

merged 9 commits into from
May 2, 2023

Conversation

jbradaric
Copy link
Contributor

@jbradaric jbradaric commented Apr 24, 2023 •
edited by bedevere-bot
Loading

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

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

@bedevere-bot bedevere-bot mentioned this pull request Apr 24, 2023
Closed
@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Apr 24, 2023 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@jbradaric jbradaric force-pushed the jbradaric/obj-new-with-extra-data branch from d045f45 to d300004 Compare April 24, 2023 08:32
Eclips4
Eclips4 reviewed Apr 24, 2023
View reviewed changes
Doc/c-api/gcsupport.rst Outdated Show resolved Hide resolved
@jbradaric jbradaric force-pushed the jbradaric/obj-new-with-extra-data branch 3 times, most recently from aa3716f to cc46476 Compare April 24, 2023 10:01
@jbradaric jbradaric force-pushed the jbradaric/obj-new-with-extra-data branch from cc46476 to d644206 Compare April 24, 2023 10:53
@jbradaric jbradaric marked this pull request as ready for review April 24, 2023 11:20
@jbradaric jbradaric changed the title [WIP] gh-103743: Add PyUnstable_Object_GC_NewWithExtraData gh-103743: Add PyUnstable_Object_GC_NewWithExtraData Apr 24, 2023
@encukou encukou self-requested a review April 27, 2023 16:08
@encukou
Clarify the docs a bit
f9817ca
@encukou
Convert the test class to a heap type
f0098d6
@encukou
Initialize the memory
cfa59d7 
This is a further workaround: this time for the fact that
we can't rely on tp_alloc, which zeroes the memory (including
memory for subclasses, like slots in the test) for normal classes.

For the test type, this means the instances aren't initialized twice
(once in PyUnstable_Object_GC_NewWithExtraData, once again with
PyObject_Init after zeroing). Initializing twice throws off the global
refcount total in debug builds.
@encukou
Copy link
Member

encukou commented Apr 28, 2023

Hi,
Time for 3.12 is short, so rather than write review comments I pushed suggestions/fixes to the PR directly. @jbradaric, could you go through the commits (and commit descriptions)? Do they make sense to you?

One more thing to do will be moving GC- or allocation-related tests from _testcapimodule.c to their own file in Modules/_testcapi/, but that can wait for another PR.

@jbradaric
Copy link
Contributor Author

@encukou, commits look good, thanks for the review and fixes. Sorry for the amount of required changes :)

@jbradaric
Copy link
Contributor Author

One more thing to do will be moving GC- or allocation-related tests from _testcapimodule.c to their own file in Modules/_testcapi/, but that can wait for another PR.

Would it be OK if I create a PR to move these tests to a separate file? Or is someone already working on this?

erlend-aasland
erlend-aasland reviewed Apr 28, 2023
View reviewed changes
Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Minor nits regarding docs.

Doc/c-api/gcsupport.rst Outdated Show resolved Hide resolved
Doc/c-api/gcsupport.rst Outdated Show resolved Hide resolved
Misc/NEWS.d/next/C API/2023-04-24-10-31-59.gh-issue-103743.2xYA1K.rst Outdated Show resolved Hide resolved
@jbradaric @erlend-aasland
Doc style fixes
525705a 
Fix indentation and reword some parts to sound more natural.

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
@encukou encukou merged commit 87223f3 into python:main May 2, 2023
@encukou
Copy link
Member

encukou commented May 2, 2023

Thank you for your first contribution to CPython! (It is first, right?)

Sorry for the amount of required changes

No problem!

Would it be OK if I create a PR to move these tests to a separate file? Or is someone already working on this?

Go ahead! The issue is #93649 and it has a bunch of example PRs.
I don't think anyone's working on this.

@jbradaric
Copy link
Contributor Author

Thank you for your first contribution to CPython! (It is first, right?)

Yes, it's the first one. Thanks for all the help :)

@jbradaric jbradaric deleted the jbradaric/obj-new-with-extra-data branch May 2, 2023 12:01
carljm added a commit to carljm/cpython that referenced this pull request May 2, 2023
@carljm
Merge branch 'main' into inlinecomp2
0727d6f 
* main:
  pythongh-103822: [Calendar] change return value to enum for day and month APIs (pythonGH-103827)
  pythongh-65022: Fix description of tuple return value in copyreg (python#103892)
  pythonGH-103525: Improve exception message from `pathlib.PurePath()` (pythonGH-103526)
  pythongh-84436: Add integration C API tests for immortal objects (pythongh-103962)
  pythongh-103743: Add PyUnstable_Object_GC_NewWithExtraData (pythonGH-103744)
  pythongh-102997: Update Windows installer to SQLite 3.41.2. (python#102999)
  pythonGH-103484: Fix redirected permanently URLs (python#104001)
  Improve assert_type phrasing (python#104081)
  pythongh-102997: Update macOS installer to SQLite 3.41.2. (pythonGH-102998)
  pythonGH-103472: close response in HTTPConnection._tunnel (python#103473)
  pythongh-88496: IDLE - fix another test on macOS (python#104075)
  pythongh-94673: Hide Objects in PyTypeObject Behind Accessors (pythongh-104074)
  pythongh-94673: Properly Initialize and Finalize Static Builtin Types for Each Interpreter (pythongh-104072)
  pythongh-104016: Skip test for deeply neste f-strings on wasi (python#104071)
carljm added a commit to carljm/cpython that referenced this pull request May 2, 2023
@carljm
Merge branch 'main' into cached_property_docs
b9c39e3 
* main: (760 commits)
  pythonGH-104102: Optimize `pathlib.Path.glob()` handling of `../` pattern segments (pythonGH-104103)
  pythonGH-104104: Optimize `pathlib.Path.glob()` by avoiding repeated calls to `os.path.normcase()` (pythonGH-104105)
  pythongh-103822: [Calendar] change return value to enum for day and month APIs (pythonGH-103827)
  pythongh-65022: Fix description of tuple return value in copyreg (python#103892)
  pythonGH-103525: Improve exception message from `pathlib.PurePath()` (pythonGH-103526)
  pythongh-84436: Add integration C API tests for immortal objects (pythongh-103962)
  pythongh-103743: Add PyUnstable_Object_GC_NewWithExtraData (pythonGH-103744)
  pythongh-102997: Update Windows installer to SQLite 3.41.2. (python#102999)
  pythonGH-103484: Fix redirected permanently URLs (python#104001)
  Improve assert_type phrasing (python#104081)
  pythongh-102997: Update macOS installer to SQLite 3.41.2. (pythonGH-102998)
  pythonGH-103472: close response in HTTPConnection._tunnel (python#103473)
  pythongh-88496: IDLE - fix another test on macOS (python#104075)
  pythongh-94673: Hide Objects in PyTypeObject Behind Accessors (pythongh-104074)
  pythongh-94673: Properly Initialize and Finalize Static Builtin Types for Each Interpreter (pythongh-104072)
  pythongh-104016: Skip test for deeply neste f-strings on wasi (python#104071)
  pythongh-104057: Fix direct invocation of test_super (python#104064)
  pythongh-87092: Expose assembler to unit tests (python#103988)
  pythongh-97696: asyncio eager tasks factory (python#102853)
  pythongh-84436: Immortalize in _PyStructSequence_InitBuiltinWithFlags() (pythongh-104054)
  ...
@brandtbucher
Copy link
Member

FYI, it looks like this USan buildbot started failing on this commit: https://buildbot.python.org/all/#/builders/719

Not sure if it's a false positive or not, but is probably worth looking into (especially since the 3.12 release is coming up).

@brandtbucher
Copy link
Member

Fixed in #104191.

@jbradaric jbradaric mentioned this pull request May 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Eclips4 Eclips4 Eclips4 left review comments

@erlend-aasland erlend-aasland erlend-aasland approved these changes

@pablogsal pablogsal Awaiting requested review from pablogsal pablogsal is a code owner

@encukou encukou Awaiting requested review from encukou

Assignees
No one assigned
Labels
topic-C-API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@jbradaric @bedevere-bot @encukou @brandtbucher @erlend-aasland @Eclips4 @arhadthedev @ambv