sciform 0.28.1__py3-none-any.whl → 0.29.0__py3-none-any.whl

sciform/format_options.py

@@ -54,8 +54,8 @@ ExpReplaceDict = dict[int, Union[str, None]]
 class FormatOptions:
     # TODO: __repr__
     """
-    :class:`FormatOptions` stores all the configuration options used to
-    format numbers and number/uncertainty pairs. See
+    :class:`FormatOptions` instances store all the configuration options
+    used to format numbers and number/uncertainty pairs. See
     :ref:`formatting_options` for more details on the available options.
     :class:`FormatOptions` instances are used to create
     :class:`Formatter` instances and to modify the global default
@@ -87,8 +87,8 @@ class FormatOptions:
     * ``lower_separator`` may only be :class:`GroupingSeparator.NONE`,
       :class:`GroupingSeparator.SPACE`, or
       :class:`GroupingSeparator.UNDERSCORE`
-    * ``ndigits=None`` or ``ndigits=AutoDigits`` if
-      ``pdg_sig_figs=True``
+    * if ``pdg_sig_figs=True`` then ``ndigits=None`` or
+      ``ndigits=AutoDigits``.
 
     :param exp_mode: :class:`ExpMode` indicating the formatting
       mode to be used.
@@ -138,33 +138,35 @@ class FormatOptions:
       mapping additional exponent values to "parts-per" forms. Entries
       overwrite default values. A value of ``None`` means that exponent
       will not be converted.
-    :param capitalize: :class:`bool` indicating whether the exponentiation
-      symbol should be upper- or lower-case.
-    :param superscript_exp: :class:`bool` indicating if the exponent string
-      should be converted into superscript notation. E.g. ``'1.23e+02'``
-      is converted to ``'1.23×10²'``
-    :param latex: :class:`bool` indicating if the resulting string should be
-      converted into a latex parseable code, e.g.
+    :param capitalize: :class:`bool` indicating whether the
+      exponentiation symbol should be upper- or lower-case.
+    :param superscript_exp: :class:`bool` indicating if the exponent
+      string should be converted into superscript notation. E.g.
+      ``'1.23e+02'`` is converted to ``'1.23×10²'``
+    :param latex: :class:`bool` indicating if the resulting string
+      should be converted into a latex parseable code, e.g.
       ``'\\left(1.23 \\pm 0.01\\right)\\times 10^{2}'``.
-    :param nan_inf_exp: :class:`bool` indicating whether non-finite numbers
-      such as ``float('nan')`` or ``float('inf')`` should be formatted
-      with exponent symbols when exponent modes including exponent
-      symbols are selected.
-    :param bracket_unc: :class:`bool` indicating if bracket uncertainty mode
-      (e.g. ``12.34(82)`` instead of ``12.34 +/- 0.82``) should be used.
+    :param nan_inf_exp: :class:`bool` indicating whether non-finite
+      numbers such as ``float('nan')`` or ``float('inf')`` should be
+      formatted with exponent symbols when exponent modes including
+      exponent symbols are selected.
+    :param bracket_unc: :class:`bool` indicating if bracket uncertainty
+      mode (e.g. ``12.34(82)`` instead of ``12.34 +/- 0.82``) should be
+      used.
     :param pdg_sig_figs: :class:`bool` indicating whether the
       particle-data-group conventions should be used to automatically
       determine the number of significant figures to use for
       uncertainty.
-    :param val_unc_match_widths: :class:`bool` indicating if the value or
-      uncertainty should be left padded to ensure they are both left
+    :param val_unc_match_widths: :class:`bool` indicating if the value
+      or uncertainty should be left padded to ensure they are both left
       padded to the same digits place.
-    :param bracket_unc_remove_seps: :class:`bool` indicating if separator
-      symbols should be removed from the uncertainty when using bracket
-      uncertainty mode. E.g. expressing ``123.4 +/- 2.3`` as
-      ``123.4(23)`` instead of ``123.4(2.3)``.
-    :param unicode_pm: :class:`bool` indicating if the '+/-' separator should
-      be replaced with the unicode plus minus symbol '±'.
+    :param bracket_unc_remove_seps: :class:`bool` indicating if
+      separator symbols should be removed from the uncertainty when
+      using bracket uncertainty mode. E.g. expressing ``123.4 +/- 2.3``
+      as ``123.4(23)`` instead of ``123.4(2.3)``.
+    :param unicode_pm: :class:`bool` indicating if the ``'+/-'``
+      separator should be replaced with the unicode plus minus symbol
+      ``'±'``.
     :param unc_pm_whitespace: :class:`bool` indicating if there should be
       whitespace surrounding the ``'+/-'`` symbols when formatting. E.g.
       ``123.4+/-2.3`` compared to ``123.4 +/- 2.3``.
@@ -238,11 +240,11 @@ class FormatOptions:
         """
         Generate a new :class:`FormatOptions` instance from the current
         instance and another :class:`FormatOptions` instance,
