Skip to content

bpo-32381: Rewrite PyErr_ProgramText() #23700

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
vstinner merged 2 commits into from
Dec 8, 2020
Merged

bpo-32381: Rewrite PyErr_ProgramText() #23700

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
549de09
bpo-32381: Rewrite PyErr_ProgramText()
vstinner Dec 8, 2020
aae7721
Clear PyUnicode_DecodeFSDefault() error
vstinner Dec 8, 2020
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
15 changes: 10 additions & 5 deletions Python/errors.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1697,13 +1697,18 @@ err_programtext(PyThreadState *tstate, FILE *fp, int lineno)
PyObject *
PyErr_ProgramText(const char *filename, int lineno)
{
FILE *fp;
if (filename == NULL || *filename == '\0' || lineno <= 0) {
if (filename == NULL) {
return NULL;
}
PyThreadState *tstate = _PyThreadState_GET();
fp = _Py_fopen(filename, "r" PY_STDIOTEXTMODE);
return err_programtext(tstate, fp, lineno);

PyObject *filename_obj = PyUnicode_DecodeFSDefault(filename);
if (filename_obj == NULL) {
PyErr_Clear();
return NULL;

@izbyshev izbyshev Dec 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are you sure that the contract of this function allows raising an exception? It seems that PyErr_ProgramTextObject takes care to clear the exception, as does err_programtext.

@vstinner vstinner Dec 8, 2020

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.

I don't know. In case of doubt, I added a PyErr_Clear() call.

My first intent was to deprecate the function. IMO it was exposed by mistake in the stable ABI. But since PyErr_ProgramTextObject() is still needed, I prefer to rewrite PyErr_ProgramText() with PyErr_ProgramTextObject().

@izbyshev izbyshev Dec 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks. Better safe than sorry :)

}
PyObject *res = PyErr_ProgramTextObject(filename_obj, lineno);
Py_DECREF(filename_obj);
return res;
}

PyObject *
Expand Down