traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-39287: Doc: Add UTF-8 mode section in using/windows. (GH-17935) 

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
(cherry picked from commit 148610d88a)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
This commit is contained in:
Miss Islington (bot) 2020-01-28 02:18:09 -08:00 committed by GitHub
parent 46735c7e10
commit cee5da8610
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/using/cmdline.rst
View File

@ -936,8 +936,6 @@ conflict.
Also available as the :option:`-X` ``utf8`` option.
.. availability:: \*nix.
.. versionadded:: 3.7
See :pep:`540` for more details.

44
Doc/using/windows.rst
View File

@ -602,6 +602,50 @@ existed)::
C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.8
.. _win-utf8-mode:
UTF-8 mode
==========
.. versionadded:: 3.7
Windows still uses legacy encodings for the system encoding (the ANSI Code
Page). Python uses it for the default encoding of text files (e.g.
:func:`locale.getpreferredencoding`).
This may cause issues because UTF-8 is widely used on the internet
and most Unix systems, including WSL (Windows Subsystem for Linux).
You can use UTF-8 mode to change the default text encoding to UTF-8.
You can enable UTF-8 mode via the ``-X utf8`` command line option, or
the ``PYTHONUTF8=1`` environment variable. See :envvar:`PYTHONUTF8` for
enabling UTF-8 mode, and :ref:`setting-envvars` for how to modify
environment variables.
When UTF-8 mode is enabled:
* :func:`locale.getpreferredencoding` returns ``'UTF-8'`` instead of
the system encoding. This function is used for the default text
encoding in many places, including :func:`open`, :class:`Popen`,
:meth:`Path.read_text`, etc.
* :data:`sys.stdin`, :data:`sys.stdout`, and :data:`sys.stderr`
all use UTF-8 as their text encoding.
* You can still use the system encoding via the "mbcs" codec.
Note that adding ``PYTHONUTF8=1`` to the default environment variables
will affect all Python 3.7+ applications on your system.
If you have any Python 3.7+ applications which rely on the legacy
system encoding, it is recommended to set the environment variable
temporarily or use the ``-X utf8`` command line option.
.. note::
Even when UTF-8 mode is disabled, Python uses UTF-8 by default
on Windows for:
* Console I/O including standard I/O (see :pep:`528` for details).
* The filesystem encoding (see :pep:`529` for details).
.. _launcher:
Python Launcher for Windows