Mar 29, 2021 · Apr 7, 2020 · Apr 12, 2020 · Apr 12, 2020 · Jan 29, 2021 · Jan 29, 2021
diff --git a/Doc/c-api/init_config.rst b/Doc/c-api/init_config.rst

      Default: ``0``.

   .. c:member:: int warn_default_encoding

      If equals to 1, emit a ``EncodingWarning`` when ``TextIOWrapper``
      used its default encoding. See :pep:`597` for detail.

      .. versionadded:: 3.10

   .. c:member:: wchar_t* check_hash_pycs_mode

      Control the validation behavior of hash-based ``.pyc`` files:
diff --git a/Include/cpython/initconfig.h b/Include/cpython/initconfig.h
    PyWideStringList warnoptions;
    int site_import;
    int bytes_warning;
    intencoding_warning;
    intwarn_default_encoding;
    int inspect;
    int interactive;
    int optimization_level;
diff --git a/Include/internal/pycore_initconfig.h b/Include/internal/pycore_initconfig.h
    int isolated;             /* -I option */
    int use_environment;      /* -E option */
    int dev_mode;             /* -X dev and PYTHONDEVMODE */
    intencoding_warning;     /* -Xwarn_encoding andPYTHONWARNENCODING */
    intwarn_default_encoding;     /* -Xwarn_default_encoding andPYTHONWARNDEFAULTENCODING */
 } _PyPreCmdline;

 #define _PyPreCmdline_INIT \
    (_PyPreCmdline){ \
        .use_environment = -1, \
        .isolated = -1, \
        .dev_mode = -1, \
        .encoding_warning = -1}
        .warn_default_encoding = -1}
 /* Note: _PyPreCmdline_INIT sets other fields to 0/NULL */

 extern void _PyPreCmdline_Clear(_PyPreCmdline *cmdline);
