Skip to content

Commit bd47511

Browse files
author
Victor Stinner
committed
Issue #3080: Add PyModule_GetNameObject()
repr(module) uses %R to format module name and filenames, instead of '%s' and '%U', so surrogates from undecodable bytes in a filename (PEP 383) are escaped.
1 parent 501c09a commit bd47511

3 files changed

Lines changed: 45 additions & 21 deletions

File tree

‎Doc/c-api/module.rst‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ There are only a few functions special to module objects.
5252
manipulate a module's :attr:`__dict__`.
5353
5454
55-
.. c:function:: char* PyModule_GetName(PyObject *module)
55+
.. c:function:: PyObject* PyModule_GetNameObject(PyObject *module)
5656
5757
.. index::
5858
single: __name__ (module attribute)
@@ -61,15 +61,13 @@ There are only a few functions special to module objects.
6161
Return *module*'s :attr:`__name__` value. If the module does not provide one,
6262
or if it is not a string, :exc:`SystemError` is raised and *NULL* is returned.
6363
64+
.. versionadded:: 3.3
6465
65-
.. c:function:: char* PyModule_GetFilename(PyObject *module)
6666
67-
Similar to :c:func:`PyModule_GetFilenameObject` but return the filename
68-
encoded to 'utf-8'.
67+
.. c:function:: char* PyModule_GetName(PyObject *module)
6968
70-
.. deprecated:: 3.2
71-
:c:func:`PyModule_GetFilename` raises :c:type:`UnicodeEncodeError` on
72-
unencodable filenames, use :c:func:`PyModule_GetFilenameObject` instead.
69+
Similar to :c:func:`PyModule_GetNameObject` but return the name encoded to
70+
``'utf-8'``.
7371
7472
7573
.. c:function:: PyObject* PyModule_GetFilenameObject(PyObject *module)
@@ -86,6 +84,16 @@ There are only a few functions special to module objects.
8684
.. versionadded:: 3.2
8785
8886
87+
.. c:function:: char* PyModule_GetFilename(PyObject *module)
88+
89+
Similar to :c:func:`PyModule_GetFilenameObject` but return the filename
90+
encoded to 'utf-8'.
91+
92+
.. deprecated:: 3.2
93+
:c:func:`PyModule_GetFilename` raises :c:type:`UnicodeEncodeError` on
94+
unencodable filenames, use :c:func:`PyModule_GetFilenameObject` instead.
95+
96+
8997
.. c:function:: void* PyModule_GetState(PyObject *module)
9098
9199
Return the "state" of the module, that is, a pointer to the block of memory

‎Include/moduleobject.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ PyAPI_FUNC(PyObject *) PyModule_New(
1616
const char *name /* UTF-8 encoded string */
1717
);
1818
PyAPI_FUNC(PyObject *) PyModule_GetDict(PyObject *);
19+
PyAPI_FUNC(PyObject *) PyModule_GetNameObject(PyObject *);
1920
PyAPI_FUNC(const char *) PyModule_GetName(PyObject *);
2021
PyAPI_FUNC(const char *) PyModule_GetFilename(PyObject *);
2122
PyAPI_FUNC(PyObject *) PyModule_GetFilenameObject(PyObject *);

‎Objects/moduleobject.c‎

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -169,24 +169,35 @@ PyModule_GetDict(PyObject *m)
169169
return d;
170170
}
171171

172-
const char *
173-
PyModule_GetName(PyObject *m)
172+
PyObject*
173+
PyModule_GetNameObject(PyObject *m)
174174
{
175175
PyObject *d;
176-
PyObject *nameobj;
176+
PyObject *name;
177177
if (!PyModule_Check(m)) {
178178
PyErr_BadArgument();
179179
return NULL;
180180
}
181181
d = ((PyModuleObject *)m)->md_dict;
182182
if (d == NULL ||
183-
(nameobj = PyDict_GetItemString(d, "__name__")) == NULL ||
184-
!PyUnicode_Check(nameobj))
183+
(name = PyDict_GetItemString(d, "__name__")) == NULL ||
184+
!PyUnicode_Check(name))
185185
{
186186
PyErr_SetString(PyExc_SystemError, "nameless module");
187187
return NULL;
188188
}
189-
return _PyUnicode_AsString(nameobj);
189+
Py_INCREF(name);
190+
return name;
191+
}
192+
193+
const char *
194+
PyModule_GetName(PyObject *m)
195+
{
196+
PyObject *name = PyModule_GetNameObject(m);
197+
if (name == NULL)
198+
return NULL;
199+
Py_DECREF(name); /* module dict has still a reference */
200+
return _PyUnicode_AsString(name);
190201
}
191202

192203
PyObject*
@@ -219,7 +230,7 @@ PyModule_GetFilename(PyObject *m)
219230
if (fileobj == NULL)
220231
return NULL;
221232
utf8 = _PyUnicode_AsString(fileobj);
222-
Py_DECREF(fileobj);
233+
Py_DECREF(fileobj); /* module dict has still a reference */
223234
return utf8;
224235
}
225236

@@ -347,21 +358,25 @@ module_dealloc(PyModuleObject *m)
347358
static PyObject *
348359
module_repr(PyModuleObject *m)
349360
{
350-
const char *name;
351-
PyObject *filename, *repr;
361+
PyObject *name, *filename, *repr;
352362

353-
name = PyModule_GetName((PyObject *)m);
363+
name = PyModule_GetNameObject((PyObject *)m);
354364
if (name == NULL) {
355365
PyErr_Clear();
356-
name = "?";
366+
name = PyUnicode_FromStringAndSize("?", 1);
367+
if (name == NULL)
368+
return NULL;
357369
}
358370
filename = PyModule_GetFilenameObject((PyObject *)m);
359371
if (filename == NULL) {
360372
PyErr_Clear();
361-
return PyUnicode_FromFormat("<module '%s' (built-in)>", name);
373+
repr = PyUnicode_FromFormat("<module %R (built-in)>", name);
374+
}
375+
else {
376+
repr = PyUnicode_FromFormat("<module %R from %R>", name, filename);
377+
Py_DECREF(filename);
362378
}
363-
repr = PyUnicode_FromFormat("<module '%s' from '%U'>", name, filename);
364-
Py_DECREF(filename);
379+
Py_DECREF(name);
365380
return repr;
366381
}
367382

0 commit comments

Comments
 (0)