sciform 0.28.2__tar.gz → 0.29.0__tar.gz

{sciform-0.28.2 → sciform-0.29.0}/CHANGELOG.rst

@@ -1,7 +1,47 @@
+This project adheres to `Semantic Versioning <https://semver.org/>`_.
+
+----
+
 Unreleased
 ----------
 
-* No unreleased changes
+* There are no unreleased changes
+
+----
+
+0.29.0 (2023-09-05)
+-------------------
+
+Changed
+^^^^^^^
+
+* Previously, when using ``bracket_unc=True`` with any exponent string
+  (such as ``e-06``, ``μ`` or ``ppm``), the value and uncertainty were
+  always wrapped in parentheses, e.g. ``(1.03(25))e-06``,
+  ``(1.03(25)) μ`` or ``(1.03(25)) ppm``.
+  Now, when using ``bracket_unc=True`` with prefix or parts-per exponent
+  format modes, if the exponent is replaced with an alphabetic
+  replacement, then the value and uncertainty are no longer wrapped in
+  parentheses, e.g. ``1.03(25) μ`` and ``1.03(25) ppm``.
+  This is consistent with
+  `BIPM Guide Section 7.2.2 <https://www.bipm.org/documents/20126/2071204/JCGM_100_2008_E.pdf/cb0ef43f-baa5-11cf-3f85-4dcd86f77bd6#page=37>`_.
+  Specifically, any time ``bracket_unc=False`` the value and uncertainty
+  are always wrapped in parentheses, and any time notation like ``e+02``
+  or ``b+02`` is used to indicate the exponent then the value and
+  uncertainty are always wrapped in parentheses.
+
+Fixed
+^^^^^
+
+* Correct ``fit_plot_with_sciform.py`` example script to use new
+  ``exp_format=ExpFormat.PREFIX`` instead of old ``prefix_exp=True``.
+
+Improved
+^^^^^^^^
+
+* Documentation improvements including typos and neatening up changelog.
+
+----
 
 0.28.2 (2023-08-31)
 -------------------
@@ -30,6 +70,8 @@ Fixed
   In the future a flag may be added to select "parts-per" formatting
   using the format specification mini-language.
 
+----
+
 0.28.1 (2023-08-28)
 -------------------
 
@@ -44,6 +86,8 @@ Fixed
 * Test against Python 3.11.
 * List supported Python versions in ``pyproject.toml`` classifiers.
 
+----
+
 0.28.0 (2023-08-27)
 -------------------
 
@@ -51,7 +95,7 @@ Fixed
   with an ``exp_format`` option which can be configured to
   ``ExpFormat.STANDARD``, ``ExpFormat.PREFIX`` or
   ``ExpFormat.PARTS_PER``.
-* Previously formating a non-finite number in percent mode would always
+* Previously formatting a non-finite number in percent mode would always
   display a ``'%'`` symbol, e.g. ``'(nan)%'``.
   Now the brackets and ``'%'`` symbol will be omitted unless
   ``nan_inf_exp=True``.
@@ -70,11 +114,15 @@ Fixed
   Rounding and truncating are not properly implemented in binary mode
   yet.
 
+----
+
 0.27.4 (2023-08-25)
 -------------------
 
 * Setup github action to automatically build and publish on release.
 
+----
+
 0.27.3 (2023-08-23)
 -------------------
 
@@ -84,12 +132,16 @@ Fixed
   ``setuptools_scm``.
 * Stopped encouraging ``import FormatOptions as Fo``.
 
+----
+
 0.27.2 (2023-08-20)
 -------------------
 
 * Add ``__repr__()`` for ``FormatOptions`` and
   ``RenderedFormatOptions``.
 
+----
+
 0.27.1 (2023-08-18)
 -------------------
 
@@ -98,6 +150,8 @@ Fixed
   outputs which appear in the documentation.
 * Remove extra ``readthedocs.yaml`` file.
 
+----
+
 0.27.0 (2023-08-18)
 -------------------
 
@@ -106,6 +160,8 @@ Fixed
   ``ndigits=AutoRound``. Furthermore, ``AutoRound`` could likely be
   confused as being an option for ``round_mode``, which it is not.
 
+----
+
 0.26.2 (2023-08-18)
 -------------------
 
@@ -115,11 +171,15 @@ Fixed
   The bug is fixed by re-checking the options combinations after merging
   in the global defaults but before formatting.
 
