Skip to content

GH-121970: Extract pydoc_topics into a new extension #131256

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.

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
merged 3 commits into from
Mar 19, 2025

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Mar 14, 2025

It seems the error was in #130492, the attempted fix. That PR stripped all trailing whitespace, which inadvertantley also removed the final newline, leading to syntax errors, as there were four consecutive quotation marks.

This PR reapplies the reverted commit (#131245), adds a trailing newline, and finally regenerates pydoc_data/topics.py.

A


📚 Documentation preview 📚: https://cpython-previews--131256.org.readthedocs.build/

@AA-Turner AA-Turner requested a review from hugovk as a code owner March 14, 2025 18:20
@AA-Turner AA-Turner added the docs Documentation in the Doc dir label Mar 14, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 14, 2025
@hugovk
Copy link
Member

hugovk commented Mar 14, 2025

Thanks! Do you have a good way to reproduce the original failure in a minimal way?

@AA-Turner
Copy link
Member Author

Thanks! Do you have a good way to reproduce the original failure in a minimal way?

$ git switch -C investigate db62557e3d1b0de4ca17786bd53f9c825ad88721
$ make -CDoc pydoc-topics
$ cp Doc/build/pydoc-topics/topics.py Lib/pydoc_data/topics.py
$ git commit -am "regenerate pydoc-topics"
$ make ci

@AA-Turner
Copy link
Member Author

Ok, let's try again...

A

@AA-Turner AA-Turner merged commit c1a02f9 into python:main Mar 19, 2025
50 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 19, 2025
@hugovk
Copy link
Member

hugovk commented Mar 20, 2025

🤞

And backport?

@AA-Turner AA-Turner added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 20, 2025
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@AA-Turner AA-Turner deleted the docs/reapply-pydoc-topics branch March 20, 2025 15:21
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @AA-Turner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker c1a02f9101f0b2d9dc7cfb4b8be5193e7459a906 3.12

@miss-islington-app
Copy link

Sorry, @AA-Turner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker c1a02f9101f0b2d9dc7cfb4b8be5193e7459a906 3.13

AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Mar 20, 2025
@bedevere-app
Copy link

bedevere-app bot commented Mar 20, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 20, 2025
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Mar 20, 2025
@bedevere-app
Copy link

bedevere-app bot commented Mar 20, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 20, 2025
AA-Turner added a commit that referenced this pull request Mar 20, 2025
AA-Turner added a commit that referenced this pull request Mar 20, 2025
@bedevere-bot
Copy link

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

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

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1512/builds/442) and take a look at the build logs.
  4. Check if the failure is related to this commit (26b04a1) or if it is a false positive.
  5. 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/442

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_ebdxltpv/tmpj8p_uovo/perftest.py' not found in 'python  280388 1350464.892398:          1 cycles:Pu: \n\t    ffffb8374ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  280388 1350464.892423:          1 cycles:Pu: \n\tffffc95efcdffc78 [unknown] ([unknown])\n\tffffc95efce0049c [unknown] ([unknown])\n\tffffc95efb9a15e4 [unknown] ([unknown])\n\t    ffffb8374ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  280388 1350464.893085:          1 cycles:Pu: \n\t    ffffb83660c4 _dl_relocate_object+0x164 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb83723d3 dl_main+0x15d3 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb836f5ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb8370b17 _dl_start_final+0x5ab (inlined)\n\t    ffffb8370b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb8374ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  280388 1350464.893106:        326 cycles:Pu: \n\t    ffffb83660e8 _dl_relocate_object+0x188 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb83723d3 dl_main+0x15d3 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb836f5ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb8370b17 _dl_start_final+0x5ab (inlined)\n\t    ffffb8370b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffffb8374ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  280388 1350464.894114:        907 cycles:Pu: \n\t    ffffb811184c calculate_head_size+0x3ac (inlined)\n\t    ffffb811184c _nl_load_locale_from_archive+0x3ac (/usr/lib64/libc.so.6)\n\t    ffffb8110c7f _nl_find_locale+0xff (/usr/lib64/libc.so.6)\n\t    ffffb811344f setlocale+0x3cf (/usr/lib64/libc.so.6)\n\t          65a94b _Py_SetLocaleFromEnv+0x17 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          651ca7 _PyPreConfig_Read+0x15f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65acef _Py_PreInitializeFromPyArgv+0x103 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b147 pymain_init+0x57 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b2b3 pymain_main+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b347 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    ffffb810625b __libc_start_call_main+0x7b (/usr/lib64/libc.so.6)\n\t    ffffb810633b __libc_start_main@GLIBC_2.17+0x9b (inlined)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\npython  280388 1350464.894199:      48512 cycles:Pu: \n\t    ffffb8112f94 new_composite_name+0x114 (/usr/lib64/libc.so.6)\n\t    ffffb8113497 setlocale+0x417 (/usr/lib64/libc.so.6)\n\t          65a94b _Py_SetLocaleFromEnv+0x17 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          651ca7 _PyPreConfig_Read+0x15f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65acef _Py_PreInitializeFromPyArgv+0x103 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b147 pymain_init+0x57 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b2b3 pymain_main+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b347 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    ffffb810625b __libc_start_call_main+0x7b (/usr/lib64/libc.so.6)\n\t    ffffb810633b __libc_start_main@GLIBC_2.17+0x9b (inlined)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-s


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_bnwz7xj2/tmp8l9nv94j/perftest.py' not found in 'python  322088 1351250.333220:          1 cycles:Pu: \n\t    ffff98f85ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  322088 1351250.333254:          1 cycles:Pu: \n\t    ffff98f85ac0 _start+0x0 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  322088 1351250.334176:          1 cycles:Pu: \n\t    ffff98f86160 _dlfo_process_initial+0x160 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f865ef _dl_find_object_init+0x6f (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f83ff7 dl_main+0x21f7 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f805ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f81b17 _dl_start_final+0x5ab (inlined)\n\t    ffff98f81b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f85ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  322088 1351250.334207:        435 cycles:Pu: \n\t    ffff98f85fc0 _dl_find_object_from_map+0x60 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f860e7 _dlfo_process_initial+0xe7 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f865ef _dl_find_object_init+0x6f (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f83ff7 dl_main+0x21f7 (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f805ff _dl_sysdep_start+0x1df (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f81b17 _dl_start_final+0x5ab (inlined)\n\t    ffff98f81b17 _dl_start+0x5ab (/usr/lib/ld-linux-aarch64.so.1)\n\t    ffff98f85ad3 _start+0x13 (/usr/lib/ld-linux-aarch64.so.1)\n\npython  322088 1351250.335167:        977 cycles:Pu: \n\t          63d0a8 _PyConfig_Copy+0x9c (/home/buildbot/buildarea
ch64.refleak/build/python)\n\t          68b1ef pymain_init+0xff (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b2b3 pymain_main+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b347 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    ffff98d1625b __libc_start_call_main+0x7b (/usr/lib64/libc.so.6)\n\t    ffff98d1633b __libc_start_main@GLIBC_2.17+0x9b (inlined)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\npython  322088 1351250.336195:      81854 cycles:Pu: \n\t          41d368 malloc@plt+0x8 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          50c623 _PyMem_RawMalloc+0x17 (/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\npython  322088 1351250.337443:    1762689 cycles:Pu: \n\t          621f7c _PyObject_GC_Link+0x24 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53d14b _PyType_AllocNoTrack+0x103 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53d187 PyType_GenericAlloc+0x13 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4bb53b descr_new+0x1f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          4bc6a7 PyDescr_NewMember+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53a63b type_add_members+0x37 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          53a88f type_ready_fill_dict+0x2b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          5476cf type_ready+0x93 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          547863 init_static_type+0xab (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          547a43 _PyStaticType_InitBuiltin+0x23 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          507797 _PyTypes_InitTypes+0xa7 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          653133 pycore_init_types+0x1b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65374b pycore_interp_init+0x10b (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          653947 pyinit_config+0xaf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65afbf pyinit_core+0xdb (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          65b097 Py_InitializeFromConfig+0x97 (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b1ef pymain_init+0xff (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b2b3 pymain_main+0xf (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\t          68b347 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    ffff98d1625b __libc_start_call_main+0x7b (/usr/lib64/libc.so.6)\n\t    ffff98d1633b __libc_start_main@GLIBC_2.17+0x9b (inlined)\n\t          41dcaf _start+0x2f (/home/buildbot/buildarea/3.13.cstratak-fedora-stable-aarch64.refleak/build/python)\n\npython  322088 1351250.340253:    4955241 cycles:Pu: \n\t          61f4e8 _PyObject_IS_GC+

seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants