gh-151941: Doc: fix Sphinx reference warnings in Doc/c-api/

[Aniketsy]

fixes #151941

• Issue: Fix all Sphinx reference warnings in Doc/c-api/ #151941

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #33587363 | 📁 Comparing 5defec5 against main (fcda96f)

  🔍 Preview build  

117 files changed · + 3 added · ± 113 modified · - 1 deleted

+ Added

• library/asyncio-tools.html
• library/tkinter.fontchooser.html
• library/tkinter.systray.html

± Modified

• glossary.html
• py-modindex.html
• c-api/bytes.html
• c-api/dict.html
• c-api/exceptions.html
• c-api/extension-modules.html
• c-api/float.html
• c-api/gen.html
• c-api/import.html
• c-api/init_config.html
• and 103 more...

- Deleted

• library/asyncio-policy.html

[StanFromIreland]

What about the other files. The title says you fix all, maybe you forgot to push a commit?

[Aniketsy]

ahh yes, i missed.. I've update with changes, thanks for pointing out

[Aniketsy]

@StanFromIreland gentle ping, please have a look, when you get chance

[StanFromIreland]

Sorry, I'm not a C-API expert.

[ZeroIntensity]

This looks good to me.

Sorry, I'm not a C-API expert.

Says someone who has written documentation for a good portion of it :)

[miss-islington-app]

Thanks @Aniketsy for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

[miss-islington-app]

Sorry, @Aniketsy and @ZeroIntensity, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b3be16db02e71368774aab62c8ce3f6fb8cc5452 3.14

[bedevere-app]

GH-154920 is a backport of this pull request to the 3.15 branch.

[miss-islington-app]

Sorry, @Aniketsy and @ZeroIntensity, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b3be16db02e71368774aab62c8ce3f6fb8cc5452 3.13

[bedevere-app]

GH-154921 is a backport of this pull request to the 3.14 branch.

[bedevere-app]

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

[bedevere-bot]

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

Hi! The buildbot AMD64 Arch Linux Asan 3.13 (tierless) has failed when building commit 705da2e.

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/1464/builds/1157) and take a look at the build logs.
4. Check if the failure is related to this commit (705da2e) 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/1464/builds/1157

Failed tests:

• test_io

Failed subtests:

• test_daemon_threads_shutdown_stdout_deadlock - test.test_io.CMiscIOTest.test_daemon_threads_shutdown_stdout_deadlock
• test_daemon_threads_shutdown_stderr_deadlock - test.test_io.CMiscIOTest.test_daemon_threads_shutdown_stderr_deadlock

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

==

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4755, in test_daemon_threads_shutdown_stderr_deadlock
    self.check_daemon_threads_shutdown_deadlock('stderr')
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4745, in check_daemon_threads_shutdown_deadlock
    self.assertFalse(err.strip('.!'))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
AssertionError: '=================================================================\n==2027273==ERROR: AddressSanitizer: heap-use-after-free on address 0x7cfed4652a58 at pc 0x55a7fe518886 bp 0x7bced23fe080 sp 0x7bced23fe070\nREAD of size 8 at 0x7cfed4652a58 thread T1\n' is not false


Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4755, in test_daemon_threads_shutdown_stderr_deadlock
    self.check_daemon_threads_shutdown_deadlock('stderr')
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4745, in check_daemon_threads_shutdown_deadlock
    self.assertFalse(err.strip('.!'))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
AssertionError: '=================================================================\n==2039561==ERROR: AddressSanitizer: heap-use-after-free on address 0x7c566e052a58 at pc 0x55d388c54886 bp 0x7b266bdfe080 sp 0x7b266bdfe070\nREAD of size 8 at 0x7c566e052a58 thread T1\n' is not false


Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4750, in test_daemon_threads_shutdown_stdout_deadlock
    self.check_daemon_threads_shutdown_deadlock('stdout')
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4745, in check_daemon_threads_shutdown_deadlock
    self.assertFalse(err.strip('.!'))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
AssertionError: '=================================================================\n==2027275==ERROR: AddressSanitizer: heap-use-after-free on address 0x7cb273c52a58 at pc 0x558fe7ceb886 bp 0x7b82719fe080 sp 0x7b82719fe070\nREAD of size 8 at 0x7cb273c52a58 thread T1\n' is not false

[bedevere-bot]

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

Hi! The buildbot AMD64 Arch Linux Asan 3.13 (tierless) has failed when building commit 705da2e.

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/1464/builds/1158) and take a look at the build logs.
4. Check if the failure is related to this commit (705da2e) 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/1464/builds/1158

Failed tests:

• test_io

Failed subtests:

• test_daemon_threads_shutdown_stdout_deadlock - test.test_io.CMiscIOTest.test_daemon_threads_shutdown_stdout_deadlock

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

==

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4750, in test_daemon_threads_shutdown_stdout_deadlock
    self.check_daemon_threads_shutdown_deadlock('stdout')
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4745, in check_daemon_threads_shutdown_deadlock
    self.assertFalse(err.strip('.!'))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
