Skip to content

Document that PyModule_GetDef can return NULL with or without setting an exception #140529

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

Jump to bottom
Merged
merged 1 commit into from
Oct 24, 2025
Merged

Document that PyModule_GetDef can return NULL with or without setting an exception #140529

merged 1 commit into from
Oct 24, 2025

Conversation

@encukou
Copy link
Member

@encukou encukou commented Oct 24, 2025 •
edited by github-actions bot
Loading

See the definition:

cpython/Objects/moduleobject.c

Lines 760 to 768 in 92c0c45

PyModuleDef*
PyModule_GetDef(PyObject* m)
{
if (!PyModule_Check(m)) {
PyErr_BadArgument();
return NULL;
}
return _PyModule_GetDef(m);
}

📚 Documentation preview 📚: https://cpython-previews--140529.org.readthedocs.build/

@encukou encukou added the docs Documentation in the Doc dir label Oct 24, 2025
@encukou encukou added skip issue needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 24, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 24, 2025
StanFromIreland
StanFromIreland approved these changes Oct 24, 2025
View reviewed changes
Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

LGTM

@encukou encukou merged commit 289360a into python:main Oct 24, 2025
50 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Oct 24, 2025
@encukou encukou deleted the module_getdef_errordoc branch October 24, 2025 13:28
@miss-islington-app
Copy link

miss-islington-app bot commented Oct 24, 2025

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 24, 2025
@encukou @miss-islington
Document that PyModule_GetDef can return NULL with or without setting…
59736ff 
… an exception (pythonGH-140529)

(cherry picked from commit 289360a)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 24, 2025
@encukou @miss-islington
Document that PyModule_GetDef can return NULL with or without setting…
431f1d1 
… an exception (pythonGH-140529)

(cherry picked from commit 289360a)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Oct 24, 2025

GH-140545 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Oct 24, 2025
@bedevere-app
Copy link

bedevere-app bot commented Oct 24, 2025

GH-140546 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 24, 2025
encukou added a commit that referenced this pull request Oct 24, 2025
@miss-islington @encukou
[3.14] Document that PyModule_GetDef can return NULL with or without …
a975bea 
…setting an exception (GH-140529) (GH-140545)

(cherry picked from commit 289360a)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit that referenced this pull request Oct 24, 2025
@miss-islington @encukou
[3.13] Document that PyModule_GetDef can return NULL with or without …
5c99b6c 
…setting an exception (GH-140529) (GH-140546)

(cherry picked from commit 289360a)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news topic-C-API

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@encukou @StanFromIreland