aio-libs / multidict / 36185656249

87%

push

github

Name slot-only C functions after the slot they fill (#1594)

<!-- Thank you for your contribution! -->

## What do these changes do?

Renames every C extension function that is used only as a type slot
after the slot it fills: `<type>_tp_<slot>`, `<type>_nb_<slot>`,
`<type>_sq_<slot>` or `<type>_mp_<slot>`, the scheme `multidict_tp_iter`
and `multidict_sq_contains` already follow. For example `multidict_repr`
became `multidict_tp_repr`, `multidict_view_len` became
`multidict_view_sq_length`, `multidict_itemsview_sub` became
`multidict_itemsview_nb_subtract`, and `md_traverse` became
`multidict_tp_traverse`. `multidict_mp_len` and
`multidict_mp_as_subscript` now match their slot fields (`mp_length`,
`mp_ass_subscript`).

Functions that are also called directly keep their names: `istr_new`,
`md_clear`, `multidict_view_richcompare` and the two `*view_xor`
functions.

Pure rename; C extension only, the pure-Python backend has no
counterpart.

## Are there changes in behavior for the user?

No.

## Is it a substantial burden for the maintainers to support this?

No; it makes the slot functions greppable by slot name.

## Related issue number

N/A

## Checklist

- [x] I think the code is well written
- [ ] Unit tests for the changes exist (N/A, rename only; existing suite
covers it)
- [x] Documentation reflects the changes (N/A)
- [ ] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt` (N/A)
- [x] Add a new news fragment into the `CHANGES/` folder
- [x] `make doc-spelling` passes and any new technical words are added
to `docs/spelling_wordlist.txt`

<details>
<summary>Agent run details (optional, for reviewers)</summary>

Tests: C extension on 3.13.2 and 3.10.17, 2765 passed, 170 skipped each;
pure Python (`MULTIDICT_NO_EXTENSIONS=1 ... --no-c-extensions`, separate
tree and venv) 1301 passed, 17 skipped.

Codegen: `tools/codegen_diff.py --ref upstream/master` on 3.13.2 and
3.14.7t. Every removed symbol maps one to one onto a renamed ... (continued)

780 of 1560 branches covered (50.0%)

Branch coverage included in aggregate %.

8164 of 8710 relevant lines covered (93.73%)

1.87 hits per line