Skip to content

Commit

Permalink
gh-90301: Doc: Add references to PEP 686 (GH-96816)
Browse files Browse the repository at this point in the history
Doc: Add references to PEP 686.
(cherry picked from commit 87679a6)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
  • Loading branch information
miss-islington and methane authored Oct 4, 2022
1 parent 87a9e0f commit cad4dca
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
16 changes: 9 additions & 7 deletions Doc/library/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,19 @@ encoding is not UTF-8 for most Windows users. For example::
with open("README.md") as f:
long_description = f.read()

Additionally, while there is no concrete plan as of yet, Python may change
the default text file encoding to UTF-8 in the future.

Accordingly, it is highly recommended that you specify the encoding
explicitly when opening text files. If you want to use UTF-8, pass
``encoding="utf-8"``. To use the current locale encoding,
``encoding="locale"`` is supported in Python 3.10.
``encoding="locale"`` is supported since Python 3.10.

.. seealso::

:ref:`utf8-mode`
Python UTF-8 Mode can be used to change the default encoding to
UTF-8 from locale-specific encoding.

When you need to run existing code on Windows that attempts to open
UTF-8 files using the default locale encoding, you can enable the UTF-8
mode. See :ref:`UTF-8 mode on Windows <win-utf8-mode>`.
:pep:`686`
Python 3.15 will make :ref:`utf8-mode` default.

.. _io-encoding-warning:

Expand Down
5 changes: 5 additions & 0 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,11 @@ can be read from :data:`sys.flags.utf8_mode <sys.flags>`.
See also the :ref:`UTF-8 mode on Windows <win-utf8-mode>`
and the :term:`filesystem encoding and error handler`.

.. seealso::

:pep:`686`
Python 3.15 will make :ref:`utf8-mode` default.


.. _os-procinfo:

Expand Down

0 comments on commit cad4dca

Please sign in to comment.