sciform 0.32.3__py3-none-any.whl → 0.34.0__py3-none-any.whl

{sciform-0.32.3.dist-info → sciform-0.34.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.32.3
+Version: 0.34.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
@@ -21,13 +21,17 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: coverage ; extra == 'dev'
 Requires-Dist: sphinx ; extra == 'dev'
 Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
 Requires-Dist: sphinx-toolbox ; extra == 'dev'
 Requires-Dist: numpy ; extra == 'dev'
-Requires-Dist: scipy ; extra == 'dev'
-Requires-Dist: matplotlib ; extra == 'dev'
-Requires-Dist: tabulate ; extra == 'dev'
+Provides-Extra: examples
+Requires-Dist: numpy ; extra == 'examples'
+Requires-Dist: scipy ; extra == 'examples'
+Requires-Dist: matplotlib ; extra == 'examples'
+Requires-Dist: tabulate ; extra == 'examples'
+Requires-Dist: jupyter ; extra == 'examples'
 
 .. image:: https://www.repostatus.org/badges/latest/wip.svg
      :target: https://www.repostatus.org/#wip
@@ -128,18 +132,22 @@ You can view the on-going review
 Usage
 =====
 
+Here we provide a few key usage examples.
+For many more details see
+`Usage <https://sciform.readthedocs.io/en/stable/usage.html>`_.
+
 ``sciform`` provides a wide variety of formatting options which can be
 controlled when constructing ``Formatter`` objects which are then used
 to format numbers into strings according to the selected options.
 
 >>> from sciform import Formatter
->>> sform = Formatter(
+>>> formatter = Formatter(
 ...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
 ... )
->>> print(sform(51413.14159265359))
+>>> print(formatter(51413.14159265359))
 51 413.141 593
->>> sform = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
->>> print(sform(123456.78))
+>>> formatter = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
+>>> print(formatter(123456.78))
 123.5e+03
 
 Users can also format numbers by constructing ``SciNum`` objects and
@@ -158,11 +166,11 @@ to format pairs of numbers as value/uncertainty pairs.
 This can be done by passing two numbers into a ``Formatter`` call or by
 using the ``SciNum`` object.
 
->>> sform = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
->>> print(sform(123456.654321, 0.00345))
+>>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
+>>> print(formatter(123456.654321, 0.00345))
 123 456.654 3 ± 0.003 4
->>> sform = Formatter(ndigits=4, exp_mode="engineering")
->>> print(sform(123456.654321, 0.00345))
+>>> formatter = Formatter(ndigits=4, exp_mode="engineering")
+>>> print(formatter(123456.654321, 0.00345))
 (123.456654321 ± 0.000003450)e+03
 
 >>> num = SciNum(123456.654321, 0.00345)

sciform-0.34.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+sciform/__init__.py,sha256=S6-oZ4wA-h2iFlpUhrRLDSycdn5b8kRd5s5xGI64-a8,844
+sciform/format_utils.py,sha256=JNFlSxxM9K3M1KI5oLyTsPPzAsvgKDQAGgxPN3wqG_I,16545
+sciform/formatter.py,sha256=paVP2I6IO9y7lvkFB7_tMGFikfp7MS9PSlSG5zPWrzQ,15057
+sciform/formatting.py,sha256=Z2jLIeuqMm6JWd_FurJ_-rU0Yr96jT-tb8CYEzjPgZA,12228
+sciform/fsml.py,sha256=r22RiBPrkDaiPgE2VQrtGms9aBmWqolymsmmnp-z57s,3378
+sciform/global_configuration.py,sha256=L3nORbdGOO6ZZk8Xv81lr8S95Od35CgxlpOsdJDxs44,6964
+sciform/grouping.py,sha256=1hZjjVKRUy477LGGFniZwwEHHBDaSb6E0K3SAeCACVY,1641
+sciform/modes.py,sha256=8slohyIPHeAdgq3aszoNq9RJl6ibageFqDMxeC9NhrQ,3893
+sciform/output_conversion.py,sha256=IwylcmSXdfIZlVaa7fplL0E0F6JdtJyoHC_T9ZwGYo8,5489
+sciform/prefix.py,sha256=1rJeKMs8m97V3ZvMzHikqXLDDINp9aEK0AI3YaCcRMw,596
+sciform/scinum.py,sha256=oqbXiENMwELQmhVF7sR6fcnBECqDV8GNyOLNIrNIB9I,1857
+sciform/options/__init__.py,sha256=tw_CZHaNrdixZoQyG6ZD5UMKkQxXok0qBQCxt28Gh20,51
+sciform/options/conversion.py,sha256=ReqASoGNQIfa-r5-HEGZxokENti_NRkAjRP-zrxY0EU,4124
+sciform/options/finalized_options.py,sha256=PNcoAiB_WccbqxRJ5o_WPLnqb_n3J_MDpFTKqJxdSBM,1388
+sciform/options/global_options.py,sha256=8493K2Yu47D8-Dr6rgVWVKAVo-aAVaPzFNEpG7X0IAk,782
+sciform/options/input_options.py,sha256=gGUhuZr_t89IVhHwpEbtzLV9hvjMXVdMCgwe9OghO4k,3788
+sciform/options/populated_options.py,sha256=rVExq0YXzpk9kk-KUVm2oGXQEH56jBDGtZZ2vTqLqqo,4999
+sciform/options/validation.py,sha256=O1UTe5yHA0eN7sTtDsMNBh-1t3C-lbPayGoW9kn7FSU,3527
+sciform-0.34.0.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
+sciform-0.34.0.dist-info/METADATA,sha256=wZhvWEVrSkst3jLEYmpX5imgbzg0IatMk861S37M0f4,8002
+sciform-0.34.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+sciform-0.34.0.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
+sciform-0.34.0.dist-info/RECORD,,

sciform/user_options.py

@@ -1,189 +0,0 @@
-"""UserOptions Dataclass which stores user input."""
-
-
-from __future__ import annotations
-
-from dataclasses import InitVar, asdict, dataclass
-from typing import get_args
-
-from sciform import global_options, modes
-from sciform.rendered_options import RenderedOptions
-
-
-@dataclass(frozen=True)
-class UserOptions:
-    """Dataclass storing user input."""
-
-    exp_mode: modes.ExpMode | None = None
-    exp_val: int | type(modes.AutoExpVal) | None = None
-    round_mode: modes.RoundMode | None = None
-    ndigits: int | type(modes.AutoDigits) | None = None
-    upper_separator: modes.UpperSeparators | None = None
-    decimal_separator: modes.DecimalSeparators | None = None
-    lower_separator: modes.LowerSeparators | None = None
-    sign_mode: modes.SignMode | None = None
-    fill_char: modes.FillChar | None = None
-    left_pad_dec_place: int | None = None
-    exp_format: modes.ExpFormat | None = None
-    extra_si_prefixes: dict[int, str] | None = None
-    extra_iec_prefixes: dict[int, str] | None = None
-    extra_parts_per_forms: dict[int, str] | None = None
-    capitalize: bool | None = None
-    superscript: bool | None = None
-    latex: bool | None = None
-    nan_inf_exp: bool | None = None
-    paren_uncertainty: bool | None = None
-    pdg_sig_figs: bool | None = None
-    left_pad_matching: bool | None = None
-    paren_uncertainty_separators: bool | None = None
-    pm_whitespace: bool | None = None
-
-    add_c_prefix: InitVar[bool] = False
-    add_small_si_prefixes: InitVar[bool] = False
-    add_ppth_form: InitVar[bool] = False
-
-    def __post_init__(
-        self: UserOptions,
-        add_c_prefix: bool,  # noqa: FBT001
-        add_small_si_prefixes: bool,  # noqa: FBT001
-        add_ppth_form: bool,  # noqa: FBT001
-    ) -> None:
-        self.populate_dicts(
-            add_c_prefix=add_c_prefix,
-            add_small_si_prefixes=add_small_si_prefixes,
-            add_ppth_form=add_ppth_form,
-        )
-        self.validate(self)
-
-    def populate_dicts(  # noqa: C901
-        self: UserOptions,
-        *,
-        add_c_prefix: bool,
-        add_small_si_prefixes: bool,
-        add_ppth_form: bool,
-    ) -> None:
-        """Populate extra prefix translations from user input flags."""
-        if add_c_prefix:
-            if self.extra_si_prefixes is None:
-                super().__setattr__("extra_si_prefixes", {})
-            if -2 not in self.extra_si_prefixes:
-                self.extra_si_prefixes[-2] = "c"
-
-        if add_small_si_prefixes:
-            if self.extra_si_prefixes is None:
-                super().__setattr__("extra_si_prefixes", {})
-            if -2 not in self.extra_si_prefixes:
-                self.extra_si_prefixes[-2] = "c"
-            if -1 not in self.extra_si_prefixes:
-                self.extra_si_prefixes[-1] = "d"
-            if +1 not in self.extra_si_prefixes:
-                self.extra_si_prefixes[+1] = "da"
-            if +2 not in self.extra_si_prefixes:
-                self.extra_si_prefixes[+2] = "h"
-
-        if add_ppth_form:
-            if self.extra_parts_per_forms is None:
-                super().__setattr__("extra_parts_per_forms", {})
-            if -3 not in self.extra_parts_per_forms:
-                self.extra_parts_per_forms[-3] = "ppth"
-
-    @staticmethod
-    def validate(options: UserOptions | RenderedOptions) -> None:
-        """Validate user inputs."""
-        if (
-            options.round_mode == "sig_fig"
-            and isinstance(options.ndigits, int)
-            and options.ndigits < 1
-        ):
-            msg = f"ndigits must be >= 1 for sig fig rounding, not {options.ndigits}."
-            raise ValueError(msg)
-
-        if options.exp_val is not modes.AutoExpVal and options.exp_val is not None:
-            if options.exp_mode in ["fixed_point", "percent"] and options.exp_val != 0:
-                msg = (
-                    f"Exponent must must be 0, not exp_val={options.exp_val}, for "
-                    f"fixed point and percent exponent modes."
-                )
-                raise ValueError(msg)
-            if (
-                options.exp_mode in ["engineering", "engineering_shifted"]
-                and options.exp_val % 3 != 0
-            ):
-                msg = (
-                    f"Exponent must be a multiple of 3, not exp_val={options.exp_val}, "
-                    f"for engineering exponent modes."
-                )
-                raise ValueError(msg)
-            if options.exp_mode == "binary_iec" and options.exp_val % 10 != 0:
-                msg = (
-                    f"Exponent must be a multiple of 10, not "
-                    f"exp_val={options.exp_val}, for binary IEC exponent mode."
-                )
-                raise ValueError(msg)
-
-        UserOptions.validate_separators(options)
-
-    @staticmethod
-    def validate_separators(options: UserOptions | RenderedOptions) -> None:
-        """Validate separator user input."""
-        if options.upper_separator is not None:
-            if options.upper_separator not in get_args(modes.UpperSeparators):
-                msg = (
-                    f"upper_separator must be in "
-                    f"{get_args(modes.UpperSeparators)}, not "
-                    f"{options.upper_separator}."
-                )
-                raise ValueError(msg)
-            if options.upper_separator == options.decimal_separator:
-                msg = (
-                    f"upper_separator and decimal_separator "
-                    f"({options.upper_separator}) cannot be equal."
-                )
-                raise ValueError(msg)
-
-        if options.decimal_separator is not None and (
-            options.decimal_separator not in get_args(modes.DecimalSeparators)
-        ):
-            msg = (
-                f"decimal_separator must be in "
-                f"{get_args(modes.DecimalSeparators)}, not "
-                f"{options.decimal_separator}."
-            )
-            raise ValueError(msg)
-
-        if options.lower_separator is not None and (
-            options.lower_separator not in get_args(modes.LowerSeparators)
-        ):
-            msg = (
-                f"lower_separator must be in {get_args(modes.LowerSeparators)}, "
-                f"not {options.lower_separator}."
-            )
-            raise ValueError(msg)
-
-    def render(self: UserOptions) -> RenderedOptions:
-        """Render UserOptions into RenderedOptions."""
-        key_to_enum_dict = {
-            "exp_mode": modes.ExpModeEnum,
-            "round_mode": modes.RoundModeEnum,
-            "upper_separator": modes.SeparatorEnum,
-            "decimal_separator": modes.SeparatorEnum,
-            "lower_separator": modes.SeparatorEnum,
-            "sign_mode": modes.SignModeEnum,
-            "fill_char": modes.FillCharEnum,
-            "exp_format": modes.ExpFormatEnum,
-        }
-
-        global_defaults_dict = asdict(global_options.GLOBAL_DEFAULT_OPTIONS)
-        kwargs = {}
-        for key, value in asdict(self).items():
-            if value is None:
-                rendered_value = global_defaults_dict[key]
-            elif isinstance(value, str):
-                enum = key_to_enum_dict[key]
-                rendered_value = modes.mode_str_to_enum(value, enum)
-            else:
-                rendered_value = value
-            kwargs[key] = rendered_value
-        rendered_options = RenderedOptions(**kwargs)
-        self.validate(rendered_options)
-        return rendered_options

sciform-0.32.3.dist-info/RECORD

@@ -1,18 +0,0 @@
-sciform/__init__.py,sha256=wlDN6uPm7XjcbFzDA9l7m_twcT59DkBWtox_Pss-j0k,558
-sciform/format_utils.py,sha256=rLC8o_2c0kGNi5jA2VCZIcw2241onw74OR-2RcTM4X4,18522
-sciform/formatter.py,sha256=fh7wVDbcNt6V0oQSufMqo1AYHy6hXNODbU0Yj3WvKh4,11653
-sciform/formatting.py,sha256=LXk7DnVnQIR2crCLvrxl0DhnDubGYEgLond5lwIKZxU,9505
-sciform/fsml.py,sha256=Q9fSQijNQ0Tjf8HRM3ok9_6xzY-yQuvUDxhlQX6eeTA,3345
-sciform/global_configuration.py,sha256=PoLi-ZXtrn4pYTpwo4EFhYSeiTBrQ6eYftWjooudqRE,6826
-sciform/global_options.py,sha256=UZXbpGog0CpqUvYaYebfnUWeh3HOobZn65J4H5KU1aw,946
-sciform/grouping.py,sha256=1hZjjVKRUy477LGGFniZwwEHHBDaSb6E0K3SAeCACVY,1641
-sciform/modes.py,sha256=YADkmk7UVp9egyc3rwiV0UfLD40sGPl0w4yOoIIo1dg,4001
-sciform/prefix.py,sha256=1rJeKMs8m97V3ZvMzHikqXLDDINp9aEK0AI3YaCcRMw,596
-sciform/rendered_options.py,sha256=gb-RBOth0P7o9L4VH97bkBiD56oZBzQP_BWrf_qJqOA,1582
-sciform/scinum.py,sha256=H29BrxPYakGkdAKmrCYnj91g0u6c_fym5Kh-kNsnNy8,1926
-sciform/user_options.py,sha256=KnXCMwZZ8np6wLPZ_YlvSZ78m_FzyMOefm6OMwxvtu4,7406
-sciform-0.32.3.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
-sciform-0.32.3.dist-info/METADATA,sha256=GazcbkZ0HyVSgMHKIuIsd1yGOyTMOW2o0Fhy_-pcHLQ,7668
-sciform-0.32.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sciform-0.32.3.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
-sciform-0.32.3.dist-info/RECORD,,