bpo-47000: Add `locale.getencoding()` by methane · Pull Request #32068 · python/cpython · GitHub

This API is a part of PEP 686.

https://bugs.python.org/issue47000

In some places, "utf-8" is used, in some other places "UTF-8" is used. I suggest to use lower case "utf-8" everywhere: doc, C code, _Py_STR(), etc. You may have to update getpreferredencoding() doc.

Co-authored-by: Victor Stinner <vstinner@python.org>

Suggested change

      
                  The function now always returns ``"UTF-8"`` on Android or if the
          
                  The function now always returns ``"utf-8"`` on Android or if the

I am sure that the upper case versus lower case is worth to be mentioned. But I'm fine with keeping if you consider that it's worth it.

I suggest to copy/paste this paragraph to getencoding() doc.

I like repeating "Python" to remind that it's unrelated to the Unix locale, but really something specific to Python which ignores the locale.

Suggested change

      
              ``locale.getpreferredencoding(False)`` but ignores :ref:`UTF-8 Mode <utf8-mode>`.
          
              ``locale.getpreferredencoding(False)`` but ignores the :ref:`Python UTF-8 Mode <utf8-mode>`.

You can copy/paste the Doc/whatsnew/3.11.rst entry entry.

IMO it would be helpful to mention here the Python UTF-8 Mode which ignores the locale encoding and always uses UTF-8. What do you think?

I don't think so. This paragraph doesn't describe where the locale encoding is used.
This paragraph describes what the locale encoding is.
With this pull request, locale encoding is locale encoding even in UTF-8 mode.

On the other hand, following this paragraph looks unnecessary:

      Python uses the :term:`filesystem encoding and error handler` to convert
      between Unicode filenames and bytes filenames.

I will replace it with See also :term:`filesystem encoding and error handler`.

LGTM. Thanks.

IMO it's important that the current is complete and explains well this function, since it's a complex topic. If the doc is unclear, people will misuse it.

Thanks for adding "See also the filesystem encoding and error handler" in the glossary, that's good!

I'm not sure why the PR is still a draft.

bedevere-bot added the awaiting core review label Mar 23, 2022

the-knights-who-say-ni added the CLA signed label Mar 23, 2022

methane force-pushed the locale-get-encoding branch from c99ef77 to 8fc120e Compare March 31, 2022 06:13

methane added 4 commits April 4, 2022 12:16

bpo-47000: Add locale.get_encoding()

cd4bccc

get_encoding() -> getencoding()

aaa8956

fix TextIOWrapper.__init__

104206a

get_encoding -> getencoding

8b50eb1

methane force-pushed the locale-get-encoding branch from 04fd5b0 to 8b50eb1 Compare April 4, 2022 03:16

methane changed the title bpo-47000: Add locale.get_encoding() bpo-47000: Add locale.getencoding() Apr 4, 2022

methane changed the title bpo-47000: Add locale.getencoding() bpo-47000: Add locale.getencoding() Apr 4, 2022

Use _Py_STR for "utf-8"

a0204c2

methane force-pushed the locale-get-encoding branch from ffc9ba1 to a0204c2 Compare April 4, 2022 04:58

methane added 2 commits April 6, 2022 11:54

Update the doc.

08413f1

Add news

f61b622

methane requested a review from vstinner April 6, 2022 03:27

vstinner reviewed Apr 6, 2022

View reviewed changes

Comment thread Doc/library/locale.rst Outdated

methane added 2 commits April 6, 2022 17:16

Apply proposed changes.

1c60e5b

Fix doc error.

7397493

vstinner reviewed Apr 6, 2022

View reviewed changes

methane and others added 2 commits April 7, 2022 12:39

Apply suggestions from code review

44730dd

Co-authored-by: Victor Stinner <vstinner@python.org>

UTF-8 -> utf-8

7720b10

methane force-pushed the locale-get-encoding branch from 39e99bc to 7720b10 Compare April 7, 2022 04:18

Fix test_utf8_mode

104008d

vstinner reviewed Apr 7, 2022

View reviewed changes

Update based on suggestions

a8e50bd

vstinner approved these changes Apr 8, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Apr 8, 2022

methane marked this pull request as ready for review April 9, 2022 00:54

methane merged commit 6773203 into python:main Apr 9, 2022

methane deleted the locale-get-encoding branch April 9, 2022 00:54

bedevere-bot removed the awaiting merge label Apr 9, 2022

methane mentioned this pull request Apr 10, 2022

Make encoding="locale" uses locale encoding even in UTF-8 mode is enabled. #91156

Closed

jopemachine mentioned this pull request Sep 9, 2022

Update locale lib, tests and Add locale.getencoding RustPython/RustPython#4155

Closed

                  .. versionchanged:: 3.7
-                    The function now always returns ``UTF-8`` on Android or if the
+                    The function now always returns ``"UTF-8"`` on Android or if the

	The function now always returns ``"UTF-8"`` on Android or if the
	The function now always returns ``"utf-8"`` on Android or if the

+                 .. versionchanged:: 3.11
+                    The function now returns ``"utf-8"`` instead of ``"UTF-8"`` on Android
+                    or if the :ref:`Python UTF-8 Mode <utf8-mode>` is enabled.

                  argument are ignored.
                  The :ref:`Python preinitialization <c-preinit>` configures the LC_CTYPE
                  locale. See also the :term:`filesystem encoding and error handler`.

	``locale.getpreferredencoding(False)`` but ignores :ref:`UTF-8 Mode <utf8-mode>`.
	``locale.getpreferredencoding(False)`` but ignores the :ref:`Python UTF-8 Mode <utf8-mode>`.

		@@ -0,0 +1 @@
		Add :func:`locale.getencoding`.

bpo-47000: Add `locale.getencoding()` by methane · Pull Request #32068 · python/cpython · GitHub

Uh oh!

Uh oh!

bpo-47000: Add locale.getencoding() - #32068

bpo-47000: Add locale.getencoding()#32068methane merged 13 commits intopython:mainpython/cpython:mainfrom methane:locale-get-encodingmethane/cpython:locale-get-encodingCopy head branch name to clipboard

Conversation

methane commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner Apr 7, 2022

Choose a reason for hiding this comment

Uh oh!

methane Apr 8, 2022

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bpo-47000: Add locale.getencoding()#32068
methane merged 13 commits into
python:mainfrom
methane:locale-get-encoding

methane commented Mar 23, 2022 •
edited
Loading