bpo-33601 Py_UTF8Mode is not documented#31480
Uh oh!
There was an error while loading. Please reload this page.
Conversation
Added UTF8Mode documentation to https://docs.python.org/dev/c-api/init.html#global-configuration-variables
AA-Turner commented May 21, 2022
I only see checks for if A |
AA-Turner added needs backport to 3.10 
vstinner commented May 23, 2022
I created #93103 to deprecate Global Configuration Variables like |
MaxwellDupre left a comment
MaxwellDupre left a comment There was a problem hiding this comment.
How about adding a link in C API Stability page to init.rst?
Also, adding
Py_UTF8Mode=1 enables UTF-8 mode. However the PYTHONUTF8 environment variable is ignored (even if use_environment=1).
| If set to 1, enable the UTF-8 Mode. | ||
| If set to 0, disable the UTF-8 Mode. | ||
| If set to -1, look for the :option:`-x` option and the :envvar:`PYTHONUTF8` environment variable. |
There was a problem hiding this comment.
Please mention that the variable is now deprecated: #93943
| If set to 1, enable the UTF-8 Mode. | ||
| If set to 0, disable the UTF-8 Mode. | ||
| If set to -1, look for the :option:`-x` option and the :envvar:`PYTHONUTF8` environment variable. |
There was a problem hiding this comment.
| If set to -1, look for the :option:`-x` option and the :envvar:`PYTHONUTF8` environment variable. | |
| If set to -1, look for the :option:`-x utf8 <-x>` command line option and the :envvar:`PYTHONUTF8` environment variable. |
| Enables the UTF-8 Mode. | ||
| If set to 1, enable the UTF-8 Mode. | ||
| If set to 0, disable the UTF-8 Mode. |
There was a problem hiding this comment.
I'm not sure that it works this way. preconfig_get_global_vars() ignores Py_UTF8Mode if Py_UTF8Mode <= 0.
Py_UTF8Mode should not be used: PyPreConfig.utf8_mode should be used instead. Today, it seems like the only purpose of Py_UTF8Mode is to explicitly enable the Python UTF-8 Mode with Py_UTF8Mode=1.
| .. c:var::int Py_UTF8Mode | ||
| Enables the UTF-8 Mode. |
There was a problem hiding this comment.
You can add a link to https://docs.python.org/dev/library/os.html#python-utf-8-mode using utf8-mode reference. Please replace "UTF-8 Mode" with "Pyhon UTF-8 Mode".
serhiy-storchaka added needs backport to 3.12 
The following commit authors need to sign the Contributor License Agreement: |
Thank you for the contribution however it has been decided that this will in fact not be documented, the attached issue has been closed as not planned. |
AA-Turner removed needs backport to 3.13 10 participants
Added UTF8Mode documentation to https://docs.python.org/dev/c-api/init.html#global-configuration-variables
https://bugs.python.org/issue33601