API Reference

class prefixed.Float([x])

Subclass of the built-in float class

Key differences:

  • When a math operation is performed with another real number type (float, int), the result will be a prefixed.Float instance.

  • Additional presentation types 'h', 'j', and 'J' are supported for f-strings and format().

    Type Meaning
    'h' SI format. Outputs the number with closest divisible SI prefix. (k, M, G, …)
    'j' IEC Format. Outputs the number with closest divisible IEC prefix. (Ki, Mi, Gi, …)
    'J' Short IEC Format. Same as 'j' but only a single character. (K, M, G, …)
  • When initializing from strings, SI and IEC prefixes are honored

    >>> Float('2k')
    Float(2000.0)
    
    >>> Float('2Ki')
    Float(2048.0)
    
  • An additional format flag ‘!’ is available which adds a space before the prefix

>>> f'{Float(3250):!.2h}'
'3.25 k'
  • An additional field, margin, can be specified which lowers or raises the threshold for for each prefix by the given percentage. Margin is specified before precision with the syntax %[-]digit+.
>>> f'{Float(950):.2h}'
'950.00'

>>> f'{Float(950):%-5.2h}'
'0.95k'

>>> f'{Float(1000):%5.2h}'
'1000.00'

>>> f'{Float(1050):%5.2h}'
'1.05k'