8000 bpo-10379: deprecate locale.format in lieu of locale.format_string by plusminushalf · Pull Request #259 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-10379: deprecate locale.format in lieu of locale.format_string #259

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
merged 13 commits into from
Mar 28, 2017
Merged

bpo-10379: deprecate locale.format in lieu of locale.format_string #259

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d0f9863
bpo-10379: deprecate locale.format in lue of locale.format_string
plusminushalf Feb 23, 2017
820e289
Adding tests and documentation changes
plusminushalf Feb 24, 2017
4cfd737
Adding version changed info for locale.format
plusminushalf Feb 24, 2017
a08419f
Deprecating but not changing the function defination
plusminushalf Feb 24, 2017
4e24a3f
Adding documentation inside what's new in 3.7
plusminushalf Feb 25, 2017
6097e47
Adding whatsnew documentation in proper segments
plusminushalf Feb 27, 2017
04577c2
Merge branch 'master' of github.com:python/cpython into fix-bpo-10379
plusminushalf Feb 27, 2017
2039406
fixing documentation bug
plusminushalf Feb 27, 2017
5b100b8
Adding locale subsection
plusminushalf Feb 27, 2017
041349f
Merge branch 'master' of github.com:python/cpython into fix-bpo-10379
plusminushalf Mar 15, 2017
795aa65
Refactoring Doc, using _format inisde locale module
plusminushalf Mar 19, 2017
8190fa9
Adding entry to Misc/NEWS about changes
plusminushalf Mar 28, 2017
7e0bfcf
CR fixes
plusminushalf Mar 28, 2017
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
16 changes: 15 additions & 1 deletion Doc/library/locale.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,9 @@ The :mod:`locale` module defines the following exception and functions:

.. function:: format(format, val, grouping=False, monetary=False)

.. deprecated:: 3.7
Use `format_string` instead

Formats a number *val* according to the current :const:`LC_NUMERIC` setting.
The format follows the conventions of the ``%`` operator. For floating point
values, the decimal point is modified if appropriate. If *grouping* is true,
Expand All @@ -366,11 +369,22 @@ The :mod:`locale` module defines the following exception and functions:
For whole format strings, use :func:`format_string`.


.. function:: format_string(format, val, grouping=False)
.. function:: format_string(format, val, grouping=False, monetary=False)

Formats a number *val* according to the current :const:`LC_NUMERIC` setting.
The format follows the conventions of the ``%`` operator. For floating point
values, the decimal point is modified if appropriate. If *grouping* is true,
also takes the grouping into account.

If *monetary* is true, the conversion uses monetary thousands separator and
grouping strings.

Processes formatting specifiers as in ``format % val``, but takes the current
locale settings into account.

.. versionchanged:: 3.7
The *monetary* keyword parameter was added.


Copy link
Member

Choose a reason for hiding this comment

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

The description of the monetary parameter should be added to the regular docs, and the version changed phrase should just say "the monetary keyword parameter was added"

.. function:: currency(val, symbol=True, grouping=False, international=False)

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ New Modules
Improved Modules
================

* Added another argument *monetary* in :meth:`format_string` of :mod:`locale`.
Copy link
Member

Choose a reason for hiding this comment

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

There should be a subsection header before this line for the locale module (the modules with enhancements are listed in this section in alphabetical order).

(Contributed by Garvit in :issue:`10379`.)


unittest.mock
-------------

Expand Down Expand Up @@ -140,6 +144,9 @@ Deprecated
``0x03050400`` and ``0x03060000`` (not including) or ``0x03060100`` or
higher. (Contributed by Serhiy Storchaka in :issue:`27867`.)

- Deprecated :meth:`format` from :mod:`locale`, use the :meth:`format_string`
instead. (Contributed by Garvit in :issue:`10379`.)


Removed
=======
Expand Down
28 changes: 16 additions & 12 deletions Lib/locale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import collections
from builtins import str as _builtin_str
import functools
import warnings

# Try importing the _locale module.
#
Expand Down Expand Up @@ -181,12 +182,13 @@ def _strip_padding(s, amount):
r'(?P<modifiers>[-#0-9 +*.hlL]*?)[eEfFgGdiouxXcrs%]')

