Skip to content
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

Jump to bottom

bpo-1635741: Port _locale extension module to multiphase initialization (PEP 489) #18358

Merged
merged 7 commits into from
Mar 11, 2020
Merged

bpo-1635741: Port _locale extension module to multiphase initialization (PEP 489) #18358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4ce0c7c
Port _locale extension module to multiphase initialization (PEP 489)
shihai1991 Feb 5, 2020
c0e0174
📜🤖 Added by blurb_it.
blurb-it[bot] Feb 5, 2020
3aaf488
add get_locale_state()
shihai1991 Feb 17, 2020
8e0e2bf
Merge branch 'bpo_1635741_9' of https://github.com/shihai1991/cpython…
shihai1991 Feb 17, 2020
2a4ac1b
fix format bug
shihai1991 Feb 18, 2020
70fddf4
locale extension module add clean slots
shihai1991 Feb 18, 2020
f3a1d08
Add back assertion in get_locale_state
encukou Feb 25, 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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2020-02-05-07-55-57.bpo-1635741.H_tCC9.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Port _locale extension module to multiphase initialization (:pep:`489`).
117 changes: 83 additions & 34 deletions Modules/_localemodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,17 @@ This software comes with no warranty. Use at your own risk.

PyDoc_STRVAR(locale__doc__, "Support for POSIX locales.");

static PyObject *Error;
typedef struct _locale_state {
PyObject *Error;
} _locale_state;

static inline _locale_state*
get_locale_state(PyObject *m)
{
void *state = PyModule_GetState(m);
assert(state != NULL);
return (_locale_state *)state;
}

/* support functions for formatting floating point numbers */

Expand Down Expand Up @@ -94,7 +104,8 @@ PyLocale_setlocale(PyObject* self, PyObject* args)
#if defined(MS_WINDOWS)
if (category < LC_MIN || category > LC_MAX)
{
PyErr_SetString(Error, "invalid locale category");
PyErr_SetString(get_locale_state(self)->Error,
"invalid locale category");
return NULL;
}
#endif
Expand All @@ -104,7 +115,8 @@ PyLocale_setlocale(PyObject* self, PyObject* args)
result = setlocale(category, locale);
if (!result) {
/* operation failed, no setting was changed */
PyErr_SetString(Error, "unsupported locale setting");
PyErr_SetString(get_locale_state(self)->Error,
"unsupported locale setting");
return NULL;
}
result_object = PyUnicode_DecodeLocale(result, NULL);
Expand All @@ -114,7 +126,8 @@ PyLocale_setlocale(PyObject* self, PyObject* args)
/* get locale */
result = setlocale(category, NULL);
if (!result) {
PyErr_SetString(Error, "locale query failed");
PyErr_SetString(get_locale_state(self)->Error,
"locale query failed");
return NULL;
}
result_object = PyUnicode_DecodeLocale(result, NULL);
Expand Down Expand Up @@ -622,14 +635,16 @@ PyDoc_STRVAR(bindtextdomain__doc__,
"Bind the C library's domain to dir.");

