gh-122040: Reword `Modules/xxmodule.c` module-level comment #132201

sonnyding1 · 2025-04-07T06:51:16Z

Fixes #122040. As per the discussion in the issue, I have modified some comments that might cause confusion.

Issue: Misleading comment in Modules/xxmodule.c #122040

python-cla-bot · 2025-04-07T06:51:20Z

All commit authors signed the Contributor License Agreement.

bedevere-app · 2025-04-07T06:51:20Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Modules/xxmodule.c

Co-authored-by: Bénédikt Tran <[email protected]>

picnixz · 2025-04-07T07:45:55Z

Thank you for the fix!

miss-islington-app · 2025-04-07T08:03:06Z

Thanks @sonnyding1 for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…thonGH-132201) (cherry picked from commit af8d1b9) Co-authored-by: Sonny Ding <[email protected]>

bedevere-app · 2025-04-07T08:03:19Z

GH-132207 is a backport of this pull request to the 3.13 branch.

bedevere-app · 2025-04-07T08:03:23Z

GH-132208 is a backport of this pull request to the 3.12 branch.

…H-132201) (#132208) gh-122040: reword `Modules/xxmodule.c` module-level comment (GH-132201) (cherry picked from commit af8d1b9) Co-authored-by: Sonny Ding <[email protected]>

…H-132201) (#132207) gh-122040: reword `Modules/xxmodule.c` module-level comment (GH-132201) (cherry picked from commit af8d1b9) Co-authored-by: Sonny Ding <[email protected]>

bedevere-bot · 2025-04-07T13:24:39Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable Refleaks 3.13 (tier-2) has failed when building commit 71b5375.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1512/builds/484) and take a look at the build logs.
Check if the failure is related to this commit (71b5375) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1512/builds/484

Failed tests:

test_perf_profiler

Failed subtests:

test_python_calls_appear_in_the_stack_if_perf_activated - test.test_perf_profiler.TestPerfProfilerWithDwarf.test_python_calls_appear_in_the_stack_if_perf_activated

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/Lib/test/test_perf_profiler.py", line 356, in test_python_calls_appear_in_the_stack_if_perf_activated
    self.assertIn(f"py::foo:{script}", stdout)
    ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 'py::foo:/tmp/test_python_4l2tugj7/tmpeoyng3v9/perftest.py' not found in 'python 2102378 1187857.397505:          1 cycles:Pu: \n\t    ffff89068ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 2102378 1187857.397532:          1 cycles:Pu: \n\tffffaa282d37fc78 [unknown] ([unknown])\n\tffffaa282d38049c [unknown] ([unknown])\n\tffffaa282bf215e4 [unknown] ([unknown])\n\t    ffff89068ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 2102378 1187857.398077:          1 cycles:Pu: \n\tffffaa282d37fc78 [unknown] ([unknown])\n\tffffaa282d38049c [unknown] ([unknown])\n\tffffaa282bf215e4 [unknown] ([unknown])\n\t    ffff88e5e300 __pthread_tunables_init+0x0 (/usr/lib64/libc.so.6)\n\t    ffff88f18dcb __libc_early_init+0xcb (/usr/lib64/libc.so.6)\n\t    ffff89066523 dl_main+0x1723 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff890635ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff89064b17 _dl_start_final+0x5ab (inlined)\n\t    ffff89064b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff89068ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 2102378 1187857.398101:        346 cycles:Pu: \n\t    ffff88e5e304 __pthread_tunables_init+0x4 (/usr/lib64/libc.so.6)\n\t    ffff88f18dcb __libc_early_init+0xcb (/usr/lib64/libc.so.6)\n\t    ffff89066523 dl_main+0x1723 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff890635ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff89064b17 _dl_start_final+0x5ab (inlined)\n\t    ffff89064b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff89068ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 2102378 1187857.399093:       1104 cycles:Pu: \n\t          50bba8 _PyMem_DebugRawAlloc+0x0 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          50bcb7 _PyMem_DebugRawMalloc+0x17 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          52230f PyMem_RawMalloc+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          62f30f _Py_hashtable_set+0x33 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          55cf2b intern_static+0x83 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          5764fb _PyUnicode_InternStatic+0x27 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          576daf _PyUnicode_InitStaticStrings+0x857 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          58e377 init_global_interned_strings+0x77 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          58e5bf _PyUnicode_InitGlobalObjects+0x63 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65315f pycore_init_global_objects+0x23 (/hom
