Skip to content

bpo-26868: Fix example usage of PyModule_AddObject. #15725

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
matrixise merged 7 commits into from
Sep 12, 2019
Merged

bpo-26868: Fix example usage of PyModule_AddObject. #15725

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
90ae263
Add a note to the PyModule_AddObject docs.
brandtbucher Sep 7, 2019
4b08887
Correct example usages of PyModule_AddObject.
brandtbucher Sep 7, 2019
aef02b8
Whitespace.
brandtbucher Sep 7, 2019
474a266
Clean up wording.
brandtbucher Sep 7, 2019
a005823
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 7, 2019
bb345d9
First code review.
brandtbucher Sep 9, 2019
37b6b37
Add < 0 in the tests with PyModule_AddObject
matrixise Sep 12, 2019
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
Prev Previous commit
Next Next commit
First code review.
  • Loading branch information
@brandtbucher
brandtbucher committed Sep 9, 2019
commit bb345d994148c7626ad19dd045045ce1469882b0
6 changes: 3 additions & 3 deletions Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,18 +417,18 @@ state:

Add an object to *module* as *name*. This is a convenience function which can
be used from the module's initialization function. This steals a reference to
*value*. Return ``-1`` on error, ``0`` on success.
*value* on success. Return ``-1`` on error, ``0`` on success.

.. note::

Unlike other functions that steal references, ``PyModule_AddObject`` only
Unlike other functions that steal references, ``PyModule_AddObject()`` only
decrements the reference count of *value* **on success**.

This means that its return value must be checked, and calling code must
:c:func:`Py_DECREF` *value* manually on error. Example usage::

Py_INCREF(spam);
if (PyModule_AddObject(module, "spam", spam)) {
if (PyModule_AddObject(module, "spam", spam) < 0) {
Py_DECREF(module);
Py_DECREF(spam);
return NULL;
Expand Down
14 changes: 5 additions & 9 deletions Doc/extending/extending.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ usually declare a static object variable at the beginning of your file::
static PyObject *SpamError;

and initialize it in your module's initialization function (:c:func:`PyInit_spam`)
with an exception object (leaving out the error checking for now)::
with an exception object::

PyMODINIT_FUNC
PyInit_spam(void)
Expand All @@ -221,9 +221,10 @@ with an exception object (leaving out the error checking for now)::
return NULL;

SpamError = PyErr_NewException("spam.error", NULL, NULL);
Py_INCREF(SpamError);
Py_XINCREF(SpamError);
if (PyModule_AddObject(m, "error", SpamError)) {

@serhiy-storchaka serhiy-storchaka Sep 10, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to add also < 0 in all other checks for PyModule_AddObject() result.

@brandtbucher brandtbucher Sep 10, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an agreed-upon style? I had always thought it was a matter of taste.

In either case, I guess all of these files should at least be consistent...

@matrixise matrixise Sep 11, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the extra test with < 0

Py_DECREF(SpamError);
Py_XDECREF(SpamError);
Py_CLEAR(SpamError);
Py_DECREF(m);
return NULL;
}
Expand Down Expand Up @@ -1266,13 +1267,8 @@ function must take care of initializing the C API pointer array::
/* Create a Capsule containing the API pointer array's address */
c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);

if (c_api_object == NULL) {
Py_DECREF(m);
return NULL;
}

if (PyModule_AddObject(m, "_C_API", c_api_object)) {

@matrixise matrixise Sep 12, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto, change the example with if (PyModule_AddObject(m, "_C_API", c_api_object) < 0)

Py_DECREF(c_api_object);
Py_XDECREF(c_api_object);
Py_DECREF(m);
return NULL;
}
Expand Down
2 changes: 1 addition & 1 deletion Doc/includes/sublist.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ PyInit_sublist(void)
return NULL;

Py_INCREF(&SubListType);
if ((m, "SubList", (PyObject *) &SubListType)) {
if (PyModule_AddObject(m, "SubList", (PyObject *) &SubListType)) {

@matrixise matrixise Sep 12, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Py_DECREF(&SubListType);
Py_DECREF(m);
return NULL;
Expand Down