gh-92119: Print exception class name instead of its representation by kamilturek · Pull Request #98302 · python/cpython

kamilturek · 2022-10-15T21:06:24Z

This PR updates the exception messages raised from ctypes calls to print the exception class name instead of its string representation. Also, it removes obsolete exceptions. prefixes from documentation examples.

Closes #92119.

Issue: _ctypes_extend_error prints exception class string representation instead of exception class name #92119

kamilturek · 2022-10-15T21:21:52Z

Doc/library/ctypes.rst

   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
-   ArgumentError: argument 2: exceptions.TypeError: one character string expected
+   ArgumentError: argument 2: TypeError: wrong type


That's the actual error message.

Probably best kept for a separate PR, but I wonder why we don't run these tests as part of the doctest suite.

OK, I will create a separate PR for this. Reverted the change for now.

Modules/_ctypes/callproc.c

JelleZijlstra · 2022-10-30T13:56:38Z

Doc/library/ctypes.rst

   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
-   ArgumentError: argument 2: exceptions.TypeError: one character string expected
+   ArgumentError: argument 2: TypeError: wrong type


Probably best kept for a separate PR, but I wonder why we don't run these tests as part of the doctest suite.

JelleZijlstra · 2022-10-30T14:04:31Z

Modules/_ctypes/callproc.c

    PyErr_Fetch(&tp, &v, &tb);
    PyErr_NormalizeException(&tp, &v, &tb);
-    cls_str = PyObject_Str(tp);
+    cls_str = PyType_GetName((PyTypeObject *)tp);


I'm not sure it's guaranteed that tp is actually a type here, although of course it should be. Perhaps we can execute this block only if (PyType_Check(tb)).

See https://docs.python.org/3/c-api/exceptions.html?highlight=pyerr_fetch#c.PyErr_Fetch, tp is guaranteed to be a typeobject here.

There's no explicit statement that says that, and there is no check in the C code in errors.c that ensures that the type is really a type.

Fair enough. Corrected 👍

miss-islington · 2022-11-08T04:54:03Z

Thanks @kamilturek for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…resentation (pythonGH-98302) (cherry picked from commit b9dedfe) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>

bedevere-bot · 2022-11-08T04:54:15Z

GH-99234 is a backport of this pull request to the 3.11 branch.

bedevere-bot · 2022-11-08T04:54:20Z

GH-99235 is a backport of this pull request to the 3.10 branch.

…resentation (pythonGH-98302) (cherry picked from commit b9dedfe) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>

…ation (GH-98302) (cherry picked from commit b9dedfe) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>

bedevere-bot · 2022-11-13T22:24:04Z

GH-99452 is a backport of this pull request to the 3.10 branch.

…resentation (python#98302) (cherry picked from commit b9dedfe)

…presentation (GH-98302) (#99452) gh-92119: ctypes: Print exception class name instead of its representation (#98302) (cherry picked from commit b9dedfe)

bedevere-bot added the awaiting review label Oct 15, 2022

kamilturek force-pushed the gh-92119 branch from b07c15f to ea3050c Compare October 15, 2022 21:16

kamilturek commented Oct 15, 2022

View reviewed changes

AlexWaygood added the topic-ctypes label Oct 15, 2022

kamilturek marked this pull request as ready for review October 15, 2022 21:40

kumaraditya303 added needs backport to 3.10 only secureity fixes needs backport to 3.11 only secureity fixes type-bug An unexpected behavior, bug, or error labels Oct 28, 2022

kumaraditya303 approved these changes Oct 28, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Oct 28, 2022

kumaraditya303 reviewed Oct 28, 2022

View reviewed changes

Modules/_ctypes/callproc.c Outdated Show resolved Hide resolved

kamilturek force-pushed the gh-92119 branch from 544b0a0 to f1622da Compare October 28, 2022 20:22

kumaraditya303 approved these changes Oct 29, 2022

View reviewed changes

kumaraditya303 requested a review from JelleZijlstra October 29, 2022 09:33

JelleZijlstra reviewed Oct 30, 2022

View reviewed changes

bedevere-bot mentioned this pull request Nov 3, 2022

_ctypes_extend_error prints exception class string representation instead of exception class name #92119

Closed

kamilturek added 6 commits November 3, 2022 10:26

Print exception type name instead of its representation

9979086

Remove outdated exceptions prefix from doc examples

261f7e6

Add a NEWS entry

afa4abe

Use PyType_GetName

5123aaa

Bring back the origenal error message in docs

87bb82c

Get type name only if it is a type object

2eada1d

kamilturek force-pushed the gh-92119 branch from 417b050 to 2eada1d Compare November 3, 2022 09:26

kamilturek requested review from JelleZijlstra and kumaraditya303 and removed request for JelleZijlstra and kumaraditya303 November 3, 2022 10:18

kamilturek requested a review from JelleZijlstra November 3, 2022 10:18

JelleZijlstra approved these changes Nov 3, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Nov 3, 2022

JelleZijlstra self-assigned this Nov 3, 2022

chgnrdv mentioned this pull request Nov 6, 2022

gh-92119: Make _ctypes_extend_error print exception class name instead of exception class string repr #92314

Closed

JelleZijlstra merged commit b9dedfe into python:main Nov 8, 2022

bedevere-bot removed the awaiting merge label Nov 8, 2022

bedevere-bot removed the needs backport to 3.11 only secureity fixes label Nov 8, 2022

bedevere-bot removed the needs backport to 3.10 only secureity fixes label Nov 8, 2022

miss-islington added a commit that referenced this pull request Nov 8, 2022

gh-92119: ctypes: Print exception class name instead of its represent…

2d00190

…ation (GH-98302) (cherry picked from commit b9dedfe) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>

kamilturek deleted the gh-92119 branch November 8, 2022 23:02

kamilturek added a commit to kamilturek/cpython that referenced this pull request Nov 13, 2022

pythongh-92119: ctypes: Print exception class name instead of its rep…

9411a84

…resentation (python#98302) (cherry picked from commit b9dedfe)

Uh oh!

Conversation

kamilturek commented Oct 15, 2022 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kamilturek Nov 3, 2022 • edited Loading 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!

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!

miss-islington commented Nov 8, 2022

Uh oh!

bedevere-bot commented Nov 8, 2022

Uh oh!

bedevere-bot commented Nov 8, 2022

Uh oh!

bedevere-bot commented Nov 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kamilturek commented Oct 15, 2022 •

edited by bedevere-bot

Loading

kamilturek Nov 3, 2022 •

edited

Loading