+----
+
 0.26.1 (2023-08-18)
 -------------------
 
 * Add unit tests, increase test coverage.
 
+----
+
 0.26.0 (2023-08-15)
 -------------------
 
@@ -147,16 +207,22 @@ Fixed
    * Better explanations of ``AutoExpVal`` and ``AutoRound`` behavior.
    * More accurate descriptions of some invalid options combinations.
 
+----
+
 0.25.2 (2023-08-11)
 -------------------
 
 * Update roadmap
 
+----
+
 0.25.1 (2023-08-10)
 -------------------
 
 * Refactor ``get_pdg_round_digit()`` into a dedicated function.
 
+----
+
 0.25.0 (2023-08-02)
 -------------------
 
@@ -166,6 +232,8 @@ Fixed
   ``FormatOptions`` instances using the ``merge()`` method.
 * Minor documentation improvements.
 
+----
+
 0.24.0 (2023-07-30)
 -------------------
 
@@ -173,6 +241,8 @@ Fixed
   ``ExpMode.PERCENT``.
   There is no longer a ``percent`` keyword argument.
 
+----
+
 0.23.0 (2023-07-29)
 -------------------
 
@@ -188,17 +258,23 @@ Fixed
   ``SciNumUnc`` objects.
 * Change ``pyproject.toml`` description
 
+----
+
 0.22.2 (2023-07-27)
 -------------------
 
 * Add ``.readthedocs.yaml`` and update documentation
   ``requirements.txt`` for reproducible documentation builds.
 
+----
+
 0.22.1 (2023-07-27)
 -------------------
 
 * Fix a date typo in the changelog for the entry for version ``0.22.0``.
 
+----
+
 0.22.0 (2023-07-27)
 -------------------
 
@@ -227,6 +303,8 @@ Fixed
      was corrected.
    * Add "under construction" message to README.
 
+----
+
 0.21.0 (2023-07-22)
 -------------------
 
@@ -235,7 +313,9 @@ Fixed
   ``float`` and more reliable rounding behavior.
 * Update particle data group uncertainty rounding unit tests since edge
   cases are now handled property as a result of adopting ``Decimal``.
-* Minor cleanup of ``sfloat`` arithemetic functions.
+* Minor cleanup of ``sfloat`` arithmetic functions.
+
+----
 
 0.20.1 (2023-06-24)
 -------------------
@@ -248,6 +328,8 @@ Fixed
   ``format_float()`` and ``format_val_unc()`` directly instead of
   creating a ``Formatter`` object first.
 
+----
+
 0.20.0 (2023-06-22)
 -------------------
 
@@ -263,6 +345,8 @@ Fixed
   mode: e.g. ``\text{Mi}``.
 * Link to test cases on examples page.
 
+----
+
 0.19.0 (2023-06-22)
 -------------------
 
@@ -270,11 +354,15 @@ Fixed
   doc testing, and flake8 scans during github pull requests.
 * Minor flake8 cleanup
 
+----
+
 0.18.1 (2023-06-21)
 -------------------
 
 * Documentation improvements
 
+----
+
 0.18.0 (2023-06-19)
 -------------------
 
@@ -288,6 +376,8 @@ Fixed
 * Expose ``AutoPrec`` and ``AutoExp`` sentinel classes so that users can
   explicitly indicate automatic precision and exponent selection.
 
+----
+
 0.17.1 (2023-06-19)
 -------------------
 
@@ -295,6 +385,8 @@ Fixed
   including more verbose clarifying comments.
 * Minor documentation cleanup
 
+----
+
 0.17.0 (2023-06-19)
 -------------------
 
@@ -303,6 +395,8 @@ Fixed
 * Fix typos in binary IEC prefixes table.
 * Fix some cross links in documentation.
 
+----
+
 0.16.0 (2023-06-18)
 -------------------
 
@@ -310,16 +404,22 @@ Fixed
 * Refactor exponent string conversion.
 * Percent mode for non-finite numbers.
 
+----
+
 0.15.2 (2023-06-18)
 -------------------
 
 * Fix a bug involving space filling and separators.
 
+----
+
 0.15.1 (2023-06-17)
 -------------------
 
 * Changelog formatting typo.
 
+----
+
 0.15.0 (2023-06-17)
 -------------------
 
