sciform 0.37.0__tar.gz → 0.38.0__tar.gz

{sciform-0.37.0 → sciform-0.38.0}/.github/workflows/python-package.yml

@@ -28,22 +28,35 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -e .[dev]
+        python -m pip install -e .[test]
     - name: Lint/format source code and docs
       run: |
         ruff check .
         ruff format . --check
     - name: Test source code and docs
       run: |
-        coverage run -m unittest
-        coverage report
-        coverage xml
+        coverage run --rcfile=coverage_feature.toml
+        coverage report --rcfile=coverage_feature.toml
+        coverage xml --rcfile=coverage_feature.toml
+        coverage run --rcfile=coverage_unit.toml
+        coverage report --rcfile=coverage_unit.toml
+        coverage xml --rcfile=coverage_unit.toml
         python -m sphinx -b doctest docs/source/ docs/build/doctest/
-    - name: Upload coverage reports to Codecov
-      uses: codecov/codecov-action@v3
+    - name: Upload feature coverage reports to Codecov
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        flags: ${{ matrix.python-version }}
-        files: coverage.xml
+        flags: ${{ matrix.python-version }}, feature
+        file: ./cover/feature/coverage.xml
+        disable_search: true
+        fail_ci_if_error: true
+        verbose: true
+    - name: Upload unit coverage reports to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: ${{ matrix.python-version }}, unit
+        file: ./cover/unit/coverage.xml
+        disable_search: true
         fail_ci_if_error: true
         verbose: true

{sciform-0.37.0 → sciform-0.38.0}/.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.1.9
+    rev: v0.5.5
     hooks:
       # Run the linter.
       - id: ruff
+        args: [--fix]
       # Run the formatter.
       - id: ruff-format
-        args: [--check]

{sciform-0.37.0 → sciform-0.38.0}/CHANGELOG.rst

@@ -14,6 +14,82 @@ Unreleased
 
 ----
 
+0.38.0 (2024-11-02)
+-------------------
+
+Added
+^^^^^
+
+* Digits-past-the-decimal formatting (``round_mode="dec_place"``) is now
+  supported for value/uncertainty pairs.
+  [`#170 <https://github.com/jagerber48/sciform/issues/170>`_]
+* ``round_mode="all"`` and ``round_mode="pdg"`` options can now be
+  accessed in the FSML using ``"A"`` and ``"P"`` flags.
+  [`#192 <https://github.com/jagerber48/sciform/issues/192>`_]
+* Added a dark theme option (default on) for readthedocs documentation.
+* Added code coverage breakdown for unit and feature tests to codecov
+  CI.
+
+Changed
+^^^^^^^
+
+* **[BREAKING]** Rounding configuration has been refactored.
+  Previously ``round_mode`` accepted only ``"sig_fig"`` and
+  ``"dec_place"`` string literals, all digits rounding mode was selected
+  by settings ``ndigits = AutoDigits`` and PDG rounding mode was
+  selected by setting ``pdg_sig_figs = True``.
+  Now ``round_mode`` accepts ``"sig_fig"``, ``"dec_place"``, ``"pdg"``
+  and ``"all"`` string literals, ``ndigits`` only accepts integers, and
+  the ``pdg_sig_figs`` option is removed.
+  ``round_mode`` defaults to ``"all"`` and ``ndigits`` defaults to 2.
+  [`#185 <https://github.com/jagerber48/sciform/issues/185>`_]
+* **[BREAKING]** Previously ``exp_val`` and ``ndigits`` accepted the
+  enums ``AutoExpVal`` and ``AutoDigits``.
+  Now ``exp_val`` accepts the string literal ``"auto"`` and ``ndigits``
+  only accepts integers.
+  [`#178 <https://github.com/jagerber48/sciform/issues/178>`_,
+  `#185 <https://github.com/jagerber48/sciform/issues/185>`_]
+* Previously, significant figure rounding with a value of ``0`` would
+  result in trailing zeros being added in the formatted output.
+  For example, ``format(SciNum(0), "!3f")`` would give ``"0.00"`` or
+  ``format(SciNum(0, float("nan")), "!2f")`` would give ``"0.0 ± nan"``.
+  This is not reasonable because zero doesn't have any significant
+  figures, so it doesn't make sense to add more trailing zeros to
+  indicate additional "fake" significant figures.
+  Now if zero is used for significant figure rounding it always appears
+  directly as ``"0"``.
+  E.g. ``format(SciNum(0), "!3f")`` gives ``"0"`` and
+  ``format(SciNum(0, float("nan")), "!2f")`` gives ``"0 ± nan"``.
+  Note that, as before, trailing zeros may still be added to a zero
+  value if the uncertainty is less than one, e.g.
+  ``format(SciNum(0, 0.0012), "!2f")`` gives ``"0.0000 ± 0.0012"``.
+  [`#189 <https://github.com/jagerber48/sciform/issues/189>`_]
+* Previously the backend ``FinalizedOptions`` class ran a validation check on
+  itself after initialization.
+  This check has been removed in favor of not complicating the validation code
+  to handle the above change to ``exp_val`` and ``ndigits``.
+  Users never directly instantiate ``FinalizedOptions`` so this will hopefully
+  be no problem.
+  ``InputOptions`` continue to be validated because this is the direct result
+  of user input.
+  ``PopulatedOptions`` also must continue to be validated because options
+  conflicts due to the combination of user input with global options can arise
+  at options population time.
+* Update ``ruff`` version in pre-commit config.
+
+REMOVED
+^^^^^^^
+* The ``pdg_sig_figs`` options has been removed.
+  This option is now configured by setting ``round_mode="pdg"``.
+
+FIXED
+^^^^^
+
+* The ``ruff`` version in the github CI now matches the ``ruff`` in the local precommit
+  configuration.
+
+----
+
 0.37.0 (2024-03-07)
 -------------------
 

