Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork33.7k
bpo-33601 Py_UTF8Mode is not documented#31480
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Added UTF8Mode documentation tohttps://docs.python.org/dev/c-api/init.html#global-configuration-variables
AA-Turner commentedMay 21, 2022
I only see checks for if A |
vstinner commentedMay 23, 2022
I created#93103 to deprecate Global Configuration Variables like |
MaxwellDupre left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Please mention that the variable is now deprecated:#93943
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Done in3ec424d (#31480) when resolving the conflict.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm not sure that it works this way. preconfig_get_global_vars() ignores Py_UTF8Mode ifPy_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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
You can add a link tohttps://docs.python.org/dev/library/os.html#python-utf-8-mode usingutf8-mode reference. Please replace "UTF-8 Mode" with "Pyhon UTF-8 Mode".
The following commit authors need to sign the Contributor License Agreement: |
StanFromIreland commentedJul 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Thank you for the contribution however it has been decided that this will in fact not be documented, the attached issue has been closed asnot planned. |
Uh oh!
There was an error while loading.Please reload this page.
Added UTF8Mode documentation tohttps://docs.python.org/dev/c-api/init.html#global-configuration-variables
https://bugs.python.org/issue33601