NotificationsYou must be signed in to change notification settings
Fork32.4k
Star67.9k

gh-74185: repr() of ImportError now contains attributes name and path#136770

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Draft

Yoav11 wants to merge21 commits intopython:main

base:main

Choose a base branch

fromYoav11:importerror-repr

Draft

gh-74185: repr() of ImportError now contains attributes name and path#136770

Yoav11 wants to merge21 commits intopython:mainfromYoav11:importerror-repr

+116 −6

Conversation

Copy link

Yoav11 commentedJul 19, 2025•
edited
Loading

This PR was created during Europython 2025's spring weekend.

This is a patch on#1011. authored byserhiy-storchaka andarhadthedev

Issue:repr() of ImportError misses keyword arguments name and path #74185

serhiy-storchakaand others added5 commits

July 19, 2025 09:43

bpo-29999: repr() of ImportError now contains attributes name and path.

cb764d9

Use GitHub Actions version of Bedevere

db41c7d

Add the news entry back

1caeb91

Remove an accidentally included untracked file

7f29270

first commit

c80e056

Copy link

python-cla-botbot commentedJul 19, 2025•
edited
Loading

All commit authors signed the Contributor License Agreement.

Copy link

bedevere-appbot commentedJul 19, 2025

Most changes to Pythonrequire a NEWS entry. Add one using theblurb_it web app or theblurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply theskip news label instead.

bedevere-appbot mentioned this pull request

Jul 19, 2025

repr() of ImportError misses keyword arguments name and path#74185

Open

Yoav11 changed the title~~gh-74185: (patch) repr() of ImportError now contains attributes name and path.~~gh-74185: repr() of ImportError now contains attributes name and path. (patch)

Jul 19, 2025

ynir3 added2 commits

July 19, 2025 10:23

add test_ModuleNotFoundError_repr_with_failed_import

126be20

add test_ModuleNotFoundError_repr_with_failed_import

4a97f5c

Copy link

bedevere-appbot commentedJul 19, 2025

Most changes to Pythonrequire a NEWS entry. Add one using theblurb_it web app or theblurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply theskip news label instead.

Copy link

Member

StanFromIreland commentedJul 19, 2025

You need to sign the CLA.

Requesting@encukou who wanted to finish this per#1011 (comment)

StanFromIreland requested review fromencukou andserhiy-storchaka

July 19, 2025 08:28

ynir3 added6 commits

July 19, 2025 10:36

add blurb

852da8c

add noqa:F401

6ab7362

remove whitespace

12c2293

fix trailing-whitespace

a53da37

use ComplexExtendsException

5b6d626

return to non-macro style

951e0a1

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c OutdatedShow resolvedHide resolved

use modern field initializers

8fbfd18

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c Outdated


		if (r&& (exc->name\|\|exc->path)) {
		/* remove ')' */
		Py_SETREF(r,PyUnicode_Substring(r,0,PyUnicode_GET_LENGTH(r)-1));

Copy link

Member

picnixzJul 19, 2025•
edited
Loading

Choose a reason for hiding this comment

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

Let's usePyUnicodeWriter instead to avoids re-creating strings:

PyUnicodeWriter*writer=PyUnicodeWriter_Create(0);if (writer==NULL) gotoerror;if (PyUnicodeWriter_WriteSubstring(writer,r,0,l-1)<0) gotoerror;if (exc->name) {if (hasargs) {if (PyUnicodeWriter_WriteASCII(writer,", ",2)<0) gotoerror;  }  ...}...returnPyUnicodeWriter_Finish(writer);error:/* cleanup */

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c OutdatedShow resolvedHide resolved

remove un-necessary casts

458bcd0

picnixz changed the title~~gh-74185: repr() of ImportError now contains attributes name and path. (patch)~~gh-74185: repr() of ImportError now contains attributes name and path

Jul 19, 2025

ynir3 added3 commits

July 19, 2025 12:52

use PyUnicodeWriter

fa2f884

fix trailing whitespace

35a6a29

reduce nesting

6e416c6

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c Outdated

		PyObject*r=BaseException_repr(self);
		PyImportErrorObject*exc=PyImportErrorObject_CAST(self);
		PyUnicodeWriter*writer=PyUnicodeWriter_Create(0);
		if (writer==NULL) gotoerror;

Copy link

Member

Choose a reason for hiding this comment

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

Sorry but my suggestion wasn'tPEP-7 compliant. So you should rewrite this function in aPEP-7 compliant way.

Copy link

ynir3Jul 19, 2025•
edited
Loading

Choose a reason for hiding this comment

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

@picnixz are you referring tobraces are required everywhere, even where C permits them to be omitted ?

Copy link

Member

Choose a reason for hiding this comment

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

Yes

Objects/exceptions.c Outdated

Comment on lines 1880 to 1882

		if (PyUnicodeWriter_WriteASCII(writer,"name='",6)<0) gotoerror;
		if (PyUnicodeWriter_WriteSubstring(writer,exc->name,0,PyUnicode_GET_LENGTH(exc->name))<0) gotoerror;
		if (PyUnicodeWriter_WriteASCII(writer,"'",1)<0) gotoerror;

Copy link

Member

Choose a reason for hiding this comment

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

For this one, as you're using the entire "exc->name", you can just usePyUnicodeWriter_Format("name=%R", exc->name") instead.

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c Outdated

Comment on lines 1896 to 1899

		error:
		Py_XDECREF(r);
		PyUnicodeWriter_Discard(writer);
		returnNULL;

Copy link

Member

Choose a reason for hiding this comment

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

Suggested change

	error:
	Py_XDECREF(r);
	PyUnicodeWriter_Discard(writer);
	returnNULL;
	error:
	Py_XDECREF(r);
	PyUnicodeWriter_Discard(writer);
	returnNULL;

picnixz reviewed

Jul 19, 2025

View reviewed changes

Lib/test/test_exceptions.py Outdated

Comment on lines 2634 to 2636

		try:
		importdoes_not_exist# type: ignore[import] # noqa: F401
		exceptModuleNotFoundErrorase:

Copy link

Member

Choose a reason for hiding this comment

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

You can usewith self.assertRaises(ImportError) as cm and checkcm.exception attributes.

Objects/exceptions.c

		@@ -1864,6 +1864,41 @@ ImportError_reduce(PyObject self, PyObject Py_UNUSED(ignored))
		returnres;
		}

		staticPyObject*
		ImportError_repr(PyObject*self)