diff --git a/Lib/_pyio.py b/Lib/_pyio.py
    Otherwise, return the default text encoding (i.e. "locale").

    This function emits EncodingWarning if *encoding* is None and
    sys.flags.encoding_warning is true.
    sys.flags.warn_default_encoding is true.

    This function can be used in APIs having encoding=None option.
    But please consider encoding="utf-8" for new APIs.
    """
    if encoding is None:
        if sys.flags.encoding_warning:
        if sys.flags.warn_default_encoding:
            import warnings
            warnings.warn(
                    "'encoding' option is not specified. The default encoding "
                    "will be changed to 'utf-8' in the future",
                    EncodingWarning, stacklevel + 2)
            warnings.warn("'encoding' option is not specified.",
                          EncodingWarning, stacklevel + 2)
        encoding = "locale"
    return encoding

diff --git a/Lib/test/test_embed.py b/Lib/test/test_embed.py

        'site_import': 1,
        'bytes_warning': 0,
        'encoding_warning': 0,
        'warn_default_encoding': 0,
        'inspect': 0,
        'interactive': 0,
        'optimization_level': 0,
diff --git a/Lib/test/test_io.py b/Lib/test/test_io.py

            pathlib.Path({filename!r}).read_text()  # line 8
        ''')
        proc = assert_python_ok('-X', 'warn_encoding', '-c', code)
        proc = assert_python_ok('-X', 'warn_default_encoding', '-c', code)
        warnings = proc.err.splitlines()
        self.assertEqual(len(warnings), 2)
        self.assertTrue(
diff --git a/Lib/test/test_sys.py b/Lib/test/test_sys.py
                 "dont_write_bytecode", "no_user_site", "no_site",
                 "ignore_environment", "verbose", "bytes_warning", "quiet",
                 "hash_randomization", "isolated", "dev_mode", "utf8_mode",
                 "encoding_warning")
                 "warn_default_encoding")
        for attr in attrs:
            self.assertTrue(hasattr(sys.flags, attr), attr)
            attr_type = bool if attr == "dev_mode" else int
diff --git a/Modules/_io/_iomodule.c b/Modules/_io/_iomodule.c
 Otherwise, return the default text encoding (i.e. "locale").

 This function emits EncodingWarning if *encoding* is None and
 sys.flags.encoding_warning is true.
 sys.flags.warn_default_encoding is true.

 This function can be used in APIs having encoding=None option.
 But please consider encoding="utf-8" for new APIs.
 [clinic start generated code]*/

 static PyObject *
 _io_text_encoding_impl(PyObject *module, PyObject *encoding, int stacklevel)
 /*[clinic end generated code: output=91b2cfea6934cc0c input=fd956a85976afd07]*/
 /*[clinic end generated code: output=91b2cfea6934cc0c input=31cd163789637f39]*/
 {
    if (encoding == NULL || encoding == Py_None) {
        PyInterpreterState *interp = _PyInterpreterState_GET();
        if (_PyInterpreterState_GetConfig(interp)->encoding_warning) {
        if (_PyInterpreterState_GetConfig(interp)->warn_default_encoding) {
            PyErr_WarnEx(PyExc_EncodingWarning,
                         "'encoding' option is omitted", stacklevel + 1);
        }
diff --git a/Modules/_io/clinic/_iomodule.c.h b/Modules/_io/clinic/_iomodule.c.h
 "Otherwise, return the default text encoding (i.e. \"locale\").\n"
 "\n"
 "This function emits EncodingWarning if *encoding* is None and\n"
 "sys.flags.encoding_warning is true.\n"
 "sys.flags.warn_default_encoding is true.\n"
 "\n"
 "This function can be used in APIs having encoding=None option.\n"
 "But please consider encoding=\"utf-8\" for new APIs.");
 exit:
    return return_value;
 }
 /*[clinic end generated code: output=f8081ebe49134854 input=a9049054013a1b77]*/
 /*[clinic end generated code: output=c8b593b834aeff7b input=a9049054013a1b77]*/
diff --git a/Modules/_io/textio.c b/Modules/_io/textio.c

    if (encoding == NULL) {
        PyInterpreterState *interp = _PyInterpreterState_GET();
        if (_PyInterpreterState_GetConfig(interp)->encoding_warning) {
        if (_PyInterpreterState_GetConfig(interp)->warn_default_encoding) {
            PyErr_WarnEx(PyExc_EncodingWarning,
                         "'encoding' option is omitted", 1);
        }
diff --git a/Python/initconfig.c b/Python/initconfig.c
             otherwise activate automatically)\n\
         -X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted at the\n\
             given directory instead of to the code tree\n\
         -Xwarn_encoding: enable opt-in EncodingWarning for 'encoding=None'\n\
         -Xwarn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\n\
 \n\
 --check-hash-based-pycs always|default|never:\n\
    control how Python invalidates hash-based .pyc files\n\
 "   debugger. It can be set to the callable of your debugger of choice.\n"
 "PYTHONDEVMODE: enable the development mode.\n"
 "PYTHONPYCACHEPREFIX: root directory for bytecode cache (pyc) files.\n"
 "PYTHONWARNENCODING: enable opt-in EncodingWarning for 'encoding=None'.\n";
 "PYTHONWARNDEFAULTENCODING: enable opt-in EncodingWarning for 'encoding=None'.\n";

 #if defined(MS_WINDOWS)
 #  define PYTHONHOMEHELP "<prefix>\\python{major}{minor}"
    assert(config->malloc_stats >= 0);
    assert(config->site_import >= 0);
    assert(config->bytes_warning >= 0);
    assert(config->encoding_warning >= 0);
    assert(config->warn_default_encoding >= 0);
    assert(config->inspect >= 0);
    assert(config->interactive >= 0);
    assert(config->optimization_level >= 0);
    config->parse_argv = 0;
    config->site_import = -1;
    config->bytes_warning = -1;
    config->encoding_warning = -1;
    config->warn_default_encoding = -1;
    config->inspect = -1;
    config->interactive = -1;
    config->optimization_level = -1;
    config->use_environment = 1;
    config->site_import = 1;
    config->bytes_warning = 0;
    config->encoding_warning = 0;
    config->warn_default_encoding = 0;
    config->inspect = 0;
    config->interactive = 0;
    config->optimization_level = 0;

    COPY_ATTR(site_import);
    COPY_ATTR(bytes_warning);
    COPY_ATTR(encoding_warning);
    COPY_ATTR(warn_default_encoding);
    COPY_ATTR(inspect);
    COPY_ATTR(interactive);
    COPY_ATTR(optimization_level);
    SET_ITEM_WSTR(platlibdir);
    SET_ITEM_INT(site_import);
    SET_ITEM_INT(bytes_warning);
    SET_ITEM_INT(encoding_warning);
    SET_ITEM_INT(warn_default_encoding);
    SET_ITEM_INT(inspect);
    SET_ITEM_INT(interactive);
    SET_ITEM_INT(optimization_level);
    GET_WSTRLIST(warnoptions);
    GET_UINT(site_import);
    GET_UINT(bytes_warning);
    GET_UINT(encoding_warning);
    GET_UINT(warn_default_encoding);
    GET_UINT(inspect);
    GET_UINT(interactive);
    GET_UINT(optimization_level);
        config->parse_argv = 2;
    }

    if (config->encoding_warning < 0) {
        config->encoding_warning = 0;
    if (config->warn_default_encoding < 0) {
        config->warn_default_encoding = 0;
    }

    return _PyStatus_OK();
diff --git a/Python/preconfig.c b/Python/preconfig.c
    COPY_ATTR(isolated);
    COPY_ATTR(use_environment);
    COPY_ATTR(dev_mode);
    COPY_ATTR(encoding_warning);
    COPY_ATTR(warn_default_encoding);
    return _PyStatus_OK();

 #undef COPY_ATTR
        cmdline->dev_mode = 0;
    }

    //encoding_warning
    if ((cmdline->encoding_warning < 0)
        && (_Py_get_xoption(&cmdline->xoptions, L"warn_encoding")
            || _Py_GetEnv(cmdline->use_environment, "PYTHONWARNENCODING")))
    //warn_default_encoding
    if ((cmdline->warn_default_encoding < 0)
        && (_Py_get_xoption(&cmdline->xoptions, L"warn_default_encoding")
            || _Py_GetEnv(cmdline->use_environment, "PYTHONWARNDEFAULTENCODING")))
    {
        cmdline->encoding_warning = 1;
        cmdline->warn_default_encoding = 1;
    }
    if (cmdline->encoding_warning < 0) {
        cmdline->encoding_warning = 0;
    if (cmdline->warn_default_encoding < 0) {
        cmdline->warn_default_encoding = 0;
    }

    assert(cmdline->use_environment >= 0);
    assert(cmdline->isolated >= 0);
    assert(cmdline->dev_mode >= 0);
    assert(cmdline->encoding_warning >= 0);
    assert(cmdline->warn_default_encoding >= 0);

    return _PyStatus_OK();
 }
diff --git a/Python/sysmodule.c b/Python/sysmodule.c
    {"isolated",                "-I"},
    {"dev_mode",                "-X dev"},
    {"utf8_mode",               "-X utf8"},
    {"encoding_warning","-Xwarn_encoding"},
    {"warn_default_encoding",   "-Xwarn_default_encoding"},
    {0}
 };

    SetFlag(config->isolated);
    SetFlagObj(PyBool_FromLong(config->dev_mode));
    SetFlag(preconfig->utf8_mode);
    SetFlag(config->encoding_warning);
    SetFlag(config->warn_default_encoding);
 #undef SetFlagObj
 #undef SetFlag
    return 0;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -583,6 +583,13 @@ PyConfig

		Default: ``0``.

		.. c:member:: int warn_default_encoding

		If equals to 1, emit a ``EncodingWarning`` when ``TextIOWrapper``
		used its default encoding. See :pep:`597` for detail.
methane marked this conversation as resolved. OutdatedShow resolvedHide resolved methane marked this conversation as resolved. OutdatedShow resolvedHide resolved

		.. versionadded:: 3.10

		.. c:member:: wchar_t* check_hash_pycs_mode

		Control the validation behavior of hash-based ``.pyc`` files:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -153,7 +153,7 @@ typedef struct PyConfig {
		PyWideStringList warnoptions;
		int site_import;
		int bytes_warning;
		intencoding_warning;
		intwarn_default_encoding;
		int inspect;
		int interactive;
		int optimization_level;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,15 +102,15 @@ typedef struct {
		int isolated; /* -I option */
		int use_environment; /* -E option */
		int dev_mode; /* -X dev and PYTHONDEVMODE */
		intencoding_warning; /* -Xwarn_encoding andPYTHONWARNENCODING */
		intwarn_default_encoding; /* -Xwarn_default_encoding andPYTHONWARNDEFAULTENCODING */
		} _PyPreCmdline;

		#define _PyPreCmdline_INIT \
		(_PyPreCmdline){ \
		.use_environment = -1, \
		.isolated = -1, \
		.dev_mode = -1, \
		.encoding_warning = -1}
		.warn_default_encoding = -1}
methane marked this conversation as resolved. OutdatedShow resolvedHide resolved
		/* Note: _PyPreCmdline_INIT sets other fields to 0/NULL */

		extern void _PyPreCmdline_Clear(_PyPreCmdline *cmdline);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,18 +48,16 @@ def text_encoding(encoding, stacklevel=1):
		Otherwise, return the default text encoding (i.e. "locale").

		This function emits EncodingWarning if encoding is None and
		sys.flags.encoding_warning is true.
		sys.flags.warn_default_encoding is true.

		This function can be used in APIs having encoding=None option.
		But please consider encoding="utf-8" for new APIs.
		"""
		if encoding is None:
		if sys.flags.encoding_warning:
		if sys.flags.warn_default_encoding:
		import warnings
		warnings.warn(
		"'encoding' option is not specified. The default encoding "
		"will be changed to 'utf-8' in the future",
		EncodingWarning, stacklevel + 2)
		warnings.warn("'encoding' option is not specified.",
		EncodingWarning, stacklevel + 2)
