Skip to content

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

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
methane merged 13 commits into from
Apr 9, 2022
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
cd4bccc
bpo-47000: Add locale.get_encoding()
methane Mar 20, 2022
aaa8956
get_encoding() -> getencoding()
methane Mar 31, 2022
104206a
fix TextIOWrapper.__init__
methane Mar 31, 2022
8b50eb1
get_encoding -> getencoding
methane Mar 31, 2022
a0204c2
Use _Py_STR for "utf-8"
methane Apr 4, 2022
08413f1
Update the doc.
methane Apr 6, 2022
f61b622
Add news
methane Apr 6, 2022
1c60e5b
Apply proposed changes.
methane Apr 6, 2022
7397493
Fix doc error.
methane Apr 6, 2022
44730dd
Apply suggestions from code review
methane Apr 7, 2022
7720b10
UTF-8 -> utf-8
methane Apr 7, 2022
104008d
Fix test_utf8_mode
methane Apr 7, 2022
a8e50bd
Update based on suggestions
methane Apr 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply proposed changes.
  • Loading branch information
@methane
methane committed Apr 6, 2022
commit 1c60e5b6bfae00a47fd1eb63581a49aacb7a7953
5 changes: 3 additions & 2 deletions Doc/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,8 +710,9 @@ Glossary

Comment thread
methane marked this conversation as resolved.
On Windows, it is the ANSI code page (ex: ``cp1252``).
Comment thread
methane marked this conversation as resolved.
Outdated

``locale.getpreferredencoding(False)`` can be used to get the locale
encoding.
On Android and VxWorks, return ``"UTF-8"``.
Comment thread
methane marked this conversation as resolved.
Outdated

``locale.getencoding()`` can be used to get the locale encoding.
Comment thread
methane marked this conversation as resolved.

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

@vstinner vstinner Apr 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Member Author

@methane methane Apr 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`.

Expand Down
9 changes: 6 additions & 3 deletions Doc/library/locale.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,13 @@ The :mod:`locale` module defines the following exception and functions:

.. function:: getencoding()

Returns the :term:`locale encoding`.
Get the current :term:`locale encoding`:

On Android, it always returns ``"UTF-8"``, the :term:`locale encoding` is
ignored.
* On Android and VxWorks, return ``"UTF-8"``.
* On Unix, return the encoding of the current :data:`LC_CTYPE` locale.
Return ``"UTF-8"`` if :ref:`nl_langinfo(CODESET) <nl_langinfo>`
returns an empty string: for example, if the current LC_CTYPE locale is not supported.
* On Windows, return the ANSI code page.

This function is same to ``getpreferredencoding(False)`` except this
Comment thread
methane marked this conversation as resolved.
Outdated
function ignore the :ref:`UTF-8 Mode <utf8-mode>`.
Comment thread
methane marked this conversation as resolved.
Outdated
Expand Down