Skip to content

bpo-46659: Deprecate locale.getdefaultlocale() #31206

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
vstinner merged 1 commit into from
Feb 22, 2022
Merged

bpo-46659: Deprecate locale.getdefaultlocale() #31206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions Doc/library/locale.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,8 @@ The :mod:`locale` module defines the following exception and functions:
*language code* and *encoding* may be ``None`` if their values cannot be
determined.

.. deprecated:: 3.11 3.13


.. function:: getlocale(category=LC_CTYPE)

Expand Down
6 changes: 6 additions & 0 deletions Doc/whatsnew/3.11.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,12 @@ Deprecated

(Contributed by Hugo van Kemenade in :issue:`45173`.)

* The :func:`locale.getdefaultlocale` function is deprecated and will be
removed in Python 3.13. Use :func:`locale.setlocale`,
:func:`locale.getpreferredencoding(False) <locale.getpreferredencoding>` and
:func:`locale.getlocale` functions instead.
(Contributed by Victor Stinner in :issue:`46659`.)


Removed
=======
Expand Down
6 changes: 6 additions & 0 deletions Lib/locale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,12 @@ def getdefaultlocale(envvars=('LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE')):

"""

import warnings
warnings.warn(
"Use setlocale(), getpreferredencoding(False) and getlocale() instead",
DeprecationWarning, stacklevel=2
)

try:
# check if it's supported by the _locale module
import _locale
Expand Down
3 changes: 2 additions & 1 deletion Lib/test/test_locale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,8 @@ def test_defaults_UTF8(self):

os.environ['LC_CTYPE'] = 'UTF-8'

self.assertEqual(locale.getdefaultlocale(), (None, 'UTF-8'))
with check_warnings(('', DeprecationWarning)):
self.assertEqual(locale.getdefaultlocale(), (None, 'UTF-8'))

finally:
for k in orig_env:
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2022-02-06-17-57-45.bpo-46659.zTmkoQ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The :func:`locale.getdefaultlocale` function is deprecated and will be removed
in Python 3.13. Use :func:`locale.setlocale`,
:func:`locale.getpreferredencoding(False) <locale.getpreferredencoding>` and
:func:`locale.getlocale` functions instead. Patch by Victor Stinner.