{sciform-0.37.0 → sciform-0.38.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.37.0
+Version: 0.38.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,42 +21,53 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 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"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-dark-mode; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-toolbox; extra == "docs"
+Provides-Extra: test
+Requires-Dist: coverage[toml]; extra == "test"
+Requires-Dist: numpy; extra == "test"
+Requires-Dist: ruff==0.5.5; extra == "test"
+Requires-Dist: sciform[docs]; extra == "test"
 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"
+Provides-Extra: all
+Requires-Dist: sciform[docs]; extra == "all"
+Requires-Dist: sciform[test]; extra == "all"
+Requires-Dist: sciform[examples]; extra == "all"
 
-.. image:: https://www.repostatus.org/badges/latest/wip.svg
+.. container::
+
+    |Repo Status| |pyOpenSci| |Documentation Status| |PyPI Version| |PyPI Python| |Coverage Status| |GH Workflow Status| |Zenodo|
+
+.. |Repo Status| image:: https://www.repostatus.org/badges/latest/wip.svg
      :target: https://www.repostatus.org/#wip
      :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
-.. image:: https://tinyurl.com/y22nb8up
+.. |pyOpenSci| image:: https://tinyurl.com/y22nb8up
      :target: https://github.com/pyOpenSci/software-review/issues/121
      :alt: pyOpenSci
-.. image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
+.. |Documentation Status| image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
      :target: https://sciform.readthedocs.io/en/stable/
      :alt: Read the Docs
-.. image:: https://img.shields.io/pypi/v/sciform?logo=pypi
+.. |PyPI Version| image:: https://img.shields.io/pypi/v/sciform?logo=pypi
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Version
-.. image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
+.. |PyPI Python| image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Python Version
-.. image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
+.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
      :target: https://codecov.io/gh/jagerber48/sciform
      :alt: Codecov
-.. image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
+.. |GH Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
      :target: https://github.com/jagerber48/sciform/blob/main/.github/workflows/python-package.yml
      :alt: GitHub Workflow Status
-.. image:: https://zenodo.org/badge/645611310.svg
+.. |Zenodo| image:: https://zenodo.org/badge/645611310.svg
      :target: https://zenodo.org/doi/10.5281/zenodo.10645272
      :alt: Zenodo
 
@@ -65,9 +76,9 @@ Requires-Dist: jupyter; extra == "examples"
 sciform
 #######
 
-|  **Repository:** `<https://github.com/jagerber48/sciform>`_
-|  **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
-|  **PyPi:** `<https://pypi.org/project/sciform/>`_
+| **Repository:** `<https://github.com/jagerber48/sciform>`_
+| **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
+| **PyPi:** `<https://pypi.org/project/sciform/>`_
 
 We would greatly appreciate you taking the time to fill out the
 `User Experience Survey <https://forms.gle/TkkKgywYyEMKu9U37>`_ to help
@@ -114,55 +125,55 @@ For many more details see
 
 ``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
->>> formatter = Formatter(
-...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
-... )
->>> print(formatter(51413.14159265359))
-51 413.141 593
->>> formatter = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.78))
-123.5e+03
+to format numbers into strings according to the selected options::
+
+  >>> from sciform import Formatter
+  >>> formatter = Formatter(
+  ...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
+  ... )
+  >>> print(formatter(51413.14159265359))
+  51 413.141 593
+  >>> 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
 using string formatting to format the ``SciNum`` instances according
