From: Aarni Koskela <akx@iki.fi>
Date: Mon, 7 May 2018 10:01:25 +0000 (+0300)
Subject: Restore force_frac to NumberPattern.apply(), as deprecated
X-Git-Tag: v2.6.0~6^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F577%2Fhead;p=thirdparty%2Fbabel.git

Restore force_frac to NumberPattern.apply(), as deprecated

This retains backwards compatibility (at least as far as the function's
signature is concerned) with users that are using NumberPattern.apply()
directly.

See: https://github.com/python-babel/babel/issues/550
See: https://github.com/python-babel/babel/issues/569
---

diff --git a/babel/numbers.py b/babel/numbers.py
index cbd14747..a3a93a66 100644
--- a/babel/numbers.py
+++ b/babel/numbers.py
@@ -767,12 +767,38 @@ class NumberPattern(object):
         return value, exp, exp_sign
 
     def apply(
-            self, value, locale, currency=None, currency_digits=True,
-            decimal_quantization=True):
+        self,
+        value,
+        locale,
+        currency=None,
+        currency_digits=True,
+        decimal_quantization=True,
+        force_frac=None,
+    ):
         """Renders into a string a number following the defined pattern.
 
         Forced decimal quantization is active by default so we'll produce a
         number string that is strictly following CLDR pattern definitions.
+
+        :param value: The value to format. If this is not a Decimal object,
+                      it will be cast to one.
+        :type value: decimal.Decimal|float|int
+        :param locale: The locale to use for formatting.
+        :type locale: str|babel.core.Locale
+        :param currency: Which currency, if any, to format as.
+        :type currency: str|None
+        :param currency_digits: Whether or not to use the currency's precision.
+                                If false, the pattern's precision is used.
+        :type currency_digits: bool
+        :param decimal_quantization: Whether decimal numbers should be forcibly
+                                     quantized to produce a formatted output
+                                     strictly matching the CLDR definition for
+                                     the locale.
+        :type decimal_quantization: bool
+        :param force_frac: DEPRECATED - a forced override for `self.frac_prec`
+                           for a single formatting invocation.
+        :return: Formatted decimal string.
+        :rtype: str
         """
         if not isinstance(value, decimal.Decimal):
             value = decimal.Decimal(str(value))
@@ -789,9 +815,14 @@ class NumberPattern(object):
 
         # Adjust the precision of the fractionnal part and force it to the
         # currency's if neccessary.
-        frac_prec = self.frac_prec
-        if currency and currency_digits:
+        if force_frac:
+            # TODO (3.x?): Remove this parameter
+            warnings.warn('The force_frac parameter to NumberPattern.apply() is deprecated.', DeprecationWarning)
+            frac_prec = force_frac
+        elif currency and currency_digits:
             frac_prec = (get_currency_precision(currency), ) * 2
+        else:
+            frac_prec = self.frac_prec
 
         # Bump decimal precision to the natural precision of the number if it
         # exceeds the one we're about to use. This adaptative precision is only