bpo-33409: Clarify PEP 538/540 relationship (GH-7534) · pythoncapi/cpython@1bcb8a6 · GitHub
Skip to content

Commit 1bcb8a6

Browse files
authored
bpo-33409: Clarify PEP 538/540 relationship (pythonGH-7534)
While locale coercion and UTF-8 mode turned out to be complementary ideas rather than competing ones, it isn't immediately obvious why it's useful to have both, or how they interact at runtime. This updates both the Python 3.7 What's New doc and the PYTHONCOERCECLOCALE and PYTHONUTF8 documentation in an attempt to clarify that relationship: - in the respective What's New sections, add a closing paragraph explaining which problem each one solves, and pointing to the other PEP's section for the specific aspects it relies on the other PEP to solve - use "locale-aware mode" as a more descriptive term for the default non-UTF-8 mode - improve wording conistenccy between the PYTHONCOERCECLOCALE and PYTHONUTF8 docs when they cover the same thing (mostly related to legacy locale detection and setting the standard stream error handler) - improve the description of the locale coercion trigger conditions (including pointing out that setting LC_ALL turns off locale coercion) - port the full description of the UTF-8 mode behaviour changes from PEP 540 into the PYTHONUTF8 documentation - be explicit that PYTHONIOENCODING still overrides the settings for the standard streams - mention concrete examples of things that do and don't get their text encoding assumptions adjusted by the two text encoding assumption override techniques
1 parent 4acc140 commit 1bcb8a6

3 files changed

Lines changed: 106 additions & 24 deletions

File tree

Doc/using/cmdline.rst

Lines changed: 79 additions & 18 deletions

Doc/whatsnew/3.7.rst

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,10 @@ Significant improvements in the standard library:
9797

9898
CPython implementation improvements:
9999

100+
* Avoiding the use of ASCII as a default text encoding:
101+
* :ref:`PEP 538 <whatsnew37-pep538>`, legacy C locale coercion
102+
* :ref:`PEP 540 <whatsnew37-pep540>`, forced UTF-8 runtime mode
100103
* :ref:`PEP 552 <whatsnew37-pep552>`, deterministic .pycs
101-
* :ref:`PEP 538 <whatsnew37-pep538>`, legacy C locale coercion
102-
* :ref:`PEP 540 <whatsnew37-pep540>`, forced UTF-8 runtime mode
103104
* :ref:`the new development runtime mode <whatsnew37-devmode>`
104105
* :ref:`PEP 565 <whatsnew37-pep565>`, improved :exc:`DeprecationWarning`
105106
handling
@@ -184,7 +185,8 @@ PEP 538: Legacy C Locale Coercion
184185

185186
An ongoing challenge within the Python 3 series has been determining a sensible
186187
default strategy for handling the "7-bit ASCII" text encoding assumption
187-
currently implied by the use of the default C locale on non-Windows platforms.
188+
currently implied by the use of the default C or POSIX locale on non-Windows
189+
platforms.
188190

189191
:pep:`538` updates the default interpreter command line interface to
190192
automatically coerce that locale to an available UTF-8 based locale as
@@ -205,10 +207,18 @@ continues to be ``backslashreplace``, regardless of locale.
205207

206208
Locale coercion is silent by default, but to assist in debugging potentially
207209
locale related integration problems, explicit warnings (emitted directly on
208-
:data:`~sys.stderr` can be requested by setting ``PYTHONCOERCECLOCALE=warn``.
210+
:data:`~sys.stderr`) can be requested by setting ``PYTHONCOERCECLOCALE=warn``.
209211
This setting will also cause the Python runtime to emit a warning if the
210212
legacy C locale remains active when the core interpreter is initialized.
211213

214+
While :pep:`538`'s locale coercion has the benefit of also affecting extension
215+
modules (such as GNU ``readline``), as well as child processes (including those
216+
running non-Python applications and older versions of Python), it has the
217+
downside of requiring that a suitable target locale be present on the running
218+
system. To better handle the case where no suitable target locale is available
219+
(as occurs on RHEL/CentOS 7, for example), Python 3.7 also implements
220+
:ref:`whatsnew37-pep540`.
221+
212222
.. seealso::
213223

214224
:pep:`538` -- Coercing the legacy C locale to a UTF-8 based locale
@@ -231,8 +241,17 @@ The forced UTF-8 mode can be used to change the text handling behavior in
231241
an embedded Python interpreter without changing the locale settings of
232242
an embedding application.
233243

234-
The UTF-8 mode is enabled by default when the locale is "C". See
235-
:ref:`whatsnew37-pep538` for details.
244+
While :pep:`540`'s UTF-8 mode has the benefit of working regardless of which
245+
locales are available on the running system, it has the downside of having no
246+
effect on extension modules (such as GNU ``readline``), child processes running
247+
non-Python applications, and child processes running older versions of Python.
248+
To reduce the risk of corrupting text data when communicating with such
249+
components, Python 3.7 also implements :ref:`whatsnew37-pep540`).
250+
251+
The UTF-8 mode is enabled by default when the locale is ``C`` or ``POSIX``, and
252+
the :pep:`538` locale coercion feature fails to change it to a UTF-8 based
253+
alternative (whether that failure is due to ``PYTHONCOERCECLOCALE=0`` being set,
254+
``LC_ALL`` being set, or the lack of a suitable target locale).
236255

237256
.. seealso::
238257

Lines changed: 2 additions & 0 deletions

0 commit comments

Comments
 (0)