-to a custom FSML.
+to a custom FSML::
 
->>> from sciform import SciNum
->>> num = SciNum(12345)
->>> print(f"{num:!2f}")
-12000
->>> print(f"{num:!2r}")
-12e+03
+  >>> from sciform import SciNum
+  >>> num = SciNum(12345)
+  >>> print(f"{num:!2f}")
+  12000
+  >>> print(f"{num:!2r}")
+  12e+03
 
 In addition to formatting individual numbers, ``sciform`` can be used
 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.
+using the ``SciNum`` object::
 
->>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
->>> print(formatter(123456.654321, 0.00345))
-123 456.654 3 ± 0.003 4
->>> formatter = Formatter(ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.654321, 0.00345))
-(123.456654321 ± 0.000003450)e+03
+  >>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
+  >>> print(formatter(123456.654321, 0.00345))
+  123 456.654 3 ± 0.003 4
+  >>> 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)
->>> print(f"{num:!2f}")
-123456.6543 ± 0.0034
->>> print(f"{num:!2f()}")
-123456.6543(34)
+  >>> num = SciNum(123456.654321, 0.00345)
+  >>> print(f"{num:!2f}")
+  123456.6543 ± 0.0034
+  >>> print(f"{num:!2f()}")
+  123456.6543(34)
 
 Note that the above examples demonstrate that ``sciform`` uses
 `"round-to-even" <https://en.wikipedia.org/wiki/Rounding#Rounding_half_to_even>`_
-rounding.
+rounding::
 
->>> print(f"{SciNum(865):!2}")
-860
->>> print(f"{SciNum(875):!2}")
-880
+  >>> print(f"{SciNum(865):!2}")
+  860
+  >>> print(f"{SciNum(875):!2}")
+  880
 
 See `Formatting Options <https://sciform.readthedocs.io/en/stable/options.html>`_,
 `Format Specification Mini-Language <https://sciform.readthedocs.io/en/stable/fsml.html>`_

{sciform-0.37.0 → sciform-0.38.0}/README.rst

@@ -1,25 +1,29 @@
-.. image:: https://www.repostatus.org/badges/latest/wip.svg
+.. container::
+
+    |Repo Status| |pyOpenSci| |Documentation Status| |PyPI Version| |PyPI Python| |Coverage Status| |GH Workflow Status| |Zenodo|
+
+.. |Repo Status| image:: https://www.repostatus.org/badges/latest/wip.svg
      :target: https://www.repostatus.org/#wip
      :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
-.. image:: https://tinyurl.com/y22nb8up
+.. |pyOpenSci| image:: https://tinyurl.com/y22nb8up
      :target: https://github.com/pyOpenSci/software-review/issues/121
      :alt: pyOpenSci
-.. image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
+.. |Documentation Status| image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
      :target: https://sciform.readthedocs.io/en/stable/
      :alt: Read the Docs
-.. image:: https://img.shields.io/pypi/v/sciform?logo=pypi
+.. |PyPI Version| image:: https://img.shields.io/pypi/v/sciform?logo=pypi
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Version
-.. image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
+.. |PyPI Python| image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Python Version
-.. image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
+.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
      :target: https://codecov.io/gh/jagerber48/sciform
      :alt: Codecov
-.. image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
+.. |GH Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
      :target: https://github.com/jagerber48/sciform/blob/main/.github/workflows/python-package.yml
      :alt: GitHub Workflow Status
-.. image:: https://zenodo.org/badge/645611310.svg
+.. |Zenodo| image:: https://zenodo.org/badge/645611310.svg
      :target: https://zenodo.org/doi/10.5281/zenodo.10645272
      :alt: Zenodo
 
@@ -28,9 +32,9 @@
 sciform
 #######
 
-|  **Repository:** `<https://github.com/jagerber48/sciform>`_
-|  **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
-|  **PyPi:** `<https://pypi.org/project/sciform/>`_
+| **Repository:** `<https://github.com/jagerber48/sciform>`_
+| **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
+| **PyPi:** `<https://pypi.org/project/sciform/>`_
 
 We would greatly appreciate you taking the time to fill out the
 `User Experience Survey <https://forms.gle/TkkKgywYyEMKu9U37>`_ to help
@@ -77,55 +81,55 @@ For many more details see
 
 ``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
