TypedUnit 0.0.8__tar.gz → 0.2.4__tar.gz

typedunit-0.2.4/.coveragerc

@@ -0,0 +1,22 @@
+# .coveragerc
+[run]
+source = TypedUnit
+branch = True
+relative_files = True
+parallel = True
+omit =
+    **/__init__.py
+    TypedUnit/_version.py
+    TypedUnit/directories.py
+    TypedUnit/**/__main__.py
+
+[report]
+skip_covered = True
+show_missing = True
+precision = 2
+
+[html]
+directory = htmlcov
+
+[xml]
+output = coverage.xml

{typedunit-0.0.8 → typedunit-0.2.4}/.github/dependabot.yml

@@ -6,6 +6,5 @@ updates:
     directory: "/"
     target-branch: "master"
     schedule:
-      interval: "monthly"
-      day: "sunday"
+      interval: "quarterly"
       time: "09:00"

typedunit-0.2.4/.github/workflows/deploy_PyPi.yml

@@ -0,0 +1,18 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      python-version: "3.11"
+      # The reusable workflow wraps this command in double quotes.
+      test-command: python -c 'import TypedUnit; print(TypedUnit.__version__)'
+    secrets:
+      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

typedunit-0.2.4/.github/workflows/deploy_anaconda.yml

@@ -0,0 +1,21 @@
+name: Publish Conda package
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_compiled_package_to_anaconda.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      # One noarch archive supports all declared Python versions; test it on 3.14.
+      python_versions: '["3.14"]'
+      os_list: '["ubuntu-latest"]'
+      package_name: typedunit
+      recipe_path: conda.recipe
+      test_import: TypedUnit
+    secrets:
+      ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}

typedunit-0.2.4/.github/workflows/deploy_coverage.yml

@@ -0,0 +1,21 @@
+name: Publish coverage
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  coverage:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_coverage.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      python-version: "3.11"
+      apt-package: xvfb
+      coverage-package: TypedUnit
+    secrets:
+      _GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

typedunit-0.2.4/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,58 @@
+name: Publish documentation
+
+on:
+  push:
+    branches: [master]
+    tags: ["v*"]
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  documentation:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      python-version: "3.11"
+      package-name: TypedUnit
+      apt-package: xvfb jq
+
+  maintain_documentation:
+    needs: documentation
+    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install documentation landing page
+        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          ref: documentation_page
+          fetch-depth: 0
+      - run: |
+          set -Eeuo pipefail
+          git show "${GITHUB_SHA}:docs/redirect.html" > index.html
+          test -s docs/latest/index.html
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add index.html
+          if git diff --cached --quiet; then exit 0; fi
+          git commit -m "Update documentation landing page [skip ci]"
+          git push origin HEAD:documentation_page
+
+  publish_pages:
+    needs: maintain_documentation
+    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          ref: documentation_page
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: .
+      - id: deployment
+        uses: actions/deploy-pages@v4

typedunit-0.2.4/.github/workflows/quality.yml

@@ -0,0 +1,22 @@
+name: Static quality checks
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python and CI dependencies
+        uses: MartinPdeS/MPSActions/actions/setup-python@a01969bc5af90666281f9d37acffdf6a4629763a
+        with:
+          python-version: "3.11"
+          install-command: >-
+            python -m pip install --upgrade pip && python -m pip install "ruff>=0.6,<1"
+      - run: python -m ruff check TypedUnit tests

typedunit-0.2.4/.github/workflows/tests.yml

@@ -0,0 +1,26 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.14"]
+    steps:
+      - name: Set up Python and CI dependencies
+        uses: MartinPdeS/MPSActions/actions/setup-python@a01969bc5af90666281f9d37acffdf6a4629763a
+        with:
+          python-version: "${{ matrix.python-version }}"
+          install-command: >-
+            python -m pip install --upgrade pip && python -m pip install -e ".[testing]"
+      - run: python -m pytest -q

{typedunit-0.0.8 → typedunit-0.2.4}/.gitignore

@@ -14,11 +14,18 @@
 !.gitignore
 !.pre-commit-config.yaml
 !LICENSE
-!meta.yaml
+!conda.recipe
+!conda.recipe/meta.yaml
 !pyproject.toml
 !README.rst
