Tryag File Manager - Edit By Mr.SaHr

//usr/share/doc/python-babel-0.9.6/doc/api/babel.numbers-module.html

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
 <title>babel.numbers</title>
 <link rel="stylesheet" href="epydoc.css" type="text/css" />
 <script type="text/javascript" src="epydoc.js"></script>
</head>

<th>&nbsp;&nbsp;&nbsp;<a
 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

<th class="navbar" align="right" width="100%">
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><th class="navbar" align="center"
 ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 </tr></table></th>
 </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
 <tr valign="top">
 <td width="100%">
 
 <a href="babel-module.html">Package&nbsp;babel</a> ::
 Module&nbsp;numbers
 
 </td>
 <td>
 <table cellpadding="0" cellspacing="0">
 
 </table>
 </td>
 </tr>
</table>

<h1 class="epydoc">Module numbers</h1>
Locale dependent formatting and parsing of numeric data.
The default locale for the functions in this module is determined by the
following environment variables, in that order:
<blockquote>
<ul class="rst-simple">
<li><tt class="rst-docutils literal">LC_NUMERIC</tt>,</li>
<li><tt class="rst-docutils literal">LC_ALL</tt>, and</li>
<li><tt class="rst-docutils literal">LANG</tt></li>
</ul>
</blockquote>

<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Classes</td>
</tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a href="babel.numbers.NumberFormatError-class.html" class="summary-name">NumberFormatError</a> 
 Exception raised when a string cannot be parsed into a number.
 </td>
 </tr>
</table>

<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Functions</td>
</tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#format_number" class="summary-sig-name">format_number</a>(number,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Return the given number formatted for a specific locale.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#format_decimal" class="summary-sig-name">format_decimal</a>(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Return the given decimal number formatted for a specific locale.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#format_currency" class="summary-sig-name">format_currency</a>(number,
 currency,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Return formatted currency value.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#format_percent" class="summary-sig-name">format_percent</a>(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Return formatted percent value for a specific locale.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#format_scientific" class="summary-sig-name">format_scientific</a>(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Return value formatted in scientific notation for a specific locale.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">long</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#parse_number" class="summary-sig-name">parse_number</a>(string,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Parse localized number string into a long integer.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">float</code>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.numbers-module.html#parse_decimal" class="summary-sig-name">parse_decimal</a>(string,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>) 
 Parse localized decimal string into a float.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
</table>

<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Function Details</td>
</tr>
</table>
<a name="format_number"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">format_number(number,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return the given number formatted for a specific locale.
<pre class="py-doctest">
&gt;&gt;&gt; format_number(1099, locale='en_US')
u'1,099'</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>number</code> - the number to format</li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">unicode</code></dt>
 <dd>the formatted number</dd>
 </dl>
</td></tr></table>
</div>
<a name="format_decimal"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">format_decimal(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return the given decimal number formatted for a specific locale.
<pre class="py-doctest">
&gt;&gt;&gt; format_decimal(1.2345, locale='en_US')
u'1.234'
&gt;&gt;&gt; format_decimal(1.2346, locale='en_US')
u'1.235'
&gt;&gt;&gt; format_decimal(-1.2346, locale='en_US')
u'-1.235'
&gt;&gt;&gt; format_decimal(1.2345, locale='sv_SE')
u'1,234'
&gt;&gt;&gt; format_decimal(12345, locale='de')
u'12.345'</pre>
The appropriate thousands grouping and the decimal separator are used for
each locale:
<pre class="py-doctest">
&gt;&gt;&gt; format_decimal(12345.5, locale='en_US')
u'12,345.5'</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>number</code> - the number to format</li>
 <li><code>format</code></li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">unicode</code></dt>
 <dd>the formatted decimal number</dd>
 </dl>
</td></tr></table>
</div>
<a name="format_currency"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">format_currency(number,
 currency,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return formatted currency value.
<pre class="py-doctest">
&gt;&gt;&gt; format_currency(1099.98, 'USD', locale='en_US')
u'$1,099.98'
&gt;&gt;&gt; format_currency(1099.98, 'USD', locale='es_CO')
u'US$\xa01.099,98'
&gt;&gt;&gt; format_currency(1099.98, 'EUR', locale='de_DE')
u'1.099,98\xa0\u20ac'</pre>
The pattern can also be specified explicitly:
<pre class="py-doctest">
&gt;&gt;&gt; format_currency(1099.98, 'EUR', u'&#164;&#164; #,##0.00', locale='en_US')
u'EUR 1,099.98'</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>number</code> - the number to format</li>
 <li><code>currency</code> - the currency code</li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">unicode</code></dt>
 <dd>the formatted currency value</dd>
 </dl>