->>> formatter = Formatter(
-...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
-... )
->>> print(formatter(51413.14159265359))
-51 413.141 593
->>> formatter = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.78))
-123.5e+03
+to format numbers into strings according to the selected options::
+
+  >>> from sciform import Formatter
+  >>> formatter = Formatter(
+  ...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
+  ... )
+  >>> print(formatter(51413.14159265359))
+  51 413.141 593
+  >>> 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
 using string formatting to format the ``SciNum`` instances according
-to a custom FSML.
+to a custom FSML::
 
->>> from sciform import SciNum
->>> num = SciNum(12345)
->>> print(f"{num:!2f}")
-12000
->>> print(f"{num:!2r}")
-12e+03
+  >>> from sciform import SciNum
+  >>> num = SciNum(12345)
+  >>> print(f"{num:!2f}")
+  12000
+  >>> print(f"{num:!2r}")
+  12e+03
 
 In addition to formatting individual numbers, ``sciform`` can be used
 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.
+using the ``SciNum`` object::
 
->>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
->>> print(formatter(123456.654321, 0.00345))
-123 456.654 3 ± 0.003 4
->>> formatter = Formatter(ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.654321, 0.00345))
-(123.456654321 ± 0.000003450)e+03
+  >>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
+  >>> print(formatter(123456.654321, 0.00345))
+  123 456.654 3 ± 0.003 4
+  >>> 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)
->>> print(f"{num:!2f}")
-123456.6543 ± 0.0034
->>> print(f"{num:!2f()}")
-123456.6543(34)
+  >>> num = SciNum(123456.654321, 0.00345)
+  >>> print(f"{num:!2f}")
+  123456.6543 ± 0.0034
+  >>> print(f"{num:!2f()}")
+  123456.6543(34)
 
 Note that the above examples demonstrate that ``sciform`` uses
 `"round-to-even" <https://en.wikipedia.org/wiki/Rounding#Rounding_half_to_even>`_
-rounding.
+rounding::
 
->>> print(f"{SciNum(865):!2}")
-860
->>> print(f"{SciNum(875):!2}")
-880
+  >>> print(f"{SciNum(865):!2}")
+  860
+  >>> print(f"{SciNum(875):!2}")
+  880
 
 See `Formatting Options <https://sciform.readthedocs.io/en/stable/options.html>`_,
 `Format Specification Mini-Language <https://sciform.readthedocs.io/en/stable/fsml.html>`_

sciform-0.38.0/coverage_feature.toml

@@ -0,0 +1,12 @@
+[tool.coverage.run]
+source = ["src/sciform/"]
+command_line = "-m unittest discover tests/feature/"
+dynamic_context = "test_function"
+data_file = "cover/feature/.coverage"
+
+[tool.coverage.html]
+directory = "cover/feature/html/"
+show_contexts = true
+
+[tool.coverage.xml]
+output = "cover/feature/coverage.xml"

sciform-0.38.0/coverage_unit.toml

@@ -0,0 +1,13 @@
+[tool.coverage.run]
+#source = ["src/sciform/format_utils/"]
+source = ["src/sciform/"]
+command_line = "-m unittest discover tests/unit/"
+dynamic_context = "test_function"
+data_file = "cover/unit/.coverage"
+
+[tool.coverage.html]
+directory = "cover/unit/html/"
+show_contexts = true
+
+[tool.coverage.xml]
+output = "cover/unit/coverage.xml"

sciform-0.38.0/docs/requirements.txt

@@ -0,0 +1 @@
+.[docs]

{sciform-0.37.0 → sciform-0.38.0}/docs/source/api.rst

@@ -2,7 +2,7 @@ API
 ###
 
 .. module:: sciform
-   :noindex:
+   :no-index:
 
 Formatting
 ==========
@@ -28,13 +28,6 @@ Options
 .. autoclass:: PopulatedOptions()
    :members:
 
-Auto Options
-============
-
-.. autoclass:: AutoExpVal()
-
-.. autoclass:: AutoDigits()
-
 Global Configuration
 ====================
 

{sciform-0.37.0 → sciform-0.38.0}/docs/source/conf.py

@@ -24,6 +24,7 @@ extensions = [
     "sphinx.ext.doctest",
     "sphinx.ext.todo",
     "sphinx_toolbox.collapse",
+    "sphinx_rtd_dark_mode",
 ]
 
 templates_path = ["_templates"]
@@ -39,6 +40,7 @@ html_theme_options = {
 }
 todo_include_todos = True
 todo_emit_warnings = True
+default_dark_mode = True
 
 autodoc_member_order = "bysource"