-        ``other``. The options for the new :class:`FormatOptions` are
-        constructed by replacing the options from the current instance
-        by any filled options from ``other``. Note that, even after
-        merging, the resulting :class:`FormatOptions` may still have
-        unfilled options.
+        ``other``. The options for the new :class:`FormatOptions`
+        instance are constructed by replacing the options from the
+        current instance by any filled options from ``other``. Note
+        that, even after merging, the resulting :class:`FormatOptions`
+        may still have unfilled options.
 
         :param other: :class:`FormatOptions` instance containing options
           that will overwrite those of the current instance.
@@ -260,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
@@ -273,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/format_utils.py

@@ -252,7 +252,7 @@ def get_pdg_round_digit(num: Decimal) -> int:
     top_digit = get_top_digit(num)
 
     # Bring num to be between 100 and 1000.
-    num_top_three_digs = num * 10 ** (2 - top_digit)
+    num_top_three_digs = num * Decimal(10) ** (Decimal(2) - Decimal(top_digit))
     num_top_three_digs = round(num_top_three_digs, 0)
     new_top_digit = get_top_digit(num_top_three_digs)
     num_top_three_digs = num_top_three_digs * 10 ** (2 - new_top_digit)

sciform/formatting.py

@@ -86,7 +86,7 @@ def format_num(num: Decimal, unrendered_options: FormatOptions) -> str:
     mantissa, exp_val, base = get_mantissa_exp_base(rounded_num, exp_mode,
                                                     exp_val)
     round_digit = get_round_digit(mantissa, round_mode, ndigits)