@@ -327,8 +427,12 @@ Fixed
 * Forbid percent mode unless using fixed point exponent mode.
 * Add PyPi link to readme.
 
+----
+
 0.14.0 (2023-06-17)
 -------------------
 
 * Add Changelog.
 * Add ``unicode_pm`` option with documentation and tests.
+
+----

{sciform-0.28.2 → sciform-0.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.28.2
+Version: 0.29.0
 Summary: A package for formatting numbers into scientific formatted strings.
 Author-email: Justin Gerber <justin.gerber48@gmail.com>
 Project-URL: homepage, https://github.com/jagerber48/sciform
@@ -77,7 +77,7 @@ continue to change until version ``1.0.0`` is released.
 API changes will be announced after new releases in the
 `changelog <https://sciform.readthedocs.io/en/stable/project.html#changelog>`_.
 If you have an idea or opinion about how ``sciform`` should be designed,
-now is a great to
+now is a great time to
 `post a discussion topic <https://github.com/jagerber48/sciform/discussions>`_
 about it!
 

{sciform-0.28.2 → sciform-0.29.0}/README.rst

@@ -60,7 +60,7 @@ continue to change until version ``1.0.0`` is released.
 API changes will be announced after new releases in the
 `changelog <https://sciform.readthedocs.io/en/stable/project.html#changelog>`_.
 If you have an idea or opinion about how ``sciform`` should be designed,
-now is a great to
+now is a great time to
 `post a discussion topic <https://github.com/jagerber48/sciform/discussions>`_
 about it!
 

{sciform-0.28.2 → sciform-0.29.0}/docs/source/examples.rst

@@ -248,5 +248,5 @@ We can see the plot and table are immediately much more legible.
 Less characters are needed to communicate the data in both
 visualizations.
 The relative scaling of parameters between datasets and the relative
-scalings between the value and uncertainty for each entry are
+scaling between the value and uncertainty for each entry are
 immediately clear.

{sciform-0.28.2 → sciform-0.29.0}/docs/source/fsml.rst

@@ -14,7 +14,7 @@ configured using :class:`FormatOptions` instances, users can construct
 :class:`SciNum` or :class:`SciNumUnc` instances and format them using
 string formatting with format specification strings from the
 :mod:`sciform` format specification mini-language (FSML).
-This is analagous to how python :class:`int`, :class:`float`, and
+This is analogous to how python :class:`int`, :class:`float`, and
 :class:`Decimal` instances can be formatted using the built-in
 `format specification mini-language <https://docs.python.org/3/library/string.html#format-specification-mini-language>`_.
 The :mod:`sciform` format specification mini-language is given by::
@@ -158,9 +158,9 @@ for scientific formatting.
   * Inclusion of a hanging decimal point, e.g. ``123.``.
     :mod:`sciform` never includes a hanging decimal point.
 
-* For :class:`float` instances, Python formatting uses a default precion
-  of 6 for ``f``, ``F``, ``%``, ``e``, and ``E`` modes if no explicit
-  precision (``ndigits``) is supplied.
+* For :class:`float` instances, Python formatting uses a default
+  precision of 6 for ``f``, ``F``, ``%``, ``e``, and ``E`` modes if no
+  explicit precision (``ndigits``) is supplied.
   :mod:`sciform`, instead, converts :class:`float` instances into
   :class:`str` and then :class:`Decimal` so that they are displayed with
   as many digits as necessary to "round-trip" when no ``ndigits`` is

{sciform-0.28.2 → sciform-0.29.0}/docs/source/options.rst

@@ -48,7 +48,7 @@ Percent
 -------
 
 Percent mode is similar to fixed point mode.
-For percent mode, the number is multipled by 100 and a ``%`` symbol is
+For percent mode, the number is multiplied by 100 and a ``%`` symbol is
 appended to the end of the formatted string.
 
 >>> sform = Formatter(FormatOptions(exp_mode=ExpMode.PERCENT))
@@ -90,7 +90,7 @@ exponent is chosen to be an integer multiple of 3.
 In standard engineering notation, the mantissa ``m`` satisfies
 ``1 <= m < 1000``.
 Engineering notation is compatible with the SI prefixes which are
-defined for any integer mulitple of 3 exponent, e.g.::
+defined for any integer multiple of 3 exponent, e.g.::
 
    369,000,00 Hz = 369e+06 Hz = 369 MHz
 
@@ -372,7 +372,7 @@ rounded to ``12.99``.
 >>> print(sform(12345.678))
 12.3457e+03
 
-It is possibe for ``ndigits <= 0``:
+It is possible for ``ndigits <= 0``:
 
 >>> from sciform import RoundMode
 >>> sform = Formatter(FormatOptions(
@@ -446,7 +446,7 @@ decimal separator.
 >>> print(sform(1234567.7654321))
 1 234 567,765_432_1
 
-NIST discourages the use of ``','`` or ``'.'`` as thousands seperators
+NIST discourages the use of ``','`` or ``'.'`` as thousands separators
 because they can be confused with the decimal separators depending on
 the locality. See
 `NIST Guide to the SI 10.5.3 <https://www.nist.gov/pml/special-publication-811/nist-guide-si-chapter-10-more-printing-and-using-symbols-and-numbers#1053>`_.
@@ -743,6 +743,20 @@ Or with other options:
 >>> print(sform(123.456, 0.789))
 (1.2346(79))e+02
 
+When ``bracket_unc=True`` is used with the prefix or parts-per exponent
+formats, if the exponent string is replaced, then the enclosing brackets
+around the value/uncertainty pair are omitted.
+This is consistent with
+`BIPM Guide Section 7.2.2 <https://www.bipm.org/documents/20126/2071204/JCGM_100_2008_E.pdf/cb0ef43f-baa5-11cf-3f85-4dcd86f77bd6#page=37>`_.
+
+>>> from sciform import ExpFormat
+>>> sform = Formatter(FormatOptions(
+...             exp_mode=ExpMode.ENGINEERING,
+...             exp_format=ExpFormat.PREFIX,
+...             bracket_unc=True))
+>>> print(sform(523.4e-3,  1.2e-3))
+523.4(1.2) m
+
 Remove Separators for Bracket Uncertainty
 --------------------------------------------
 

{sciform-0.28.2 → sciform-0.29.0}/docs/source/usage.rst

@@ -387,7 +387,7 @@ Here I would like to highlight two specific issues.
    In Table 2 the :sup:`87` Rb ground-state hyperfine splitting is cited
    as ``6 834 682 610.904 312 6 Hz`` with 17 digits. Suppose the last
    digit was a ``5`` instead of a ``6``. Python :class:`float` cannot
-   tell the diffence:
+   tell the difference:
    ``float(6834682610.9043126) == float(6834682610.9043125)`` returns
    ``True``.
 

{sciform-0.28.2 → sciform-0.29.0}/examples/fit_plot_with_sciform.py

@@ -7,7 +7,8 @@ import matplotlib.pyplot as plt
 from scipy.optimize import curve_fit
 from tabulate import tabulate
 
-from sciform import Formatter, ExpMode, RoundMode, SignMode, FormatOptions
+from sciform import (Formatter, ExpMode, RoundMode, SignMode, FormatOptions,
+                     ExpFormat)
 
 
 def get_scale_and_offset_from_offset_str(
@@ -54,11 +55,11 @@ def prefix_exp_ticks(ax: plt.Axes, axis: Literal['x', 'y'],
         exp_mode = ExpMode.ENGINEERING_SHIFTED
     tick_formatter = Formatter(FormatOptions(
         exp_mode=exp_mode,
-        prefix_exp=True))
+        exp_format=ExpFormat.PREFIX))
     offset_formatter = Formatter(FormatOptions(
         sign_mode=SignMode.ALWAYS,
         exp_mode=exp_mode,
-        prefix_exp=True))
+        exp_format=ExpFormat.PREFIX))
 
     ax.ticklabel_format(axis=axis, style='sci')
 

{sciform-0.28.2 → sciform-0.29.0}/src/sciform/format_options.py

@@ -262,7 +262,7 @@ class FormatOptions:
                 **_merge_dicts(asdict(defaults), asdict(self))
             )
         except ValueError as e:
-            raise ValueError('Invalid format options resuling from merging '
+            raise ValueError('Invalid format options resulting from merging '
                              'with default options.') from e
 
         return rendered_format_options
@@ -275,7 +275,7 @@ def validate_options(options: Union[FormatOptions, RenderedFormatOptions]):
     if options.round_mode is RoundMode.SIG_FIG:
         if isinstance(options.ndigits, int):
             if options.ndigits < 1:
-                raise ValueError(f'Precision must be >= 1 for sig fig '
+                raise ValueError(f'ndigits must be >= 1 for sig fig '
                                  f'rounding, not {options.ndigits}.')
 
     if (options.pdg_sig_figs and options.ndigits is not None

{sciform-0.28.2 → sciform-0.29.0}/src/sciform/formatting.py

@@ -318,7 +318,10 @@ def format_val_unc(val: Decimal, unc: Decimal,
             extra_iec_prefixes=options.extra_iec_prefixes,
             extra_parts_per_forms=options.extra_parts_per_forms
         )
-        val_unc_exp_str = f'({val_unc_str}){exp_str}'
+        if options.bracket_unc and not re.match(r'^[eEbB][+-]\d+$', exp_str):
+            val_unc_exp_str = f'{val_unc_str}{exp_str}'
+        else:
+            val_unc_exp_str = f'({val_unc_str}){exp_str}'
     else:
         val_unc_exp_str = val_unc_str
 

{sciform-0.28.2 → sciform-0.29.0}/src/sciform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.28.2
+Version: 0.29.0
 Summary: A package for formatting numbers into scientific formatted strings.
 Author-email: Justin Gerber <justin.gerber48@gmail.com>
 Project-URL: homepage, https://github.com/jagerber48/sciform
@@ -77,7 +77,7 @@ continue to change until version ``1.0.0`` is released.
 API changes will be announced after new releases in the
 `changelog <https://sciform.readthedocs.io/en/stable/project.html#changelog>`_.
 If you have an idea or opinion about how ``sciform`` should be designed,
-now is a great to
+now is a great time to
 `post a discussion topic <https://github.com/jagerber48/sciform/discussions>`_
 about it!
 

{sciform-0.28.2 → sciform-0.29.0}/tests/test_val_unc_formatter.py

@@ -41,6 +41,47 @@ class TestFormatting(unittest.TestCase):
 
         self.run_val_unc_formatter_cases(cases_list)
 
+    def test_prefix(self):
+        cases_list = [
+            ((123.456, 0.789), [
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING,
+                               exp_format=ExpFormat.PREFIX), '123.456(789)'),
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING_SHIFTED,
+                               exp_format=ExpFormat.PREFIX),
+                 '0.123456(789) k'),
+            ]),
+            ((123456, 789), [
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.FIXEDPOINT,
+                               exp_format=ExpFormat.PREFIX), '123456(789)'),
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING,
+                               exp_format=ExpFormat.PREFIX), '123.456(789) k'),
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING_SHIFTED,
+                               exp_format=ExpFormat.PREFIX), '0.123456(789) M')
+            ]),
+            ((123456e-9, 789e-9), [
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING,
+                               exp_format=ExpFormat.PARTS_PER),
+                 '123.456(789) ppm'),
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING,
+                               exp_format=ExpFormat.PREFIX),
+                 '123.456(789) μ'),
+                (FormatOptions(bracket_unc=True,
+                               exp_mode=ExpMode.ENGINEERING_SHIFTED,
+                               exp_format=ExpFormat.PARTS_PER,
+                               add_ppth_form=True),
+                 '0.123456(789) ppth')
+            ])
+        ]
+
+        self.run_val_unc_formatter_cases(cases_list)
+
     def test_percent(self):
         cases_list = [
             ((0.123_456_78, 0.000_002_55), [

{sciform-0.28.2 → sciform-0.29.0}/tests/test_val_unc_fsml.py

@@ -13,12 +13,12 @@ class TestFormatting(unittest.TestCase):
     def run_val_unc_fsml_cases(self, cases_list: ValUncFSMLCases):
         for (val, unc), formats_list in cases_list:
             for format_spec, expected_str in formats_list:
-                vunum = SciNumUnc(val, unc)
-                vunum_str = f'{vunum:{format_spec}}'
+                snum = SciNumUnc(val, unc)
+                snum_str = f'{snum:{format_spec}}'
                 with self.subTest(val=val, unc=unc, format_spec=format_spec,
                                   expected_str=expected_str,
-                                  actual_str=vunum_str):
-                    self.assertEqual(vunum_str, expected_str)
+                                  actual_str=snum_str):
+                    self.assertEqual(snum_str, expected_str)
 
     def test_fixed(self):
         cases_list = [