Copy link

Member

Choose a reason for hiding this comment

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

Are there other exceptions that will benefit from having keywords in their reprs? AFAICT, the keywords are only rendered if they were passed to the constructor as keyword arguments. In particular, we could make a genericrepr helper for that which takes into account them, something like:

staticPyObject*repr_with_keywords(PyObject*exc,constchar*const*kwlist){/* format using kwlist[i]=getattr(exc, kwlist[i])     * with kwlist NULL-terminated */}

Its usage would be

staticchar*kwlist[]= {"name","path",NULL};repr_with_keywords(exc,kwlist)

Copy link

Member

picnixzJul 19, 2025•
edited
Loading

Choose a reason for hiding this comment

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

For now, let's hold off this idea as I don't know if it can be useful. But this can be worth investigating instead of storing the given keywords explicitly.

Copy link

ynir3Jul 19, 2025

Choose a reason for hiding this comment

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

yes - AFAIK only ImportError and ModuleNotFoundError (which hinnerits this functionality as per the tests) have optional arguments ? but makes sense to me that if other exception types in the future have optionals then we could extract this out.

Copy link

Member

picnixzJul 19, 2025•
edited
Loading

Choose a reason for hiding this comment

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

Yes, but let's do it in a follow-up PR so that we can revert the helper commit more easily. Also it depends on whether we would store the keywords passed to the constructor (this is#11580)

ynir3 added2 commits

July 19, 2025 13:14

use PyUnicdodeWriter_Format and if statement braces

aa75f6a

indentation

8b5e4ed

Copy link

ynir3 commentedJul 19, 2025

@picnixz any more comments ? :)

picnixz reviewed

Jul 19, 2025

View reviewed changes

Objects/exceptions.c Outdated

		gotoerror;
		}
		}
		if (PyUnicodeWriter_WriteASCII(writer,")",1)<0) gotoerror;

Copy link

Member

picnixzJul 19, 2025

Choose a reason for hiding this comment

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

PEP-7

Objects/exceptions.c Outdated

		if (writer==NULL) {
		gotoerror;
		}
		if (PyUnicodeWriter_WriteSubstring(writer,r,0,PyUnicode_GET_LENGTH(r)-1)<0) {

Copy link

Member

picnixzJul 19, 2025

Choose a reason for hiding this comment

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

Plese wrap lines under 80 chars.

Objects/exceptions.c Outdated

		ImportError_repr(PyObject*self)
		{
		inthasargs=PyTuple_GET_SIZE(((PyBaseExceptionObject*)self)->args)!=0;
		PyObject*r=BaseException_repr(self);

Copy link

Member

picnixzJul 19, 2025

Choose a reason for hiding this comment

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

This needs to be decrefed after it's been used. By doing so, you can also remove thePy_XDECREF(r) call at the end as it won't be needed anymore. I also suggest calling this function only after the writer has been successfully created.

Copy link

ynir3Jul 19, 2025

Choose a reason for hiding this comment

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

yup makes sense, thanks!

move decref

28545e5

Labels

None yet

6 participants

Movatterモバイル変換

Uh oh!

gh-74185: repr() of ImportError now contains attributes name and path#136770

Are you sure you want to change the base?

gh-74185: repr() of ImportError now contains attributes name and path#136770

Conversation

Yoav11 commentedJul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

python-cla-botbot commentedJul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

bedevere-appbot commentedJul 19, 2025

Uh oh!

bedevere-appbot commentedJul 19, 2025

Uh oh!

StanFromIreland commentedJul 19, 2025

Uh oh!

Uh oh!

picnixzJul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ynir3Jul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

picnixzJul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

picnixzJul 19, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ynir3 commentedJul 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Yoav11 commentedJul 19, 2025•
edited
Loading

python-cla-botbot commentedJul 19, 2025•
edited
Loading

picnixzJul 19, 2025•
edited
Loading

ynir3Jul 19, 2025•
edited
Loading

picnixzJul 19, 2025•
edited
Loading

picnixzJul 19, 2025•
edited
Loading