openstack/oslo.i18n
Code Issues Proposed changes

The locale.getdefaultlocale is deprecated

Browse Source 
This patch is prompted by the following deprecation warning:

DeprecationWarning: Use setlocale(), getencoding() and getlocale() instead

But getdefaultlocale() is scheduled to be removed in Python
3.13, so we need to act anyway.

We use LC_CTYPE as the most compatible setting. Probablly what
we really want for translations is LANG, but that is not a
valid argument for getlocale(). Fortunately, LC_CTYPE is set
when the environment variable LANG is set, so this works for us.

Change-Id: I07bdbaf95108aa4fdb4c645c12b196dcb820059b
This commit is contained in:
Pete Zaitcev 2023-02-14 22:23:15 -06:00
parent 03605c2db7
commit 77a994a993
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
oslo_i18n/_message.py
View File

@ -98,7 +98,7 @@ class Message(str):
def _translate_msgid(msgid, domain, desired_locale=None,
has_contextual_form=False, has_plural_form=False):
if not desired_locale:
system_locale = locale.getdefaultlocale()
system_locale = locale.getlocale(locale.LC_CTYPE)
# If the system locale is not available to the runtime use English
if not system_locale or not system_locale[0]:
desired_locale = 'en_US'

18
oslo_i18n/tests/test_message.py
View File

@ -43,11 +43,11 @@ class MessageTestCase(test_base.BaseTestCase):
message = _message.Message('some %s') % 'message'
self.assertIsInstance(message, str)
@mock.patch('locale.getdefaultlocale')
@mock.patch('locale.getlocale')
@mock.patch('gettext.translation')
def test_create_message_non_english_default_locale(self,
mock_translation,
mock_getdefaultlocale):
mock_locale):
msgid = 'A message in English'
es_translation = 'A message in Spanish'
@ -55,7 +55,7 @@ class MessageTestCase(test_base.BaseTestCase):
translations_map = {'es': es_translations}
translator = fakes.FakeTranslations.translator(translations_map)
mock_translation.side_effect = translator
mock_getdefaultlocale.return_value = ('es',)
mock_locale.return_value = ('es',)
message = _message.Message(msgid)
@ -404,11 +404,11 @@ class MessageTestCase(test_base.BaseTestCase):
mock.ANY)
@mock.patch('gettext.translation')
@mock.patch('locale.getdefaultlocale', return_value=('es', ''))
@mock.patch('locale.getlocale', return_value=('es', ''))
@mock.patch('oslo_i18n._message.LOG')
def test_translate_message_bad_default_translation(self,
mock_log,
mock_local,
mock_locale,
mock_translation):
message_with_params = 'A message: %s'
es_translation = 'A message in Spanish: %s %s'
@ -564,11 +564,11 @@ class MessageTestCase(test_base.BaseTestCase):
self.assertEqual(expected_translation, msg.translation('es'))
self.assertEqual(default_translation, msg.translation('XX'))
@mock.patch('locale.getdefaultlocale')
@mock.patch('locale.getlocale')
@mock.patch('gettext.translation')
def test_translate_message_non_default_locale(self,
mock_translation,
mock_getdefaultlocale):
mock_locale):
message_with_params = 'A message with params: %(param)s'
es_translation = 'A message with params in Spanish: %(param)s'
zh_translation = 'A message with params in Chinese: %(param)s'
@ -590,7 +590,7 @@ class MessageTestCase(test_base.BaseTestCase):
'zh': zh_translations,
'fr': fr_translations})
mock_translation.side_effect = translator
mock_getdefaultlocale.return_value = ('es',)
mock_locale.return_value = ('es',)
msg = _message.Message(message_with_params)
msg_param = _message.Message(message_param)
@ -600,7 +600,7 @@ class MessageTestCase(test_base.BaseTestCase):
zh_translation = zh_translation % {'param': zh_param_translation}
fr_translation = fr_translation % {'param': fr_param_translation}
# Because sys.getdefaultlocale() was Spanish,
# Because sys.getlocale() was Spanish,
# the default translation will be to Spanish
self.assertEqual(es_translation, msg)
self.assertEqual(es_translation, msg.translation())