Feature/parts per when exp=0 99 (#115)

jagerber48 · Jan 10, 2024 · 673eda9 · 673eda9
2 parents 3ff0f53 + de4b4c9
commit 673eda9
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -31,6 +31,16 @@ Removed
   more confusing to understand.
   [`#97 <https://github.com/jagerber48/sciform/issues/97>`_]
 
+Changed
+^^^^^^^
+
+* **[BREAKING]** Previously ``12.3`` would format as ``"12.3e+00"``
+  when using parts per formatting mode.
+  Now, when using parts per formatting mode, the ``e+00`` exponent is
+  translated to be an empty string so that ``12.3`` would format as
+  ``"12.3"``.
+  [`#99 <https://github.com/jagerber48/sciform/issues/99>`_]
+
 ----
 
 0.31.1 (2024-01-06)

diff --git a/docs/source/exp replacement.rst b/docs/source/exp replacement.rst
@@ -122,6 +122,9 @@ Parts Per Forms
    * - Exponent Value
      - Prefix Name
      - Prefix
+   * - 10\ :sup:`0`
+     - unity
+     - ``no symbol``
    * - 10\ :sup:`-6`
      - parts-per-million
      - ppm

diff --git a/src/sciform/prefix.py b/src/sciform/prefix.py
@@ -37,6 +37,7 @@
 }
 
 pp_val_to_prefix_dict = {
+    0: "",
     -6: "ppm",
     -9: "ppb",
     -12: "ppt",

diff --git a/tests/test_float_formatter.py b/tests/test_float_formatter.py
@@ -183,6 +183,22 @@ def test_parts_per_exp(self):
             (
                 123e-3,
                 [
+                    (
+                        Formatter(
+                            exp_mode="scientific",
+                            exp_val=3,
+                            exp_format="parts_per",
+                        ),
+                        "0.000123e+03",
+                    ),
+                    (
+                        Formatter(
+                            exp_mode="scientific",
+                            exp_val=0,
+                            exp_format="parts_per",
+                        ),
+                        "0.123",
+                    ),
                     (
                         Formatter(
                             exp_mode="scientific",