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
Correct example usages of PyModule_AddObject.
  • Loading branch information
@brandtbucher
brandtbucher committed Sep 7, 2019
commit 4b08887dac35a9afaf135de2f55d845547be1e7f
19 changes: 16 additions & 3 deletions Doc/extending/extending.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,11 @@ with an exception object (leaving out the error checking for now)::

SpamError = PyErr_NewException("spam.error", NULL, NULL);
Py_INCREF(SpamError);
Comment thread
brandtbucher marked this conversation as resolved.
Outdated
PyModule_AddObject(m, "error", 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);
Comment thread
brandtbucher marked this conversation as resolved.
Outdated
Py_DECREF(m);
return NULL;
}
return m;
}

Expand Down Expand Up @@ -1261,8 +1265,17 @@ 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)
PyModule_AddObject(m, "_C_API", c_api_object);
if (c_api_object == NULL) {
Comment thread
brandtbucher marked this conversation as resolved.
Outdated
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_DECREF(m);
return NULL;
}

return m;
}

Expand Down
14 changes: 12 additions & 2 deletions Doc/extending/newtypes_tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,12 @@ This initializes the :class:`Custom` type, filling in a number of members
to the appropriate default values, including :attr:`ob_type` that we initially
set to *NULL*. ::

PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
Py_INCREF(&CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType)) {

@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(&CustomType);
PY_DECREF(m);
return NULL;
}

This adds the type to the module dictionary. This allows us to create
:class:`Custom` instances by calling the :class:`Custom` class:
Expand Down Expand Up @@ -864,7 +869,12 @@ function::
return NULL;

Py_INCREF(&SubListType);
PyModule_AddObject(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;
}

return m;
}

Expand Down
7 changes: 6 additions & 1 deletion Doc/includes/custom.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ PyInit_custom(void)
return NULL;

Py_INCREF(&CustomType);
PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType)) {

@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(&CustomType);
PY_DECREF(m);
return NULL;
}

return m;
}
7 changes: 6 additions & 1 deletion Doc/includes/custom2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ PyInit_custom2(void)
return NULL;

Py_INCREF(&CustomType);
PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType)) {

@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(&CustomType);
Py_DECREF(m);
return NULL;
}

return m;
}
7 changes: 6 additions & 1 deletion Doc/includes/custom3.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ PyInit_custom3(void)
return NULL;

Py_INCREF(&CustomType);
PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType)) {

@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(&CustomType);
Py_DECREF(m);
return NULL;
}

return m;
}
7 changes: 6 additions & 1 deletion Doc/includes/custom4.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,11 @@ PyInit_custom4(void)
return NULL;

Py_INCREF(&CustomType);
PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType)) {

@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(&CustomType);
Py_DECREF(m);
return NULL;
}

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

Py_INCREF(&SubListType);
PyModule_AddObject(m, "SubList", (PyObject *) &SubListType);
if ((m, "SubList", (PyObject *) &SubListType)) {
Comment thread
brandtbucher marked this conversation as resolved.
Outdated
Py_DECREF(&SubListType);
Py_DECREF(m);
return NULL;
}

return m;
}