static PyObject*
PyIntl_bindtextdomain(PyObject* self,PyObject*args)
PyIntl_bindtextdomain(PyObject* self, PyObject*args)
{
char *domain, *dirname, *current_dirname;
PyObject *dirname_obj, *dirname_bytes = NULL, *result;

if (!PyArg_ParseTuple(args, "sO", &domain, &dirname_obj))
return 0;
if (!strlen(domain)) {
PyErr_SetString(Error, "domain must be a non-empty string");
PyErr_SetString(get_locale_state(self)->Error,
"domain must be a non-empty string");
return 0;
}
if (dirname_obj != Py_None) {
Expand Down Expand Up @@ -710,31 +725,13 @@ static struct PyMethodDef PyLocale_Methods[] = {
{NULL, NULL}
};


static struct PyModuleDef _localemodule = {
PyModuleDef_HEAD_INIT,
"_locale",
locale__doc__,
-1,
PyLocale_Methods,
NULL,
NULL,
NULL,
NULL
};

PyMODINIT_FUNC
PyInit__locale(void)
static int
_locale_exec(PyObject *m)
{
PyObject *m;
#ifdef HAVE_LANGINFO_H
int i;
#endif

m = PyModule_Create(&_localemodule);
if (m == NULL)
return NULL;

PyModule_AddIntMacro(m, LC_CTYPE);
PyModule_AddIntMacro(m, LC_TIME);
PyModule_AddIntMacro(m, LC_COLLATE);
Expand All @@ -748,12 +745,16 @@ PyInit__locale(void)
PyModule_AddIntMacro(m, LC_ALL);
PyModule_AddIntMacro(m, CHAR_MAX);

Error = PyErr_NewException("locale.Error", NULL, NULL);
if (Error == NULL) {
Py_DECREF(m);
return NULL;
_locale_state *state = get_locale_state(m);
state->Error = PyErr_NewException("locale.Error", NULL, NULL);
encukou marked this conversation as resolved.
Show resolved Hide resolved
if (state->Error == NULL) {
return -1;
}
Py_INCREF(get_locale_state(m)->Error);
if (PyModule_AddObject(m, "Error", get_locale_state(m)->Error) < 0) {
Py_DECREF(get_locale_state(m)->Error);
return -1;
}
PyModule_AddObject(m, "Error", Error);

#ifdef HAVE_LANGINFO_H
for (i = 0; langinfo_constants[i].name; i++) {
Expand All @@ -763,10 +764,58 @@ PyInit__locale(void)
#endif

if (PyErr_Occurred()) {
Py_DECREF(m);
return NULL;
return -1;
}
return m;
return 0;
}

static struct PyModuleDef_Slot _locale_slots[] = {
{Py_mod_exec, _locale_exec},
{0, NULL}
};

static int
locale_traverse(PyObject *m, visitproc visit, void *arg)
{
_locale_state *state = (_locale_state*)PyModule_GetState(m);
if (state) {
Copy link
Member

Choose a reason for hiding this comment

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

As I asked on your two other PRs (binascii, audioop), I don't think that state can be NULL here. Same remark in locale_clear().

Copy link
Member Author

Choose a reason for hiding this comment

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

Hi, victor. There have some description info about traverse slot in https://docs.python.org/3/c-api/module.html?highlight=pymoduledef#c.PyModuleDef:

A traversal function to call during GC traversal of the module object, or NULL if not needed. This function may be called before module state is allocated (PyModule_GetState() may return NULL), and before the Py_mod_exec function is executed.

So this behavior is a planned behavior, isn't it?

Copy link
Member

Choose a reason for hiding this comment

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

Let's discuss that in https://bugs.python.org/issue39824

Copy link
Member

Choose a reason for hiding this comment

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

The discussion won't be over before Nick Coghlan is satisfied (and that's a good thing!)

Meanwhile, this PR is correct according to current behavior and documentation. I don't think bpo-39824 should block it.

Copy link
Member

Choose a reason for hiding this comment

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

Alright. I expected https://bugs.python.org/issue39824 to be resolved quick, but I'm ok to merge @shihai1991 PR's first, and revisit the code later if we decided that m_clear/m_free cannot be called with a NULL state.

Py_VISIT(state->Error);
}
return 0;
}

static int
locale_clear(PyObject *m)
{
_locale_state *state = (_locale_state*)PyModule_GetState(m);
if (state) {
Py_CLEAR(state->Error);
}
return 0;
}

static void
locale_free(PyObject *m)
{
locale_clear(m);
}

static struct PyModuleDef _localemodule = {
PyModuleDef_HEAD_INIT,
"_locale",
locale__doc__,
sizeof(_locale_state),
PyLocale_Methods,
_locale_slots,
locale_traverse,
locale_clear,
(freefunc)locale_free,
};

PyMODINIT_FUNC
PyInit__locale(void)
{
return PyModuleDef_Init(&_localemodule);
}

/*
Expand Down