</td></tr></table>
</div>
<a name="format_percent"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">format_percent(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return formatted percent value for a specific locale.
<pre class="py-doctest">
&gt;&gt;&gt; format_percent(0.34, locale='en_US')
u'34%'
&gt;&gt;&gt; format_percent(25.1234, locale='en_US')
u'2,512%'
&gt;&gt;&gt; format_percent(25.1234, locale='sv_SE')
u'2\xa0512\xa0%'</pre>
The format pattern can also be specified explicitly:
<pre class="py-doctest">
&gt;&gt;&gt; format_percent(25.1234, u'#,##0\u2030', locale='en_US')
u'25,123\u2030'</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>number</code> - the percent number to format</li>
 <li><code>format</code></li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">unicode</code></dt>
 <dd>the formatted percent number</dd>
 </dl>
</td></tr></table>
</div>
<a name="format_scientific"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">format_scientific(number,
 format=None,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return value formatted in scientific notation for a specific locale.
<pre class="py-doctest">
&gt;&gt;&gt; format_scientific(10000, locale='en_US')
u'1E4'</pre>
The format pattern can also be specified explicitly:
<pre class="py-doctest">
&gt;&gt;&gt; format_scientific(1234567, u'##0E00', locale='en_US')
u'1.23E06'</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>number</code> - the number to format</li>
 <li><code>format</code></li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">unicode</code></dt>
 <dd>value formatted in scientific notation.</dd>
 </dl>
</td></tr></table>
</div>
<a name="parse_number"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">parse_number(string,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Parse localized number string into a long integer.
<pre class="py-doctest">
&gt;&gt;&gt; parse_number('1,099', locale='en_US')
1099L
&gt;&gt;&gt; parse_number('1.099', locale='de_DE')
1099L</pre>
When the given string cannot be parsed, an exception is raised:
<pre class="py-doctest">
&gt;&gt;&gt; parse_number('1.099,98', locale='de')
Traceback (most recent call last):
 ...
NumberFormatError: '1.099,98' is not a valid number</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>string</code> - the string to parse</li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">long</code></dt>
 <dd>the parsed number</dd>
 <dt>Raises:</dt>
 <dd><ul class="nomargin-top">
 <li><code><a href="babel.numbers.NumberFormatError-class.html">NumberFormatError</a></code> - if the string can not be converted to a number</li>
 </ul></dd>
 </dl>
</td></tr></table>
</div>
<a name="parse_decimal"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">parse_decimal(string,
 locale=<code class="variable-quote">'</code><code class="variable-string">de_DE</code><code class="variable-quote">'</code>)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Parse localized decimal string into a float.
<pre class="py-doctest">
&gt;&gt;&gt; parse_decimal('1,099.98', locale='en_US')
1099.98
&gt;&gt;&gt; parse_decimal('1.099,98', locale='de')
1099.98</pre>
When the given string cannot be parsed, an exception is raised:
<pre class="py-doctest">
&gt;&gt;&gt; parse_decimal('2,109,998', locale='de')
Traceback (most recent call last):
 ...
NumberFormatError: '2,109,998' is not a valid decimal number</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>string</code> - the string to parse</li>
 <li><code>locale</code> - the <a href="babel.core.Locale-class.html" class="link">Locale</a> object or locale identifier</li>
 </ul></dd>
 <dt>Returns: <code class="link">float</code></dt>
 <dd>the parsed decimal number</dd>
 <dt>Raises:</dt>
 <dd><ul class="nomargin-top">
 <li><code><a href="babel.numbers.NumberFormatError-class.html">NumberFormatError</a></code> - if the string can not be converted to a
decimal number</li>
 </ul></dd>
 </dl>
</td></tr></table>
</div>
 

<table class="navbar" border="0" width="100%" cellpadding="0"
 bgcolor="#a0c0ff" cellspacing="0">
 <tr valign="middle">
 
 <th>&nbsp;&nbsp;&nbsp;<a
 href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>