+!CONTRIBUTING.md
+!/Makefile
+!tools
+!tools/*.py
 !notebook.ipynb
 !CMakeLists.txt
+!pytest.ini
+!.coveragerc
 
 # But ignore docs/build inside docs and code
 docs/build/
@@ -29,5 +36,6 @@ docs/source/gallery/
 *.DS_Store*
 *.so*
 *.a*
+!Makefile
 
 # Package specifics

{typedunit-0.0.8 → typedunit-0.2.4}/.pre-commit-config.yaml

@@ -5,8 +5,6 @@ repos:
       - id: check-merge-conflict
       - id: end-of-file-fixer
       - id: mixed-line-ending
-      - id: check-yaml
-      - id: check-toml
       - id: detect-private-key
       - id: check-json
       - id: check-case-conflict

typedunit-0.2.4/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing to TypedUnit
+
+Use Python 3.10 or newer. Install development dependencies with `python -m pip install -e ".[testing,documentation]"`, then run `python -m pytest`.
+
+Releases use semantic version tags. Run `make patch`, `make minor`, or `make major` from a clean `master` checkout; the command creates the release commit, tags it, and pushes both. Publishing workflows run only for `v*` tags.
+
+The Conda recipe is at `conda.recipe/meta.yaml`. Do not commit generated documentation, virtual environments, build artefacts, or caches.

typedunit-0.2.4/Makefile

@@ -0,0 +1,15 @@
+PYTHON ?= python3
+
+.PHONY: release tag patch minor major
+
+release:
+	@set -eu; release_tag="$$( $(PYTHON) tools/next_release_version.py $(BUMP) )"; \
+	$(PYTHON) tools/release_tag.py "$$release_tag"; \
+	git push origin HEAD "refs/tags/$$release_tag"
+
+tag:
+	@set -eu; release_tag="$$( $(PYTHON) tools/next_release_version.py $(BUMP) )"; \
+	$(PYTHON) tools/release_tag.py "$$release_tag"
+
+patch minor major:
+	@$(MAKE) release BUMP=$@

{typedunit-0.0.8 → typedunit-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.0.8
+Version: 0.2.4
 Summary: A package wrapping pint for handling typed units in Python.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -33,6 +33,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics
@@ -41,17 +42,18 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pint
+Requires-Dist: pint<0.26,>=0.24
 Requires-Dist: numpy
 Requires-Dist: matplotlib
 Requires-Dist: pint_pandas
 Provides-Extra: testing
-Requires-Dist: pytest<9.0,>=7.4; extra == "testing"
+Requires-Dist: pytest<10.0,>=7.4; extra == "testing"
 Requires-Dist: pytest-cov<7,>=2; extra == "testing"
 Requires-Dist: pytest-json-report~=1.5; extra == "testing"
 Requires-Dist: flake8==7.3.0; extra == "testing"
 Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
+Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
 Requires-Dist: numpydoc~=1.8; extra == "documentation"
 Requires-Dist: sphinx>=6; extra == "documentation"
 Requires-Dist: sphinx-gallery~=0.17; extra == "documentation"
@@ -240,8 +242,6 @@ TypedUnits is open source and contributions are welcome! Whether you're fixing b
 
 **Email:** `martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=TypedUnits>`_
 
-----
-
 .. |python| image:: https://img.shields.io/pypi/pyversions/typedunits.svg
    :target: https://www.python.org/
    :alt: Python version

{typedunit-0.0.8 → typedunit-0.2.4}/README.rst

@@ -179,8 +179,6 @@ TypedUnits is open source and contributions are welcome! Whether you're fixing b
 
 **Email:** `martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=TypedUnits>`_
 
-----
-
 .. |python| image:: https://img.shields.io/pypi/pyversions/typedunits.svg
    :target: https://www.python.org/
    :alt: Python version

typedunit-0.2.4/TypedUnit/__init__.py

@@ -0,0 +1,10 @@
+try:
+    from ._version import __version__ as __version__
+
+except ImportError:
+    __version__ = "0.0.0"
+
+from TypedUnit.helper import validate_units as validate_units
+from TypedUnit.units import *  # noqa: F403 -- Re-export the unit module's public types.
+from TypedUnit.units import Quantity as Quantity
+from TypedUnit.units import ureg as ureg

typedunit-0.2.4/TypedUnit/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.2.4'
+__version_tuple__ = version_tuple = (0, 2, 4)
+
+__commit_id__ = commit_id = 'g8caa1b260'

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit/directories.py

@@ -2,30 +2,30 @@
 # -*- coding: utf-8 -*-
 
 from pathlib import Path
-import TypedUnit
 
+import TypedUnit
 
 __all__ = [
-    'root_path',
-    'project_path',
-    'doc_path',
-    'doc_css_path',
+    "root_path",
+    "project_path",
+    "doc_path",
+    "doc_css_path",
 ]
 
 root_path = Path(TypedUnit.__path__[0])
 
 project_path = root_path.parents[0]
 
-example_directory = root_path.joinpath('examples')
+example_directory = root_path.joinpath("examples")
 
-doc_path = project_path.joinpath('docs')
+doc_path = project_path.joinpath("docs")
 
-examples_path = project_path.joinpath('docs/examples')
+examples_path = project_path.joinpath("docs/examples")
 
-doc_css_path = doc_path.joinpath('source/_static/default.css')
+doc_css_path = doc_path.joinpath("source/_static/default.css")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     for path_name in __all__:
         path = locals()[path_name]
         print(path)

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit/helper.py

@@ -1,6 +1,8 @@
-from TypedUnit.units import BaseUnit
-from typing import get_type_hints, get_origin, get_args, Union
 import inspect
+from typing import Union, get_args, get_origin, get_type_hints
+
+from TypedUnit.units import BaseUnit
+
 
 def _get_unit_type(hint):
     """Extract BaseUnit type from hint, handling Optional and List."""
@@ -14,16 +16,25 @@ def _get_unit_type(hint):
     if origin is Union:
         # Handle Optional[BaseUnit] (Union[BaseUnit, None])
         unit_types = [arg for arg in args if arg is not type(None)]
-        if len(unit_types) == 1 and inspect.isclass(unit_types[0]) and issubclass(unit_types[0], BaseUnit):
+        if (
+            len(unit_types) == 1
+            and inspect.isclass(unit_types[0])
+            and issubclass(unit_types[0], BaseUnit)
+        ):
             return unit_types[0], True, False  # Optional BaseUnit
 
     elif origin in (list, tuple):
         # Handle List[BaseUnit] or Tuple[BaseUnit]
-        if len(args) == 1 and inspect.isclass(args[0]) and issubclass(args[0], BaseUnit):
+        if (
+            len(args) == 1
+            and inspect.isclass(args[0])
+            and issubclass(args[0], BaseUnit)
+        ):
             return args[0], False, True  # List of BaseUnit
 
     return None, False, False
 
+
 def validate_units(function):
     def wrapper(*args, **kwargs):
         hints = get_type_hints(function)
@@ -55,13 +66,14 @@ def validate_units(function):
                     try:
                         unit_type.check(item)
                     except (AssertionError, ValueError) as e:
-                        raise ValueError(f"Parameter '{param_name}[{i}]': {e}")
+                        raise ValueError(f"Parameter '{param_name}[{i}]': {e}") from e
             else:
                 # Handle single values
                 try:
                     unit_type.check(value)
                 except (AssertionError, ValueError) as e:
-                    raise ValueError(f"Parameter '{param_name}': {e}")
+                    raise ValueError(f"Parameter '{param_name}': {e}") from e
 
         return function(*args, **kwargs)
-    return wrapper
+
+    return wrapper

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit/units.py

@@ -1,9 +1,9 @@
 # Initialize a unit registry
 import pint as _pint
+import pint_pandas as pint  # noqa: F401 -- Registers the pandas Pint extension.
 from pint import Quantity, UnitRegistry
-import pint_pandas as pint
 
-ureg = UnitRegistry()
+ureg = UnitRegistry(autoconvert_offset_to_baseunit=True)
 ureg.setup_matplotlib()
 
 _pint.set_application_registry(ureg)
@@ -12,6 +12,8 @@ ureg.define("photoelectron = [Float64]")  # Define a custom unit 'photoelectron'
 ureg.define("event = [Int64]")  # Define a custom unit 'events'
 ureg.define("sqrt_hertz = Hz**0.5")
 ureg.define("bit_bins = ![Int64]")
+ureg.define("dB_per_Hz = dB / hertz")
+
 
 __all__ = [
     "Energy",
@@ -63,7 +65,7 @@ class UnitMeta(type):
         num = cls.__name__
         den = other.__name__
         name = f"{num}Per{den}"
-        expected = f"{getattr(cls, '_expected_dim')}/{getattr(other, '_expected_dim')}"
+        expected = f"{cls._expected_dim}/{other._expected_dim}"
         # Create a new subclass that uses the same metaclass
         return UnitMeta(name, (BaseUnit,), {"_expected_dim": expected})
 
@@ -74,16 +76,14 @@ class UnitMeta(type):
         a = cls.__name__
         b = other.__name__
         name = f"{a}Times{b}"
-        expected = (
-            f"({getattr(cls, '_expected_dim')})*({getattr(other, '_expected_dim')})"
-        )
+        expected = f"({cls._expected_dim})*({other._expected_dim})"
         return UnitMeta(name, (BaseUnit,), {"_expected_dim": expected})
 
     def __pow__(cls, power):
         if not isinstance(power, int):
             return NotImplemented
         name = f"{cls.__name__}Pow{power}"
-        expected = f"({getattr(cls, '_expected_dim')})**{power}"
+        expected = f"({cls._expected_dim})**{power}"
         return UnitMeta(name, (BaseUnit,), {"_expected_dim": expected})
 
 
@@ -96,7 +96,7 @@ class BaseUnit(metaclass=UnitMeta):
             return value
         assert isinstance(
             value, Quantity
-        ), f"Expected a pint Quantity instance, got {type(value)}"
+        ), f"Expected a pint Quantity [{cls._expected_dim}] instance, got {type(value)}"
         assert value.check(
             cls._expected_dim
         ), f"Value units {value.dimensionality} do not match {cls.__name__} units"

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.0.8
+Version: 0.2.4
 Summary: A package wrapping pint for handling typed units in Python.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -33,6 +33,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics
@@ -41,17 +42,18 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pint
+Requires-Dist: pint<0.26,>=0.24
 Requires-Dist: numpy
 Requires-Dist: matplotlib
 Requires-Dist: pint_pandas
 Provides-Extra: testing
-Requires-Dist: pytest<9.0,>=7.4; extra == "testing"
+Requires-Dist: pytest<10.0,>=7.4; extra == "testing"
 Requires-Dist: pytest-cov<7,>=2; extra == "testing"
 Requires-Dist: pytest-json-report~=1.5; extra == "testing"
 Requires-Dist: flake8==7.3.0; extra == "testing"
 Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
+Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
 Requires-Dist: numpydoc~=1.8; extra == "documentation"
 Requires-Dist: sphinx>=6; extra == "documentation"
 Requires-Dist: sphinx-gallery~=0.17; extra == "documentation"
@@ -240,8 +242,6 @@ TypedUnits is open source and contributions are welcome! Whether you're fixing b
 
 **Email:** `martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=TypedUnits>`_
 
-----
-
 .. |python| image:: https://img.shields.io/pypi/pyversions/typedunits.svg
    :target: https://www.python.org/
    :alt: Python version

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit.egg-info/SOURCES.txt

@@ -1,15 +1,20 @@
+.coveragerc
 .flake8
 .gitignore
 .pre-commit-config.yaml
+CONTRIBUTING.md
 LICENSE
+Makefile
 README.rst
-meta.yaml
 pyproject.toml
+pytest.ini
 .github/dependabot.yml
 .github/workflows/deploy_PyPi.yml
 .github/workflows/deploy_anaconda.yml
 .github/workflows/deploy_coverage.yml
 .github/workflows/deploy_documentation.yml
+.github/workflows/quality.yml
+.github/workflows/tests.yml
 TypedUnit/__init__.py
 TypedUnit/_version.py
 TypedUnit/directories.py
@@ -20,9 +25,13 @@ TypedUnit.egg-info/PKG-INFO
 TypedUnit.egg-info/SOURCES.txt
 TypedUnit.egg-info/dependency_links.txt
 TypedUnit.egg-info/requires.txt
+TypedUnit.egg-info/scm_file_list.json
+TypedUnit.egg-info/scm_version.json
 TypedUnit.egg-info/top_level.txt
+conda.recipe/meta.yaml
 docs/Makefile
 docs/make.bat
+docs/redirect.html
 docs/examples/README.rst
 docs/examples/example_0.py
 docs/examples/example_1.py
@@ -34,6 +43,11 @@ docs/source/references.rst
 docs/source/sg_execution_times.rst
 docs/source/theory.rst
 docs/source/_static/default.css
+docs/source/_static/favicon.svg
+docs/source/_static/layout.css
+docs/source/_static/logo.svg
 docs/source/_static/thumbnail.png
 tests/__init__.py
-tests/test_0.py
+tests/test_0.py
+tools/next_release_version.py
+tools/release_tag.py

{typedunit-0.0.8 → typedunit-0.2.4}/TypedUnit.egg-info/requires.txt

@@ -1,9 +1,10 @@
-pint
+pint<0.26,>=0.24
 numpy
 matplotlib
 pint_pandas
 
 [documentation]
+MartinPdeS-docs<0.2,>=0.1.4
 numpydoc~=1.8
 sphinx>=6
 sphinx-gallery~=0.17
@@ -11,7 +12,7 @@ sphinx-rtd-theme<4,>=2
 pydata-sphinx-theme~=0.15
 
 [testing]
-pytest<9.0,>=7.4
+pytest<10.0,>=7.4
 pytest-cov<7,>=2
 pytest-json-report~=1.5
 flake8==7.3.0