Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docs: Add classes to C API return value annotations #117926

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.

Sign up for GitHub

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 5 commits into from
Apr 16, 2024
Merged

Docs: Add classes to C API return value annotations #117926

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
111795c
Add classes to C API return value annotations
hugovk Apr 16, 2024
48884bb
Cleanup: remove duplicate key and sort; remove unused variable; white…
hugovk Apr 16, 2024
1aa606c
Cleanup: remove redundant encoding and default open mode
hugovk Apr 16, 2024
7d0ac69
Use f-string
hugovk Apr 16, 2024
f923cc3
Explicitly specify encoding='utf8'
hugovk Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions Doc/tools/extensions/c_annotations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
c_annotations.py
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -34,11 +33,10 @@

REST_ROLE_MAP = {
'function': 'func',
'var': 'data',
'type': 'type',
'macro': 'macro',
'type': 'type',
'member': 'member',
'type': 'type',
'var': 'data',
}


Expand All @@ -63,15 +61,15 @@ def __init__(self, name):
class Annotations:
def __init__(self, refcount_filename, stable_abi_file):
self.refcount_data = {}
with open(refcount_filename, 'r') as fp:
with open(refcount_filename, encoding='utf8') as fp:
for line in fp:
line = line.strip()
if line[:1] in ("", "#"):
# blank lines and comments
continue
parts = line.split(":", 4)
if len(parts) != 5:
raise ValueError("Wrong field count in %r" % line)
raise ValueError(f"Wrong field count in {line!r}")
function, type, arg, refcount, comment = parts
# Get the entry, creating it if needed:
try:
Expand All @@ -91,9 +89,8 @@ def __init__(self, refcount_filename, stable_abi_file):
entry.result_refs = refcount

self.stable_abi_data = {}
with open(stable_abi_file, 'r') as fp:
with open(stable_abi_file, encoding='utf8') as fp:
for record in csv.DictReader(fp):
role = record['role']
name = record['name']
self.stable_abi_data[name] = record

Expand Down Expand Up @@ -180,13 +177,17 @@ def add_annotations(self, app, doctree):
continue
elif not entry.result_type.endswith("Object*"):
continue
classes = ['refcount']
if entry.result_refs is None:
rc = sphinx_gettext('Return value: Always NULL.')
classes.append('return_null')
elif entry.result_refs:
rc = sphinx_gettext('Return value: New reference.')
classes.append('return_new_ref')
else:
rc = sphinx_gettext('Return value: Borrowed reference.')
node.insert(0, nodes.emphasis(rc, rc, classes=['refcount']))
classes.append('return_borrowed_ref')
node.insert(0, nodes.emphasis(rc, rc, classes=classes))


def init_annotations(app):
Expand Down Expand Up @@ -228,6 +229,7 @@ def setup(app):
'stableabi': directives.flag,
}
old_handle_signature = CObject.handle_signature

def new_handle_signature(self, sig, signode):
signode.parent['stableabi'] = 'stableabi' in self.options
return old_handle_signature(self, sig, signode)
Expand Down
Loading