AssertionError: '=================================================================\n==3300499==ERROR: AddressSanitizer: heap-use-after-free on address 0x7c34d9252a58 at pc 0x55612896a886 bp 0x7b04d6ffe080 sp 0x7b04d6ffe070\nREAD of size 8 at 0x7c34d9252a58 thread T1\n    #0 0x55612896a885 in _Py_atomic_load_uintptr_relaxed Include/cpython/pyatomic_gcc.h:347\n    #1 0x55612896a885 in _Py_eval_breaker_bit_is_set Include/internal/pycore_ceval.h:292\n    #2 0x55612896a885 in drop_gil Python/ceval_gil.c:266\n    #3 0x55612896c7bb in PyEval_SaveThread Python/ceval_gil.c:647\n    #4 0x556128b03754 in _enter_buffered_busy Modules/_io/bufferedio.c:302\n    #5 0x556128b1135f in _io_BufferedWriter_write_impl Modules/_io/bufferedio.c:2078\n    #6 0x556128b1135f in _io_BufferedWriter_write Modules/_io/clinic/bufferedio.c.h:1095\n    #7 0x5561285345e0 in method_vectorcall_O Objects/descrobject.c:475\n    #8 0x55612850c814 in _PyObject_VectorcallTstate Include/internal/pycore_call.h:168\n    #9 0x55612850c814 in PyObject_VectorcallMethod Objects/call.c:857\n    #10 0x556128b1673e in PyObject_CallMethodOneArg Include/cpython/abstract.h:74\n    #11 0x556128b1673e in _textiowrapper_writeflush Modules/_io/textio.c:1631\n    #12 0x556128b1a587 in _io_TextIOWrapper_flush_impl Modules/_io/textio.c:3115\n    #13 0x556128b1a587 in _io_TextIOWrapper_flush Modules/_io/clinic/textio.c.h:1111\n    #14 0x5561288aebce in _PyEval_EvalFrameDefault Python/generated_cases.c.h:1753\n    #15 0x556128513f01 in _PyObject_VectorcallTstate Include/internal/pycore_call.h:168\n    #16 0x556128513f01 in method_vectorcall Objects/classobject.c:71\n    #17 0x55612850effe in _PyVectorcall_Call Objects/call.c:273\n    #18 0x55612850effe in _PyObject_Call Objects/call.c:348\n    #19 0x55612850effe in PyObject_Call Objects/call.c:373\n    #20 0x556128b9638d in thread_run Modules/_threadmodule.c:343\n    #21 0x556128a40c78 in pythread_wrapper Python/thread_pthread.h:242\n    #22 0x7f04da861858  (/usr/lib/libasan.so.8+0x61858) (BuildId: b28f87d70f4aadfdfe6abce3776c226f5569bd6a)\n    #23 0x7f04da497738  (/usr/lib/libc.so.6+0x97738) (BuildId: d8ceb52a8c6e1fefece4ca75f7396d1d5bffc565)\n    #24 0x7f04da51bedb  (/usr/lib/libc.so.6+0x11bedb) (BuildId: d8ceb52a8c6e1fefece4ca75f7396d1d5bffc565)\n\n0x7c34d9252a58 is located 24 bytes inside of 344-byte region [0x7c34d9252a40,0x7c34d9252b98)\nfreed by thread T0 here:\n    #0 0x7f04da92ae91  (/usr/lib/libasan.so.8+0x12ae91) (BuildId: b28f87d70f4aadfdfe6abce3776c226f5569bd6a)\n    #1 0x5561289fe187 in free_threadstate Python/pystate.c:1471\n    #2 0x5561289fe187 in _PyThreadState_DeleteList Python/pystate.c:1941\n    #3 0x5561289f1b32 in _Py_Finalize Python/pylifecycle.c:2092\n    #4 0x556128a7fbf6 in Py_RunMain Modules/main.c:836\n    #5 0x556128a7fbf6 in pymain_main Modules/main.c:864\n    #6 0x556128a7fbf6 in Py_BytesMain Modules/main.c:888\n    #7 0x7f04da427740  (/usr/lib/libc.so.6+0x27740) (BuildId: d8ceb52a8c6e1fefece4ca75f7396d1d5bffc565)\n    #8 0x7f04da427878 in __libc_start_main (/usr/lib/libc.so.6+0x27878) (BuildId: d8ceb52a8c6e1fefece4ca75f7396d1d5bffc565)\n    #9 0x5561283ba454 in _start (/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/python+0x19a454) (BuildId: b3e9e50a59ecbb9316eda8a6cff19f14d429096a)\n\npreviously allocated by thread T0 here:\n    #0 0x7f04da92bea9 in calloc (/usr/lib/libasan.so.8+0x12bea9) (BuildId: b28f87d70f4aadfdfe6abce3776c226f5569bd6a)\n    #1 0x5561289fa9fe in alloc_threadstate Python/pystate.c:1449\n    #2 0x5561289fa9fe in new_threadstate Python/pystate.c:1561\n    #3 0x5561289fa9fe in _PyThreadState_New Python/pystate.c:1630\n    #4 0x556128b97c69 in ThreadHandle_start Modules/_threadmodule.c:411\n    #5 0x556128b97c69 in do_start_new_thread Modules/_threadmodule.c:1857\n    #6 0x556128b98b65 in thread_PyThread_start_joinable_thread Modules/_threadmodule.c:1980\n    #7 0x556128616e34 in cfunction_call Objects/methodobject.c:539\n    #8 0x55612850887f in _PyObject_MakeTpCall Objects/call.c:242\n    #9 0x55612889b77f in _PyEval_EvalFrameDefault Python/generated_cases.c.h:1509\n    


Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4750, in test_daemon_threads_shutdown_stdout_deadlock
    self.check_daemon_threads_shutdown_deadlock('stdout')
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/buildbot/buildarea/3.13.pablogsal-arch-x86_64.asan/build/Lib/test/test_io.py", line 4745, in check_daemon_threads_shutdown_deadlock
    self.assertFalse(err.strip('.!'))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
AssertionError: '=================================================================\n==3312074==ERROR: AddressSanitizer: heap-use-after-free on address 0x7c60b1e52a58 at pc 0x55b1d70b8886 bp 0x7b30afbfe080 sp 0x7b30afbfe070\nREAD of size 8 at 0x7c60b1e52a58 thread T1\n' is not false