A package that helps you format numbers for engineering, scientific, and UI applications.
Project description
numformat
Numformat is a library that helps you easily format number-like objects (int, float, decimal.Decimal, str) in a way that is consistent with scientific and engineering practices.
It has options to convert number-like objects to strings with different notations while allowing control over Significant Figures, Precision, and output string length.
Usage examples:
Importing the package:
import numformat as nf
Formatting to scientific and engineering notations:
# Convert to scientific notation
nf.sciformat(103000000)
>> '1.03e+08'
# Convert to engineering notation
nf.enggformat("103000000")
>> '103E+6'
Using autoformat:
# Auto-format with default options
nf.autoformat(1030000.0)
>> '1030000.0'
nf.autoformat(103000000.0)
>> '1.03e+08'
Using autoformat with the max_sig_figs argument:
# Auto-format and use a maximum of 5 significant figures
nf.autoformat(103000.000, max_sig_figs=5)
>> '103000'
# Auto-format and use a maximum of 2 significant figures
nf.autoformat("10300.00", max_sig_figs=2)
>> '10000'
Using autoformat with the max_length argument:
# Auto-format to a string that has a maximum length of 6 characters
nf.autoformat(103000000, max_length=6)
>> '1e+08'
Using autoformat with the preserve_sig_figs argument:
# Auto-format to a string that has a maximum length of 8 characters
nf.autoformat(103100000, max_length=8, preserve_sig_figs=False)
>> '1.03e+08'
# Auto-format to a string that has a maximum length of 8 characters but also preserve all significant figures.
nf.autoformat(103100000, max_length=8, preserve_sig_figs=True)
>> '103.1E+6'
Controlling the format type in autoformat:
# Auto-format to a string with a maximum length of 6 characters but don't allow scientific notation
nf.autoformat(103000000, max_length=6, allow_scientific_notation=False)
>> '103E+6'
# Auto-format to a string with a maximum length of 6 characters but don't allow scientific or engineering notation.
# Conditions cannot be met, therefore, it returns the number in standard notation.
nf.autoformat(103000000, max_length=6, allow_scientific_notation=False, allow_engineering_notation=False)
>> '103000000'
Raising an error if formatting fails:
# Auto-format to a string with a maximum length of 6 characters but don't allow scientific or engineering notation.
# Conditions cannot be met, and strict = True, therefore, returns an error.
nf.autoformat(103000000, max_length=6, allow_scientific_notation=False, allow_engineering_notation=False, strict=True)
>> ValueError: Could not represent the input within 6 characters.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
numformat-0.0.4.tar.gz
(8.7 kB
view hashes)
Built Distribution
Close
Hashes for numformat-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 700f7969c847a50af9875609ce119997f0007a9b44e77442e20cb0a4dbe3bd98 |
|
MD5 | 69ea8045bcae34b40993ba05696c56cf |
|
BLAKE2b-256 | 4a2b255dc4e355d683a5536c7f0502cfa5250ab4aec117f9fdc316636d63fe59 |