methane marked this conversation as resolved. OutdatedShow resolvedHide resolved
		encoding = "locale"
		return encoding

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -389,7 +389,7 @@ class InitConfigTests(EmbeddingTestsMixin, unittest.TestCase):

		'site_import': 1,
		'bytes_warning': 0,
		'encoding_warning': 0,
		'warn_default_encoding': 0,
		'inspect': 0,
		'interactive': 0,
		'optimization_level': 0,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4237,7 +4237,7 @@ def test_check_encoding_warning(self):

		pathlib.Path({filename!r}).read_text() # line 8
		''')
		proc = assert_python_ok('-X', 'warn_encoding', '-c', code)
		proc = assert_python_ok('-X', 'warn_default_encoding', '-c', code)
		warnings = proc.err.splitlines()
		self.assertEqual(len(warnings), 2)
		self.assertTrue(
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -592,7 +592,7 @@ def test_sys_flags(self):
		"dont_write_bytecode", "no_user_site", "no_site",
		"ignore_environment", "verbose", "bytes_warning", "quiet",
		"hash_randomization", "isolated", "dev_mode", "utf8_mode",
		"encoding_warning")
		"warn_default_encoding")
		for attr in attrs:
		self.assertTrue(hasattr(sys.flags, attr), attr)
		attr_type = bool if attr == "dev_mode" else int
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -519,19 +519,19 @@ When encoding is not None, just return it.
		Otherwise, return the default text encoding (i.e. "locale").

		This function emits EncodingWarning if encoding is None and
		sys.flags.encoding_warning is true.
		sys.flags.warn_default_encoding is true.

		This function can be used in APIs having encoding=None option.
		But please consider encoding="utf-8" for new APIs.
		[clinic start generated code]*/

		static PyObject *
		_io_text_encoding_impl(PyObject module, PyObject encoding, int stacklevel)
		/[clinic end generated code: output=91b2cfea6934cc0c input=fd956a85976afd07]/
		/[clinic end generated code: output=91b2cfea6934cc0c input=31cd163789637f39]/
		{
		if (encoding == NULL \|\| encoding == Py_None) {
		PyInterpreterState *interp = _PyInterpreterState_GET();
		if (_PyInterpreterState_GetConfig(interp)->encoding_warning) {
		if (_PyInterpreterState_GetConfig(interp)->warn_default_encoding) {
		PyErr_WarnEx(PyExc_EncodingWarning,
		"'encoding' option is omitted", stacklevel + 1);
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -282,7 +282,7 @@ PyDoc_STRVAR(_io_text_encoding__doc__,
		"Otherwise, return the default text encoding (i.e. \"locale\").\n"
		"\n"
		"This function emits EncodingWarning if encoding is None and\n"
		"sys.flags.encoding_warning is true.\n"
		"sys.flags.warn_default_encoding is true.\n"
		"\n"
		"This function can be used in APIs having encoding=None option.\n"
		"But please consider encoding=\"utf-8\" for new APIs.");
Expand DownExpand Up		@@ -362,4 +362,4 @@ _io_open_code(PyObject module, PyObject const *args, Py_ssize_t nargs, PyObjec
		exit:
		return return_value;
		}
		/[clinic end generated code: output=f8081ebe49134854 input=a9049054013a1b77]/
		/[clinic end generated code: output=c8b593b834aeff7b input=a9049054013a1b77]/
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1125,7 +1125,7 @@ _io_TextIOWrapper___init___impl(textio self, PyObject buffer,

		if (encoding == NULL) {
		PyInterpreterState *interp = _PyInterpreterState_GET();
		if (_PyInterpreterState_GetConfig(interp)->encoding_warning) {
		if (_PyInterpreterState_GetConfig(interp)->warn_default_encoding) {
		PyErr_WarnEx(PyExc_EncodingWarning,
		"'encoding' option is omitted", 1);
methane marked this conversation as resolved. OutdatedShow resolvedHide resolved
		}
Expand Down