TypedUnit 0.0.3__py3-none-any.whl

TypedUnit/__init__.py

@@ -0,0 +1,9 @@
+try:
+    from ._version import version as __version__  # noqa: F401
+
+except ImportError:
+    __version__ = "0.0.0"
+
+
+from .units import *
+from .helper import validate_units

TypedUnit/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.3'
+__version_tuple__ = version_tuple = (0, 0, 3)
+
+__commit_id__ = commit_id = None

TypedUnit/directories.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from pathlib import Path
+import TypedUnit
+
+
+__all__ = [
+    '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')
+
+doc_path = project_path.joinpath('docs')
+
+examples_path = project_path.joinpath('docs/examples')
+
+doc_css_path = doc_path.joinpath('source/_static/default.css')
+
+
+if __name__ == '__main__':
+    for path_name in __all__:
+        path = locals()[path_name]
+        print(path)
+        assert path.exists(), f"Path {path_name} do not exists."
+
+# -

TypedUnit/helper.py

@@ -0,0 +1,20 @@
+from TypedUnit.units import BaseUnit
+
+from typing import get_type_hints
+
+def validate_units(function):
+    def wrapper(*args, **kwargs):
+        hints = get_type_hints(function)
+
+        for arg, hint in zip(args, hints.values()):
+            if isinstance(hint, BaseUnit):
+                hint.check(arg)
+
+        for kwarg_name, kwarg_value in kwargs.items():
+            if kwarg_name in hints:
+                hint = hints[kwarg_name]
+                if issubclass(hint, BaseUnit):
+                    hint.check(kwarg_value)
+
+        return function(*args, **kwargs)
+    return wrapper

TypedUnit/units.py

@@ -0,0 +1,106 @@
+# Initialize a unit registry
+from pint import Quantity, UnitRegistry
+
+ureg = UnitRegistry()
+
+# _scaled_units_str_list = [
+#     'watt', 'volt', 'meter', 'second', 'liter', 'hertz', 'ohm', 'ampere', 'joule', 'coulomb', 'kelvin', 'celsius', 'degree', 'particle'
+# ]
+
+# for _units_str in _scaled_units_str_list:
+#     for scale in ['femto', 'pico', 'nano', 'micro', 'milli', '', 'kilo', 'mega']:
+#         _unit = scale + _units_str
+#         globals()[_unit] = getattr(ureg, _unit)
+
+
+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]")
+
+class UnitMeta(type):
+    """
+    Metaclass that makes isinstance(x, SomeUnit) return True
+    when x is a pint.Quantity with the right dimensionality.
+    """
+    def __instancecheck__(cls, obj):
+        if not isinstance(obj, Quantity):
+            return False
+        expected = getattr(cls, "_expected_dim", None)
+        if expected is None:
+            return False
+        # Use pint's dimensionality check; accepts strings like "energy"
+        return obj.check(expected)
+
+class BaseUnit(metaclass=UnitMeta):
+    _expected_dim: str | None = None
+
+    @classmethod
+    def check(cls, value):
+        assert isinstance(value, Quantity), f"Expected a pint Quantity instance, got {type(value)}"
+        assert value.check(cls._expected_dim), f"Value units {value.dimensionality} do not match {cls.__name__} units"
+        return value
+
+
+class Energy(BaseUnit):
+    """Quantity specifically for energy units."""
+    _expected_dim = "joule"
+
+class Time(BaseUnit):
+    """Quantity specifically for time units."""
+    _expected_dim = "second"
+
+class Power(BaseUnit):
+    """Quantity specifically for power units."""
+    _expected_dim = "watt"
+
+class Voltage(BaseUnit):
+    """Quantity specifically for voltage units."""
+    _expected_dim = "volt"
+
+class Current(BaseUnit):
+    """Quantity specifically for current units."""
+    _expected_dim = "ampere"
+
+class Resistance(BaseUnit):
+    """Quantity specifically for resistance units."""
+    _expected_dim = "ohm"
+
+class Temperature(BaseUnit):
+    """Quantity specifically for temperature units."""
+    _expected_dim = "kelvin"
+
+class Length(BaseUnit):
+    """Quantity specifically for length units."""
+    _expected_dim = "meter"
+
+class Volume(BaseUnit):
+    """Quantity specifically for volume units."""
+    _expected_dim = "liter"
+
+class FlowRate(BaseUnit):
+    """Quantity specifically for flow rate units."""
+    _expected_dim = "liter / second"
+
+class Frequency(BaseUnit):
+    """Quantity specifically for frequency units."""
+    _expected_dim = "hertz"
+
+class Angle(BaseUnit):
+    """Quantity specifically for angle units."""
+    _expected_dim = "degree"
+
+class Mass(BaseUnit):
+    """Quantity specifically for mass units."""
+    _expected_dim = "kilogram"
+
+class RefractiveIndex(BaseUnit):
+    """Quantity specifically for refractive index units."""
+    _expected_dim = "refractive_index_units"
+
+class Dimensionless(BaseUnit):
+    """Quantity specifically for dimensionless units."""
+    _expected_dim = ""
+
+
+

