mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.13] GH-121970: Rewrite the C-API annotations extension (#121985) (#122027)

Browse source 
GH-121970: Rewrite the C-API annotations extension (#121985)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit 22c9d9c1fc)
This commit is contained in:
Adam Turner 2024-07-19 14:03:52 +01:00 • committed by GitHub
parent 1565093374
commit c12f81ed82
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 1157 additions and 1068 deletions
Download patch file Download diff file Expand all files Collapse all files

23
Tools/build/stable_abi.py
View file

@ -225,9 +225,9 @@ def gen_python3dll(manifest, args, outfile):
key=sort_key):
write(f'EXPORT_DATA({item.name})')
REST_ROLES = {
'function': 'function',
'data': 'var',
ITEM_KIND_TO_DOC_ROLE = {
'function': 'func',
'data': 'data',
'struct': 'type',
'macro': 'macro',
# 'const': 'const', # all undocumented
@ -236,22 +236,28 @@ REST_ROLES = {
@generator("doc_list", 'Doc/data/stable_abi.dat')
def gen_doc_annotations(manifest, args, outfile):
"""Generate/check the stable ABI list for documentation annotations"""
"""Generate/check the stable ABI list for documentation annotations
See ``StableABIEntry`` in ``Doc/tools/extensions/c_annotations.py``
for a description of each field.
"""
writer = csv.DictWriter(
outfile,
['role', 'name', 'added', 'ifdef_note', 'struct_abi_kind'],
lineterminator='\n')
writer.writeheader()
for item in manifest.select(REST_ROLES.keys(), include_abi_only=False):
kinds = set(ITEM_KIND_TO_DOC_ROLE)
for item in manifest.select(kinds, include_abi_only=False):
if item.ifdef:
ifdef_note = manifest.contents[item.ifdef].doc
else:
ifdef_note = None
row = {
'role': REST_ROLES[item.kind],
'role': ITEM_KIND_TO_DOC_ROLE[item.kind],
'name': item.name,
'added': item.added,
'ifdef_note': ifdef_note}
'ifdef_note': ifdef_note,
}
rows = [row]
if item.kind == 'struct':
row['struct_abi_kind'] = item.struct_abi_kind
@ -259,7 +265,8 @@ def gen_doc_annotations(manifest, args, outfile):
rows.append({
'role': 'member',
'name': f'{item.name}.{member_name}',
'added': item.added})
'added': item.added,
})
writer.writerows(rows)
@generator("ctypes_test", 'Lib/test/test_stable_abi_ctypes.py')