format-multiple-errors 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

format_multiple_errors/formatter.py

@@ -43,6 +43,10 @@ def format_multiple_errors(
                         with `significant_figures` significant figures.
             "central": The central `value` is printed
                        with `significant_figures` significant figures.
+            "largest": The largest uncertainty is printed
+                       with `significant_figures` significant figures.
+            "decimal_places": Values are truncated to `significant_figures`
+                              decimal places.
 
     significant_figures (default: 2):
         The number of significant figures to format.
@@ -68,14 +72,23 @@ def format_multiple_errors(
             normalised_value, normalised_errors
         )
 
-    length_value = _get_length_value(
-        normalised_value, normalised_errors, length_control
-    )
-    first_digit_index, decimal_places = _get_rounding_indices(
-        length_value, significant_figures
-    )
+    if length_control == "decimal_places":
+        if significant_figures < 0:
+            raise ValueError("Number of decimal places must be non-negative")
+        decimal_places = significant_figures
+        decimals_required = decimal_places > 0
+    else:
+        length_value = _get_length_value(
+            normalised_value, normalised_errors, length_control
+        )
+        first_digit_index, decimal_places = _get_rounding_indices(
+            length_value, significant_figures
+        )
+        decimals_required = _decimals_required(
+            first_digit_index, significant_figures, exponential
+        )
 
-    if _decimals_required(first_digit_index, significant_figures, exponential):
+    if decimals_required:
         formatted_numbers = [f"{normalised_value:.0{decimal_places}f}"] + list(
             _format_errors_only(normalised_errors, decimal_places, abbreviate)
         )
@@ -202,10 +215,16 @@ def _get_length_value(value: float, errors: Errors, length_control: str) -> floa
             return value
 
         return length
+    if length_control == "largest":
+        length = _get_largest(errors)
+        if length is None:
+            return value
+
+        return length
 
     raise ValueError(
-        f"{length_control} is not a value option for length_control."
-        '(Available options are "smallest", "central".)'
+        f"{length_control} is not a value option for length_control. "
+        '(Available options are "smallest", "central", "largest".)'
     )
 
 
@@ -219,6 +238,16 @@ def _get_smallest(errors: Errors) -> float | None:
     return min(flat_errors)
 
 
+def _get_largest(errors: Errors) -> float | None:
+    """Given a list of errors (number or tuples of two numbers),
+    find the largest finite number."""
+    flat_errors = _flatten_errors(errors, exclude=[math.inf])
+    if not flat_errors:
+        return None
+
+    return max(flat_errors)
+
+
 def _flatten_errors(errors: Errors, exclude: Set | Sequence = frozenset()) -> list:
     """Given a list of errors (number or tuples of two numbers),
     flatten it to a list of numbers."""

{format_multiple_errors-0.0.3.dist-info → format_multiple_errors-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: format_multiple_errors
-Version: 0.0.3
+Version: 0.0.4
 Summary: A small widget to be able to format multiple, asymmetric errors easily.
 Author-email: Ed Bennett <e.j.bennett@swansea.ac.uk>
 Project-URL: Homepage, https://github.com/edbennett/format_multiple_errors
@@ -12,13 +12,14 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: tables
-Requires-Dist: pandas ; extra == 'tables'
-Requires-Dist: jinja2 ; extra == 'tables'
+Requires-Dist: pandas; extra == "tables"
+Requires-Dist: jinja2; extra == "tables"
+Dynamic: license-file
 
 # format_multiple_errors
 
 [![Run tests](https://github.com/edbennett/format_multiple_errors/actions/workflows/pytest.yaml/badge.svg)](https://github.com/edbennett/format_multiple_errors/actions/workflows/pytest.yaml)
-[![Code quality](https://github.com/edbennett/format_multiple_errors/actions/workflows/codequality.yaml/badge.svg)](https://github.com/edbennett/format_multiple_errors/actions/workflows/codequality.yaml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/edbennett/format_multiple_errors/main.svg)](https://results.pre-commit.ci/latest/github/edbennett/format_multiple_errors/main)
 
 A small library intended to make it easy to format numbers like
 
@@ -103,6 +104,12 @@ These options may be combined:
     >>> format_multiple_errors(123.45, 3.14, (2.82, 12.91), length_control="central", significant_figures=5, latex=True, abbreviate=True, exponential=True)
     '1.2345(314)({}^{282}_{1291}) \\times 10^{2}'
 
+Other options for `length_control` are:
+
+- `"largest"`: controls the significant digits of the largest uncertainty
+- `"decimal_places"`: instead sets the absolute number of decimal places,
+  which must be non-negative.
+
 
 ### Formatting DataFrames
 

format_multiple_errors-0.0.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+format_multiple_errors/__init__.py,sha256=ZLtmZ1Pe3zyxnic-b4nhtuajNj8llWykspVPpFaN7Rc,460
+format_multiple_errors/__main__.py,sha256=Jiy0F5VlGLfzkPfvAFpuZluNevVITxXrxvTf6ztH5pI,6157
+format_multiple_errors/formatter.py,sha256=ypxkaUhmf8TgICk7ysUm2li_4XgZJ-02avvu5gnZOc8,11798
+format_multiple_errors/pandas.py,sha256=S_-ThiTlbItx_lUngFYY547Abp5fJaNGoQGXwwHK0i4,7689
+format_multiple_errors/typing.py,sha256=k0p3GDaHGXHd3zmBtNg0-cvcMzEupzN4RHaLdNvxX6U,342
+format_multiple_errors-0.0.4.dist-info/licenses/LICENSE,sha256=G3SZheaYJW8JV0Njnnyfi7QwUJWh9evcPRQ-nAXi8Ro,1086
+format_multiple_errors-0.0.4.dist-info/METADATA,sha256=hj6mtoIYOCPXVDCSd5Wijj0xqtooLyg9mDAf4VoCsNM,6811
+format_multiple_errors-0.0.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+format_multiple_errors-0.0.4.dist-info/entry_points.txt,sha256=PeHYlzbvQciSJX3DWuM-Y5Xwi9Is0jO-LlUgdSkUTp4,79
+format_multiple_errors-0.0.4.dist-info/top_level.txt,sha256=I_xD5oYbrw0qjNhbzAlj_sqNhLrkoJsTE_ozCqnlaZc,23
+format_multiple_errors-0.0.4.dist-info/RECORD,,

{format_multiple_errors-0.0.3.dist-info → format_multiple_errors-0.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (82.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

format_multiple_errors-0.0.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-format_multiple_errors/__init__.py,sha256=ZLtmZ1Pe3zyxnic-b4nhtuajNj8llWykspVPpFaN7Rc,460
-format_multiple_errors/__main__.py,sha256=Jiy0F5VlGLfzkPfvAFpuZluNevVITxXrxvTf6ztH5pI,6157
-format_multiple_errors/formatter.py,sha256=GnfJjP4HbYXxTq-Yx1E8DhbviPqRj0t3_icPTYgQ2P0,10744
-format_multiple_errors/pandas.py,sha256=S_-ThiTlbItx_lUngFYY547Abp5fJaNGoQGXwwHK0i4,7689
-format_multiple_errors/typing.py,sha256=k0p3GDaHGXHd3zmBtNg0-cvcMzEupzN4RHaLdNvxX6U,342
-format_multiple_errors-0.0.3.dist-info/LICENSE,sha256=G3SZheaYJW8JV0Njnnyfi7QwUJWh9evcPRQ-nAXi8Ro,1086
-format_multiple_errors-0.0.3.dist-info/METADATA,sha256=-Eb_lvnUvvHl9aQTsg8Ge1GTyVLcBJ_FPe70uyFUkoQ,6580
-format_multiple_errors-0.0.3.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-format_multiple_errors-0.0.3.dist-info/entry_points.txt,sha256=PeHYlzbvQciSJX3DWuM-Y5Xwi9Is0jO-LlUgdSkUTp4,79
-format_multiple_errors-0.0.3.dist-info/top_level.txt,sha256=I_xD5oYbrw0qjNhbzAlj_sqNhLrkoJsTE_ozCqnlaZc,23
-format_multiple_errors-0.0.3.dist-info/RECORD,,