def format(percent, value, grouping=False, monetary=False, *additional):
"""Returns the locale-aware substitution of a %? specifier
(percent).
"""Deprecated, use format_string instead."""
warnings.warn(
"This method will be removed in future versions. "
"Use 'locale.format_string()' instead.",
Copy link
Member

Choose a reason for hiding this comment

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

I think this should read "This method will be removed in a future version of Python."

DeprecationWarning, stacklevel=2
)

additional is for format strings which contain one or more
'*' modifiers."""
# this is only for one-percent-specifier strings and this should be checked
match = _percent_re.match(percent)
if not match or len(match.group())!= len(percent):
raise ValueError(("format() must be given exactly one %%char "
Expand Down Expand Up @@ -217,10 +219,12 @@ def _format(percent, value, grouping=False, monetary=False, *additional):
formatted = _strip_padding(formatted, seps)
return formatted

def format_string(f, val, grouping=False):
def format_string(f, val, grouping=False, monetary=False):
"""Formats a string in the same way that the % formatting would use,
but takes the current locale into account.
Grouping is applied if the third parameter is true."""
Grouping is applied if the third parameter is true.
Copy link
Member

Choose a reason for hiding this comment

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

As long as we are editing this, I think there should be a blank line after the first sentence, before the 'Grouping' sentence.

Conversion uses monetary thousands separator and grouping strings if
forth parameter monetary is true."""
percents = list(_percent_re.finditer(f))
new_f = _percent_re.sub('%s', f)

Expand All @@ -230,7 +234,7 @@ def format_string(f, val, grouping=False):
if perc.group()[-1]=='%':
new_val.append('%')
else:
new_val.append(format(perc.group(), val, grouping))
new_val.append(_format(perc.group(), val, grouping, monetary))
else:
if not isinstance(val, tuple):
val = (val,)
Expand All @@ -244,7 +248,7 @@ def format_string(f, val, grouping=False):
new_val.append(_format(perc.group(),
val[i],
grouping,
False,
monetary,
*val[i+1:i+1+starcount]))
i += (1 + starcount)
val = tuple(new_val)
Expand All @@ -262,7 +266,7 @@ def currency(val, symbol=True, grouping=False, international=False):
raise ValueError("Currency formatting is not possible using "
"the 'C' locale.")

s = format('%%.%if' % digits, abs(val), grouping, monetary=True)
s = format_string('%%.%if' % digits, abs(val), grouping, monetary=True)
Copy link
Member

Choose a reason for hiding this comment

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

Since we know there's only one format string here, I think this should be a call to _format.

# '<' and '>' are markers if the sign must be inserted between symbol and value
s = '<' + s + '>'

Expand Down Expand Up @@ -298,7 +302,7 @@ def currency(val, symbol=True, grouping=False, international=False):

def str(val):
"""Convert float to string, taking the locale into account."""
return format("%.12g", val)
return format_string("%.12g", val)
Copy link
Member

Choose a reason for hiding this comment

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

As above, I think this should be _format.


def delocalize(string):
"Parses a string as a normalized number according to the locale settings."
Expand Down Expand Up @@ -327,7 +331,7 @@ def atoi(string):
def _test():
setlocale(LC_ALL, "")
#do grouping
s1 = format("%d", 123456789,1)
s1 = format_string("%d", 123456789,1)
print(s1, "is", atoi(s1))
#standard formatting
s1 = str(3.14)
Expand Down
5 changes: 5 additions & 0 deletions Lib/test/test_locale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import locale
import sys
import codecs
import warnings

class BaseLocalizedTest(unittest.TestCase):
#
Expand Down Expand Up @@ -197,6 +198,10 @@ def test_padding(self):
self._test_format("%+10.f", -4200, grouping=0, out='-4200'.rjust(10))
self._test_format("%-10.f", 4200, grouping=0, out='4200'.ljust(10))

def test_format_deprecation(self):
with self.assertWarns(DeprecationWarning):
locale.format("%-10.f", 4200, grouping=True)

def test_complex_formatting(self):
# Spaces in formatting string
self._test_format_string("One million is %i", 1000000, grouping=1,
Expand Down
6 changes: 3 additions & 3 deletions Lib/test/test_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,16 +381,16 @@ def test_float__format__locale(self):

for i in range(-10, 10):
x = 1234567890.0 * (10.0 ** i)
self.assertEqual(locale.format('%g', x, grouping=True), format(x, 'n'))
self.assertEqual(locale.format('%.10g', x, grouping=True), format(x, '.10n'))
self.assertEqual(locale.format_string('%g', x, grouping=True), format(x, 'n'))
self.assertEqual(locale.format_string('%.10g', x, grouping=True), format(x, '.10n'))

@run_with_locale('LC_NUMERIC', 'en_US.UTF8')
def test_int__format__locale(self):
# test locale support for __format__ code 'n' for integers

x = 123456789012345678901234567890
for i in range(0, 30):
self.assertEqual(locale.format('%d', x, grouping=True), format(x, 'n'))
self.assertEqual(locale.format_string('%d', x, grouping=True), format(x, 'n'))

# move to the next integer to test
x = x // 10
Expand Down
0