typedunit-0.0.3.dist-info/METADATA

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: TypedUnit
+Version: 0.0.3
+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
+        
+        Copyright (c) 2020 Martin de Sivry
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/MartinPdeS/TypedUnit
+Project-URL: Documentation, https://martinpdes.github.io/TypedUnit/
+Project-URL: Repository, https://github.com/MartinPdeS/TypedUnit.git
+Keywords: typed units,pint,physical quantities
+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 :: Implementation :: CPython
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pint
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Provides-Extra: testing
+Requires-Dist: pytest<9.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: numpydoc~=1.8; extra == "documentation"
+Requires-Dist: sphinx>=6; extra == "documentation"
+Requires-Dist: sphinx-gallery~=0.17; extra == "documentation"
+Requires-Dist: sphinx-rtd-theme<4,>=2; extra == "documentation"
+Requires-Dist: pydata-sphinx-theme~=0.15; extra == "documentation"
+Dynamic: license-file
+
+TypedUnits
+===========
+
+|python| |docs| |coverage| |PyPi| |PyPi_download|
+
+**Type-safe physical units for Python**
+
+TypedUnits is a Python library that extends Pint with type safety and validation capabilities. It allows you to create unit-aware types that work seamlessly with Python's type system and provide runtime validation for physical quantities.
+
+**Key Features:**
+
+- **Type Safety**: Use `isinstance()` checks with unit types like `Energy`, `Time`, `Power`
+- **Automatic Validation**: Function decorators for unit validation based on type annotations
+- **Pydantic Integration**: Full compatibility with Pydantic dataclasses and models
+- **Normal Pint Usage**: Keep your existing Pint code - just add type safety on top
+
+----
+
+**Quick Example**
+
+.. code-block:: python
+
+   from TypedUnits import Energy, Time, Power, validate, ureg
+
+   # Normal Pint instantiation
+   energy = 100 * ureg.joule
+   time = 10 * ureg.second
+
+   # But now isinstance works!
+   assert isinstance(energy, Energy)  # True
+   assert isinstance(time, Time)      # True
+
+   @validate_units
+   def calculate_power(energy: Energy, time: Time) -> Power:
+       """Function with automatic unit validation."""
+       return (energy / time).to(ureg.watt)
+
+   # This works
+   power = calculate_power(energy, time)
+   print(f"Power: {power}")
+
+   # This fails with clear error message
+   length = 5 * ureg.meter
+   # calculate_power(length, time)  # TypeError: Expected Energy, got Length
+
+----
+
+**Installation**
+
+.. code-block:: bash
+
+   pip install TypedUnits
+
+----
+
+**Basic Usage**
+
+**Unit Type Checking**
+
+.. code-block:: python
+
+   from TypedUnits import Energy, Length, Mass, ureg
+
+   # Create quantities the normal way
+   kinetic_energy = 0.5 * 10 * ureg.kilogram * (5 * ureg.meter / ureg.second)**2
+   potential_energy = 10 * ureg.kilogram * 9.81 * ureg.meter / ureg.second**2 * 2 * ureg.meter
+   distance = 100 * ureg.meter
+   mass = 5 * ureg.kilogram
+
+   # Type checking works
+   assert isinstance(kinetic_energy, Energy)
+   assert isinstance(potential_energy, Energy)
+   assert isinstance(distance, Length)
+   assert isinstance(mass, Mass)
+
+**Function Validation**
+
+.. code-block:: python
+
+   from TypedUnits import validate_units, Energy, Time, Power
+
+   @validate_units
+   def calculate_work(power: Power, time: Time) -> Energy:
+       """Calculate work from power and time."""
+       return (power * time).to(ureg.joule)
+
+   power = 1500 * ureg.watt
+   time = 3600 * ureg.second  # 1 hour
+   work = calculate_work(power, time)
+   print(f"Work done: {work.to(ureg.kilowatt_hour)}")
+
+**Pydantic Integration**
+
+.. code-block:: python
+
+   from TypedUnits import Energy, Length, Mass
+   from pydantic.dataclasses import dataclass
+
+   @dataclass
+   class Projectile:
+      kinetic_energy: Energy
+      height: Length
+      mass: Mass
+
+   # Automatic validation on creation
+   projectile = Projectile(
+      kinetic_energy=500 * ureg.joule,
+      height=10 * ureg.meter,
+      mass=2 * ureg.kilogram
+   )
+
+----
+
+**Available Unit Types**
+
+TypedUnits includes common physical unit types:
+
+- **Mechanical**: `Energy`, `Power`, `Force`, `Pressure`
+- **Spatial**: `Length`, `Area`, `Volume`, `Angle`
+- **Temporal**: `Time`, `Frequency`
+- **Thermal**: `Temperature`, `ThermalConductivity`
+- **Electrical**: `Current`, `Voltage`, `Resistance`, `Capacitance`
+- **Optical**: `RefractiveIndex`, `Wavelength`, `ElectricField`
+- **Mass**: `Mass`, `Density`, `MolarMass`
+
+----
+
+**Advanced Features**
+
+**Custom Unit Types**
+
+.. code-block:: python
+
+   from TypedUnits import create_unit_type
+
+   # Create your own unit types
+   MagneticField = create_unit_type('MagneticField', '[magnetic_flux_density]')
+
+   field = 1.5 * ureg.tesla
+   assert isinstance(field, MagneticField)
+
+**Flexible Validation**
+
+.. code-block:: python
+
+   from TypedUnits import validate_enhanced
+
+   @validate_enhanced(strict_mode=False, convert_types=True)
+   def flexible_function(energy: Energy, count: int) -> str:
+       """Function with flexible validation options."""
+       return f"Energy per item: {energy / count}"
+
+----
+
+**Requirements**
+
+- Python ≥ 3.8
+- Pint ≥ 0.20
+- Pydantic ≥ 2.0 (optional, for dataclass integration)
+
+----
+
+**Testing**
+
+.. code-block:: bash
+
+   git clone https://github.com/MartinPdeS/TypedUnits.git
+   cd TypedUnits
+   pip install -e ".[testing]"
+   pytest
+
+----
+
+**Contributing**
+
+TypedUnits is open source and contributions are welcome! Whether you're fixing bugs, adding new unit types, or improving documentation, your help is appreciated.
+
+**Author:** `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdeS>`_
+
+**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
+
+.. |PyPi| image:: https://badge.fury.io/py/TypedUnits.svg
+   :target: https://pypi.org/project/TypedUnits/
+   :alt: PyPi
+
+.. |PyPi_download| image:: https://img.shields.io/pypi/dm/typedunits.svg
+   :target: https://pypistats.org/packages/typedunits
+   :alt: PyPi download statistics
+
+.. |docs| image:: https://github.com/martinpdes/typedunits/actions/workflows/deploy_documentation.yml/badge.svg
+   :target: https://martinpdes.github.io/TypedUnits/
+   :alt: Documentation Status
+
+.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/TypedUnits/python-coverage-comment-action-data/badge.svg
+   :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/TypedUnits/blob/python-coverage-comment-action-data/htmlcov/index.html
+   :alt: Unittest coverage