@GLIBC_2.34+0x9b (/usr/lib64/libc.so.6)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\npython 2102378 1187857.399139:      52469 cycles:Pu: \n\t          55bb20 unicode_hash+0x18 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          55bbe3 hashtable_unicode_hash+0xb (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          62ef7f _Py_hashtable_get_entry_generic+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          62f2ff _Py_hashtable_set+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          55cf2b intern_static+0x83 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          5764fb _PyUnicode_InternStatic+0x27 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          577acf _PyUnicode_InitStaticStrings+0x1577 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          58e377 init_global_interned_strings+0x77 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          58e5bf _PyUnicode_InitGlobalObjects+0x63 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65315f pycore_init_global_objects+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          653707 pycore_interp_init+0x2b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          6539e3 pyinit_config+0xaf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65b05b pyinit_core+0xdb (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65b133 Py_InitializeFromConfig+0x97 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b2ef pymain_init+0xff (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b3b3 pymain_main+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b447 Py_BytesMain+0x27 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          41ddb7 main+0xb (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t    ffff88df625b __libc_start_call_main+0x7b (/usr/lib64/libc.so.6)\n\t    ffff88df633b __libc_start_main@@GLIBC_2.34+0x9b (/usr/lib64/libc.so.6)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\npython 2102378 1187857.400150:     112691 cycles:Pu: \n\t          4ecaf4 dictkeys_get_index+0x14 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4ecc17 do_lookup+0xbb (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4eccb3 unicodekeys_lookup_unicode+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4f1fbb _Py_dict_lookup+0x3b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4f547b dict_setdefault_ref_lock_held+0x22b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4f570b PyDict_SetDefaultRef+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53a1d7 type_add_method+0x63 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53a31f type_add_methods+0x2b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53a887 type_ready_fill_dict+0x1f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          5476d3 type_ready+0x93 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aa


Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/Lib/test/test_perf_profiler.py", line 356, in test_python_calls_appear_in_the_stack_if_perf_activated
    self.assertIn(f"py::foo:{script}", stdout)
    ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 'py::foo:/tmp/test_python_mzxw497j/tmpuj2doz_0/perftest.py' not found in 'python 1979064 1186821.852684:          1 cycles:Pu: \n\t    ffff93cc1ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 1979064 1186821.852707:          1 cycles:Pu: \n\tffffaa282d37fc78 [unknown] ([unknown])\n\tffffaa282d38049c [unknown] ([unknown])\n\tffffaa282bf215e4 [unknown] ([unknown])\n\t    ffff93cc1ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 1979064 1186821.853071:          1 cycles:Pu: \n\t    ffff93cad058 _dl_map_segments+0x378 (inlined)\n\t    ffff93cad058 _dl_map_object_from_fd+0x378 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cae133 _dl_map_object+0x1e7 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca95bf openaux+0x3f (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca8303 _dl_catch_exception+0x63 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca9b33 _dl_map_object_deps+0x553 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cbf19f dl_main+0x139f (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cbc5ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cbdb17 _dl_start_final+0x5ab (inlined)\n\t    ffff93cbdb17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cc1ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython 1979064 1186821.853108:        352 cycles:Pu: \n\tffffaa282d37f654 [unknown] ([unknown])\n\tffffaa282d380484 [unknown] ([unknown])\n\tffffaa282bf215e4 [unknown] ([unknown])\n\t    ffff93cc4c9c __memset_generic+0x9c (inlined)\n\t    ffff93cad0db _dl_map_segments+0x3fb (inlined)\n\t    ffff93cad0db _dl_map_object_from_fd+0x3fb (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93cae133 _dl_map_object+0x1e7 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca95bf openaux+0x3f (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca8303 _dl_catch_exception+0x63 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff93ca9b33 _dl_map_object_deps+0x553 (/usr/lib/ld-linux-aarc

…thon#132201)

docs: update xxmodule.c comments on header file

8bc980f

bedevere-app bot added the awaiting review label Apr 7, 2025

bedevere-app bot mentioned this pull request Apr 7, 2025

Misleading comment in Modules/xxmodule.c #122040

Closed

picnixz reviewed Apr 7, 2025

View reviewed changes

Modules/xxmodule.c Outdated Show resolved Hide resolved

picnixz added skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Apr 7, 2025

Update Modules/xxmodule.c

f0e4187

Co-authored-by: Bénédikt Tran <[email protected]>

picnixz approved these changes Apr 7, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Apr 7, 2025

picnixz enabled auto-merge (squash) April 7, 2025 07:45

picnixz disabled auto-merge April 7, 2025 07:46

picnixz enabled auto-merge (squash) April 7, 2025 07:47

picnixz changed the title ~~gh-122040: Fix xxmodule.c comment on header~~ gh-122040: Reword Modules/xxmodule.c module-level comment Apr 7, 2025

picnixz merged commit af8d1b9 into python:main Apr 7, 2025
44 checks passed

bedevere-app bot removed the awaiting merge label Apr 7, 2025

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 7, 2025

pythongh-122040: reword Modules/xxmodule.c module-level comment (py…

4b90aaf

…thonGH-132201) (cherry picked from commit af8d1b9) Co-authored-by: Sonny Ding <[email protected]>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 7, 2025

pythongh-122040: reword Modules/xxmodule.c module-level comment (py…

eb1fb2a

…thonGH-132201) (cherry picked from commit af8d1b9) Co-authored-by: Sonny Ding <[email protected]>

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 7, 2025

bedevere-app bot removed the needs backport to 3.12 only security fixes label Apr 7, 2025

sonnyding1 deleted the xxmodule-comment branch April 8, 2025 01:58

seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025

pythongh-122040: reword Modules/xxmodule.c module-level comment (py…

ad32070

…thon#132201)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

gh-122040: Reword `Modules/xxmodule.c` module-level comment #132201

gh-122040: Reword `Modules/xxmodule.c` module-level comment #132201

Uh oh!

sonnyding1 commented Apr 7, 2025 •

edited by bedevere-app bot

Loading

Uh oh!

python-cla-bot bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

Uh oh!

picnixz commented Apr 7, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Apr 7, 2025

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

bedevere-bot commented Apr 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

gh-122040: Reword Modules/xxmodule.c module-level comment #132201

gh-122040: Reword Modules/xxmodule.c module-level comment #132201

Uh oh!

Conversation

sonnyding1 commented Apr 7, 2025 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

python-cla-bot bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

Uh oh!

picnixz commented Apr 7, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Apr 7, 2025

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

bedevere-app bot commented Apr 7, 2025

Uh oh!

bedevere-bot commented Apr 7, 2025

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gh-122040: Reword `Modules/xxmodule.c` module-level comment #132201

gh-122040: Reword `Modules/xxmodule.c` module-level comment #132201

sonnyding1 commented Apr 7, 2025 •

edited by bedevere-app bot

Loading

python-cla-bot bot commented Apr 7, 2025 •

edited

Loading