Skip to content

bpo-37645: add new function _PyObject_FunctionStr() #14890

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
miss-islington merged 9 commits into from
Nov 5, 2019
Merged

bpo-37645: add new function _PyObject_FunctionStr() #14890

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2a55a9f
bpo-37645: add new function PyObject_FunctionStr()
jdemeyer Jul 21, 2019
733158d
bpo-37645: clear exception in check_args_iterable()
jdemeyer Jul 21, 2019
4c0c877
bpo-37645: rename PyObject_FunctionStr() -> _PyObject_FunctionStr()
jdemeyer Aug 4, 2019
2e1b44e
bpo-37645: use str(func) as fallback in _PyObject_FunctionStr()
jdemeyer Aug 18, 2019
fa20556
bpo-37645: review fixes
jdemeyer Sep 13, 2019
b2e56da
Handle error in PyObject_RichCompareBool
encukou Oct 22, 2019
21aee80
Add author to NEWS
encukou Oct 22, 2019
402ec96
Change format_kwargs_error to use _PyObject_FunctionStr as well
encukou Nov 5, 2019
0307ce9
Merge branch 'master' to resolve PyErr_Format/_PyErr_Format conflict
encukou Nov 5, 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
bpo-37645: rename PyObject_FunctionStr() -> _PyObject_FunctionStr()
  • Loading branch information
@jdemeyer
jdemeyer committed Aug 18, 2019
commit 4c0c877889b406d33a863005361afb1bd19149af
2 changes: 1 addition & 1 deletion Doc/c-api/object.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Object Protocol
does not silently discard an active exception.


.. c:function:: PyObject* PyObject_FunctionStr(PyObject *func)
.. c:function:: PyObject* _PyObject_FunctionStr(PyObject *func)
Comment thread
jdemeyer marked this conversation as resolved.
Outdated

Return a user-friendly string representation of the function-like object
*func*. This returns ``func.__qualname__ + "()"`` if there is a

@serhiy-storchaka serhiy-storchaka Sep 13, 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.

Returning __qualname__ without module is not particularly useful.

If you want to return a full qualified name (long but unambiguous), return __module__ + '.' + __qualname__. __module__ can be omitted if it is 'builtins'.

If you want to return a short name (it is enough in many times), return __name__.

if __qualname__ is not available, you can use __name__ instead.

@jdemeyer jdemeyer Sep 13, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

if __qualname__ is not available, you can use __name__ instead.

This is mainly meant as replacement for PyEval_GetFuncName and all classes supported by that function implement __qualname__. So I see little reason for the additional complexity of supporting __name__.

Expand Down
2 changes: 1 addition & 1 deletion Include/cpython/object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ static inline void _Py_Dealloc_inline(PyObject *op)
}
#define _Py_Dealloc(op) _Py_Dealloc_inline(op)

PyAPI_FUNC(PyObject *) PyObject_FunctionStr(PyObject *);
PyAPI_FUNC(PyObject *) _PyObject_FunctionStr(PyObject *);

/* Safely decref `op` and set `op` to `op2`.
*
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/next/C API/2019-07-21-21-08-47.bpo-37645.4DcUaI.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Add :c:func:`PyObject_FunctionStr` to get a user-friendly string representation
Add :c:func:`_PyObject_FunctionStr` to get a user-friendly string representation
of a function-like object.
8 changes: 4 additions & 4 deletions Objects/descrobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ method_check_args(PyObject *func, PyObject *const *args, Py_ssize_t nargs, PyObj
{
assert(!PyErr_Occurred());
if (nargs < 1) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U needs an argument", funcstr);
Expand All @@ -250,7 +250,7 @@ method_check_args(PyObject *func, PyObject *const *args, Py_ssize_t nargs, PyObj
return -1;
}
if (kwnames && PyTuple_GET_SIZE(kwnames)) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes no keyword arguments", funcstr);
Expand Down Expand Up @@ -375,7 +375,7 @@ method_vectorcall_NOARGS(
return NULL;
}
if (nargs != 1) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes no arguments (%zd given)", funcstr, nargs-1);
Expand All @@ -401,7 +401,7 @@ method_vectorcall_O(
return NULL;
}
if (nargs != 2) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes exactly one argument (%zd given)",
Expand Down
6 changes: 3 additions & 3 deletions Objects/methodobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ cfunction_check_kwargs(PyObject *func, PyObject *kwnames)
assert(!PyErr_Occurred());
assert(PyCFunction_Check(func));
if (kwnames && PyTuple_GET_SIZE(kwnames)) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes no keyword arguments", funcstr);
Expand Down Expand Up @@ -403,7 +403,7 @@ cfunction_vectorcall_NOARGS(
}
Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
if (nargs != 0) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes no arguments (%zd given)", funcstr, nargs);
Expand All @@ -429,7 +429,7 @@ cfunction_vectorcall_O(
}
Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
if (nargs != 1) {
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
PyErr_Format(PyExc_TypeError,
"%U takes exactly one argument (%zd given)", funcstr, nargs);
Expand Down
6 changes: 2 additions & 4 deletions Objects/object.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,14 +665,14 @@ PyObject_Bytes(PyObject *v)


/*
def PyObject_FunctionStr(f):
def _PyObject_FunctionStr(f):
try:
return f.__qualname__ + "()"
except Exception:
return type(f).__name__ + " object"
*/
PyObject *
PyObject_FunctionStr(PyObject *f)
_PyObject_FunctionStr(PyObject *f)
{
Comment thread
jdemeyer marked this conversation as resolved.
Outdated
_Py_IDENTIFIER(__qualname__);
PyObject *name = _PyObject_GetAttrId(f, &PyId___qualname__);
Expand All @@ -683,8 +683,6 @@ PyObject_FunctionStr(PyObject *f)
}
/* __qualname__ lookup failed */
if (!PyErr_ExceptionMatches(PyExc_Exception)) {
Comment thread
jdemeyer marked this conversation as resolved.
Outdated
/* An exception not inheriting from Exception, like KeyboardInterrupt.
* Propagate it. */
return NULL;
}
PyErr_Clear();
Expand Down
2 changes: 1 addition & 1 deletion Python/ceval.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5344,7 +5344,7 @@ check_args_iterable(PyThreadState *tstate, PyObject *func, PyObject *args)
/* check_args_iterable() may be called with a live exception,
* clear it. */
Comment thread
jdemeyer marked this conversation as resolved.
Outdated
PyErr_Clear();
PyObject *funcstr = PyObject_FunctionStr(func);
PyObject *funcstr = _PyObject_FunctionStr(func);
if (funcstr != NULL) {
_PyErr_Format(tstate, PyExc_TypeError,
"%U argument after * must be an iterable, not %.200s",
Expand Down