Skip to content

Improve C API guidelines for return values #1129

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

Closed
wants to merge 6 commits into from
Closed

Improve C API guidelines for return values #1129

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba7ce7b
Improve C API guidelines for return values
erlend-aasland Jun 26, 2023
d45cfd1
Commas
erlend-aasland Jun 26, 2023
01335f5
Apply suggestions from code review
erlend-aasland Aug 28, 2023
b045b03
Update developer-workflow/c-api.rst
erlend-aasland Aug 31, 2023
95b5951
Update developer-workflow/c-api.rst
erlend-aasland Sep 6, 2023
8049811
Update developer-workflow/c-api.rst
erlend-aasland Sep 13, 2023
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
8 changes: 5 additions & 3 deletions developer-workflow/c-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,11 @@ Guidelines for expanding/changing the public API
fields, arguments and return values are well defined.

- Functions returning ``PyObject *`` must return a valid pointer on success,
and ``NULL`` with an exception raised on error.
Most other API must return ``-1`` with an exception raised on error,
and ``0`` on success.
and ``NULL`` if and only if an exception is raised.
Other API must return ``0`` on success,
and a negative value if and only if an exception is raised.
``-1`` should be used as the error value;
the caller should use the C idiom ``if (func() < 0)`` to check for errors.

- APIs with lesser and greater results must return ``0`` for the lesser result,
and ``1`` for the greater result.
Expand Down