-    mantissa_rounded = Decimal(round(mantissa, -int(round_digit)))
+    mantissa_rounded = round(mantissa, -int(round_digit))
 
     if mantissa_rounded == 0:
         '''
@@ -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/fsml.py

@@ -117,7 +117,7 @@ def format_options_from_fmt_spec(fmt_spec: str) -> 'FormatOptions':
     if prefix_exp is not None:
         exp_format = ExpFormat.PREFIX
     else:
-        exp_format = ExpFormat.STANDARD
+        exp_format = None
 
     bracket_unc = match.group('bracket_unc')
     if bracket_unc is not None:

sciform/scinum.py

@@ -8,7 +8,7 @@ from sciform.fsml import format_options_from_fmt_spec
 class SciNum:
     """
     :class:`SciNum` objects are used in combination with the
-    :mod:`sciform` format specification mini language for scientific
+    :mod:`sciform` format specification mini-language for scientific
     formatting of numbers. Any options not configured by the format
     specification will be populated with global default settings at
     format time.

{sciform-0.28.1.dist-info → sciform-0.29.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.28.1
+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!
 
@@ -107,19 +107,6 @@ strings according to the selected options.
 >>> print(sform(123456.78))
 123.5e+03
 
-For brevity, the user may consider abbreviating ``FormatOptions`` as
-``Fo``.
-
->>> from sciform import (Formatter, FormatOptions, RoundMode,
-...                      GroupingSeparator, ExpMode)
->>> sform = Formatter(FormatOptions(
-...             round_mode=RoundMode.DEC_PLACE,
-...             ndigits=6,
-...             upper_separator=GroupingSeparator.SPACE,
-...             lower_separator=GroupingSeparator.SPACE))
->>> print(sform(51413.14159265359))
-51 413.141 593
-
 Users can also format numbers by constructing ``SciNum`` objects and
 using string formatting to format the ``SciNum`` instances according
 to a custom FSML.

sciform-0.29.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+sciform/__init__.py,sha256=kAgKCR6uDXlmzpUIrHwMG607sTvPc5UEOZGE5zKDJ8s,1104
+sciform/format_options.py,sha256=Yk0Xo-wkremjo0Lw_VoZ_8Fwj31gBIwQxnYm6jif19c,19219
+sciform/format_utils.py,sha256=MGJ0Tsoa6iYHn8PJqa6XDr-cT3bRQwLd0u0sqhQomHE,11599
+sciform/formatter.py,sha256=qLK94AqZQ4vv7fLEYIXEJzL0abfE7vfB62npwmzHveE,2091
+sciform/formatting.py,sha256=82K38NFsgDuO7P5L2hGuVHY44hPm9vfzVLCZPkN-EFY,11704
+sciform/fsml.py,sha256=8IbONNU1pSGRmF6_3t-8go_nLOe0yISAkEEUS2bPWdw,4697
+sciform/grouping.py,sha256=t_M33mUIa0e7y8YuYe395dpOrX0QJiwPHC76NRPMcWs,2324
+sciform/modes.py,sha256=xLeffIzlbNSApoBvl0u0GAQrk92XveLKeP0kjyeiz_c,4105
+sciform/prefix.py,sha256=5JpmaqGpoZ7uApq6YkaGb0txjL-VT1AkEsRO6gihX7Q,1186
+sciform/scinum.py,sha256=bTprldmCgLYPSyM9j8qLt--DqnTfBVfMGoneqby8oFI,2068
+sciform-0.29.0.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
+sciform-0.29.0.dist-info/METADATA,sha256=ELJLYio4-4qGbqggyPh-54wG5Ie24BtOl2W-jbvaFXI,5766
+sciform-0.29.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+sciform-0.29.0.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
+sciform-0.29.0.dist-info/RECORD,,

sciform-0.28.1.dist-info/RECORD

@@ -1,15 +0,0 @@
-sciform/__init__.py,sha256=kAgKCR6uDXlmzpUIrHwMG607sTvPc5UEOZGE5zKDJ8s,1104
-sciform/format_options.py,sha256=5HDw1pWKHhdRarDQMm7RhWLkEwUlXYB1MlT57Q3n3N8,19176
-sciform/format_utils.py,sha256=ZGAIe0Ck6qYaHtBxoLWn6dIOD6o2JJA3s6kEcXYHLAo,11572
-sciform/formatter.py,sha256=qLK94AqZQ4vv7fLEYIXEJzL0abfE7vfB62npwmzHveE,2091
-sciform/formatting.py,sha256=eRFuPf90jXkJIfV9J3p1Lj7FQLvEDWTQ1SPQ9H7PqsU,11561
-sciform/fsml.py,sha256=0J7ovJS9T62w9mqDTYQKdq30ncg1sqf3K8UWTQL9sAU,4711
-sciform/grouping.py,sha256=t_M33mUIa0e7y8YuYe395dpOrX0QJiwPHC76NRPMcWs,2324
-sciform/modes.py,sha256=xLeffIzlbNSApoBvl0u0GAQrk92XveLKeP0kjyeiz_c,4105
-sciform/prefix.py,sha256=5JpmaqGpoZ7uApq6YkaGb0txjL-VT1AkEsRO6gihX7Q,1186
-sciform/scinum.py,sha256=mipjJYBzy77HgU5ObXwXHjGj5H3U6Ct6m1HHoAQ8pq8,2068
-sciform-0.28.1.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
-sciform-0.28.1.dist-info/METADATA,sha256=-LZZFN6AeRAyAO91VV0w8LoBFX_CT5WPd9z6UZMlv0o,6233
-sciform-0.28.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-sciform-0.28.1.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
-sciform-0.28.1.dist-info/RECORD,,