cpython/Modules/_testcapi/README.txt

Tests in this directory are compiled into the _testcapi extension.
The main file for the extension is Modules/_testcapimodule.c, which
calls `_PyTestCapi_Init_*` from these functions.

General guideline when writing test code for C API.
* Use Argument Clinic to minimise the amount of boilerplate code.
* Add a newline between the argument spec and the docstring.
* If a test description is needed, make sure the added docstring clearly and succinctly describes purpose of the function.
* DRY, use the clone feature of Argument Clinic.
* Try to avoid adding new interned strings; reuse existing parameter names if possible. Use the `as` feature of Argument Clinic to override the C variable name, if needed.
gh-93649: Split vectorcall testing from _testcapimodule.c (GH-94549) The `_testcapimodule.c` file is getting too large to work with effectively. This PR lays out a general structure of how tests can be split up, with more splitting to come later if the structure is OK. Vectorcall tests aren't the biggest issue -- it's just an area I want to work on next, so I'm starting here. An issue specific to vectorcall tests is that it wasn't clear that e.g. `MethodDescriptor2` is related to testing vectorcall: the `/* Test PEP 590 */` section had an ambiguous end. Separate file should make things like this much clearer. OTOH, for some pieces it might not be clear where they should be -- I left `meth_fastcall` with tests of the other calling conventions. IMO, even with the ambiguity it's still worth it to split the huge file up. I'm not sure about the buildsystem changes, hopefully CI will tell me what's wrong. @vstinner, @markshannon: Do you think this is a good idea? Automerge-Triggered-By: GH:encukou 2022-07-08 12:56:26 -03:00			`Tests in this directory are compiled into the _testcapi extension.`
			`The main file for the extension is Modules/_testcapimodule.c, which`
			calls `_PyTestCapi_Init_*` from these functions.
gh-104469: Update README.txt for _testcapi (gh-104529) * gh-104469: Update README.txt for _testcapi Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru> 2023-05-17 00:56:20 -03:00
			`General guideline when writing test code for C API.`
			`* Use Argument Clinic to minimise the amount of boilerplate code.`
			`* Add a newline between the argument spec and the docstring.`
			`* If a test description is needed, make sure the added docstring clearly and succinctly describes purpose of the function.`
			`* DRY, use the clone feature of Argument Clinic.`
			* Try to avoid adding new interned strings; reuse existing parameter names if possible. Use the `as` feature of Argument Clinic to override the C variable name, if needed.