typedunit-0.0.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+TypedUnit/__init__.py,sha256=rW7CVYOuzJNfo6fm7xblpEkP5L5GDzbOse32vGSUl38,172
+TypedUnit/_version.py,sha256=pBZsQt6tlL02W-ri--X_4JCubpAK7jjCSnOmUp_isjc,704
+TypedUnit/directories.py,sha256=xxaISqOoX8imaYcHZRieg_4KCuRJNp3WMv7Vfi9nlkE,654
+TypedUnit/helper.py,sha256=GDv_LU145qLEFmD2RJqYoYEYL6uT8xq0helRmryzmUg,590
+TypedUnit/units.py,sha256=ys-DB_d37HaUez1SxvKfPS2baLi7XFcn04crzyQOIRg,3166
+TypedUnit/utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+typedunit-0.0.3.dist-info/licenses/LICENSE,sha256=U6YG4UEW9XJzHa53oijR0qw6JNN_SZ38WOBmYn3NPd0,1072
+typedunit-0.0.3.dist-info/METADATA,sha256=AJ56QRg6IMb8HYlz6UThbSxCpDtW0JtOj4N4jINYH5k,8595
+typedunit-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+typedunit-0.0.3.dist-info/top_level.txt,sha256=rlfYVNCpYMT-pzSijzyvXMPbE-V-DN0Z2YWw4uHwUnc,10
+typedunit-0.0.3.dist-info/RECORD,,

typedunit-0.0.3.dist-info/WHEEL

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

typedunit-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Martin de Sivry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

typedunit-0.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+TypedUnit