Latest Version: 0.9.6.2

number

Number Helpers

Provides methods for converting numbers into formatted strings. Functions are provided for phone numbers, currencies, percentages, precision, positional notation, and file size.


Functions

f human_size(*args, **kwargs) ...

Deprecated: Use number_to_human_size instead.

f number_to_currency(number, unit='$', precision=2, separator='.', delimiter=',') ...

Formats a number into a currency string.

precision
Indicates the level of precision. Defaults to 2
unit
Sets the currency type, defaults to "$"
separator
Used to set what the unit separation should be. Defaults to "."
delimiter
The delimiter character to use, defaults to ","

Examples:

>>> number_to_currency(1234567890.50)
'$1,234,567,890.50'
>>> number_to_currency(1234567890.506)
'$1,234,567,890.51'
>>> number_to_currency(1234567890.50, unit="£", separator=",", delimiter="")
'£1234567890,50'

f number_to_human_size(size, precision=1) ...

Returns a formatted-for-humans file size.

precision
The level of precision, defaults to 1

Examples:

>>> number_to_human_size(123)
'123 Bytes'
>>> number_to_human_size(1234)
'1.2 KB'
>>> number_to_human_size(12345)
'12.1 KB'
>>> number_to_human_size(1234567)
'1.2 MB'
>>> number_to_human_size(1234567890)
'1.1 GB'
>>> number_to_human_size(1234567890123)
'1.1 TB'
>>> number_to_human_size(1234567, 2)
'1.18 MB'

f number_to_percentage(number, precision=3, separator='.') ...

Formats a number as into a percentage string.

precision
The level of precision, defaults to 3
separator
The unit separator to be used. Defaults to "."

Examples:

>>> number_to_percentage(100)
'100.000%'
>>> number_to_percentage(100, precision=0)
'100%'
>>> number_to_percentage(302.0574, precision=2)
'302.06%'

f number_to_phone(number, area_code=False, delimiter='-', extension='', country_code='') ...

Formats a number into a US phone number string.

area_code
When enabled, adds parentheses around the area code. Defaults to False
delimiter
The delimiter to use, defaults to "-"
extension
Specifies an extension to add to the end of the generated number
country_code
Sets the country code for the phone number

Examples:

>>> number_to_phone(1235551234)
'123-555-1234'
>>> number_to_phone(1235551234, area_code=True)
'(123) 555-1234'
>>> number_to_phone(1235551234, delimiter=" ")
'123 555 1234'
>>> number_to_phone(1235551234, area_code=True, extension=555)
'(123) 555-1234 x 555'
>>> number_to_phone(1235551234, country_code=1)
'1-123-555-1234'

f number_with_delimiter(number, delimiter=',', separator='.') ...

Formats a number with grouped thousands using delimiter.

delimiter
The delimiter character to use, defaults to ","
separator
Used to set what the unit separation should be. Defaults to "."

Example:

>>> number_with_delimiter(12345678)
'12,345,678'
>>> number_with_delimiter(12345678.05)
'12,345,678.05'
>>> number_with_delimiter(12345678, delimiter=".")
'12.345.678'

f number_with_precision(number, precision=3) ...

Formats a number with a level of precision.

precision
The level of precision, defaults to 3

Example:

>>> number_with_precision(111.2345)
'111.234'
>>> number_with_precision(111.2345, 2)
'111.23'

See the source for more information.

Top