TypedUnit 0.0.7__tar.gz → 0.0.8__tar.gz

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

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

typedunit-0.0.8/.gitignore

@@ -0,0 +1,33 @@
+
+# Ignore all
+/*
+
+# Except ...
+!.github
+!.gitmodules
+!extern
+!TypedUnit
+!development
+!docs
+!tests
+!.flake8
+!.gitignore
+!.pre-commit-config.yaml
+!LICENSE
+!meta.yaml
+!pyproject.toml
+!README.rst
+!notebook.ipynb
+!CMakeLists.txt
+
+# But ignore docs/build inside docs and code
+docs/build/
+docs/source/gallery/
+
+# Compiled files in the project
+*__pycache__*
+*.DS_Store*
+*.so*
+*.a*
+
+# Package specifics

typedunit-0.0.8/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - 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
+
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.0.7
+Version: 0.0.8
 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

{typedunit-0.0.7 → typedunit-0.0.8}/TypedUnit/__init__.py

@@ -6,4 +6,5 @@ except ImportError:
 
 
 from .units import *
-from .helper import validate_units
+from .helper import validate_units
+from .units import ureg, Quantity

{typedunit-0.0.7 → typedunit-0.0.8}/TypedUnit/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.7'
-__version_tuple__ = version_tuple = (0, 0, 7)
+__version__ = version = '0.0.8'
+__version_tuple__ = version_tuple = (0, 0, 8)
 
-__commit_id__ = commit_id = 'gdd1c6b1a7'
+__commit_id__ = commit_id = 'gad246e6a5'

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

@@ -13,11 +13,41 @@ ureg.define("event = [Int64]")  # Define a custom unit 'events'
 ureg.define("sqrt_hertz = Hz**0.5")
 ureg.define("bit_bins = ![Int64]")
 
+__all__ = [
+    "Energy",
+    "Time",
+    "Power",
+    "Voltage",
+    "Current",
+    "Resistance",
+    "Temperature",
+    "Length",
+    "Volume",
+    "FlowRate",
+    "Frequency",
+    "Angle",
+    "Mass",
+    "RefractiveIndex",
+    "Dimensionless",
+    "Responsitivity",
+    "Viscosity",
+    "Area",
+    "ElectricField",
+    "Velocity",
+    "Ohm",
+    "Concentration",
+    "Particle",
+    "ParticleFlux",
+    "AnyUnit",
+]
+
+
 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
@@ -44,7 +74,9 @@ 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"({getattr(cls, '_expected_dim')})*({getattr(other, '_expected_dim')})"
+        )
         return UnitMeta(name, (BaseUnit,), {"_expected_dim": expected})
 
     def __pow__(cls, power):
@@ -54,6 +86,7 @@ class UnitMeta(type):
         expected = f"({getattr(cls, '_expected_dim')})**{power}"
         return UnitMeta(name, (BaseUnit,), {"_expected_dim": expected})
 
+
 class BaseUnit(metaclass=UnitMeta):
     _expected_dim: str | None = None
 
@@ -61,151 +94,163 @@ class BaseUnit(metaclass=UnitMeta):
     def check(cls, value):
         if cls._expected_dim is None:
             return 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"
+        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 = ""
 
+
 class Responsitivity(BaseUnit):
     """Quantity specifically for responsitivity units."""
+
     _expected_dim = "ampere / watt"
 
+
 class Viscosity(BaseUnit):
     """Quantity specifically for viscosity units."""
+
     _expected_dim = "pascal * second"
 
+
 class Area(BaseUnit):
     """Quantity specifically for viscosity units."""
+
     _expected_dim = "meter * meter"
 
+
 class ElectricField(BaseUnit):
     """Quantity specifically for electric field units."""
+
     _expected_dim = "volt / meter"
 
+
 class Velocity(BaseUnit):
     """Quantity specifically for velocity units."""
+
     _expected_dim = "meter / second"
 
+
 class Ohm(BaseUnit):
     """Quantity specifically for resistance units."""
+
     _expected_dim = "ohm"
 
+
 class Concentration(BaseUnit):
     """Quantity specifically for concentration units."""
+
     _expected_dim = "particle / liter"
 
+
 class Particle(BaseUnit):
     """Quantity specifically for particle units."""
+
     _expected_dim = "particle"
 
+
 class ParticleFlux(BaseUnit):
     """Quantity specifically for particle flux units."""
+
     _expected_dim = "particle / second"
 
-class Any(BaseUnit):
-    """Quantity that can have any unit."""
-    _expected_dim = None  # Accept any dimensionality
 
 class AnyUnit(BaseUnit):
     """Quantity that can have any unit."""
-    _expected_dim = None  # Accept any dimensionality
-
-ureg.AU = ureg.dimensionless
-
-
-
-
-
-
-
-
-
-
-
-# from pydantic.dataclasses import dataclass
-
-# config_dict = dict(
-#     arbitrary_types_allowed=True,
-#     kw_only=True,
-#     slots=True,
-#     extra='forbid'
-# )
-
-
-
-
-# @dataclass(config=config_dict)
-# class Sphere():
-#     name: str
-#     refractive_index: RefractiveIndex
-#     diameter: Length
-#     particle_count: Particle
 
+    _expected_dim = None  # Accept any dimensionality
 
-# test = Sphere(
-#     name="Test Sphere",
-#     refractive_index=1 * ureg.refractive_index_units,
-#     diameter=1 * ureg.meter,
-#     particle_count=1 * 5e9 * ureg.particle / ureg.milliliter
-# )
 
-# print(test)
+ureg.AU = ureg.dimensionless

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.0.7
+Version: 0.0.8
 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

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

@@ -1,5 +1,6 @@
 .flake8
 .gitignore
+.pre-commit-config.yaml
 LICENSE
 README.rst
 meta.yaml
@@ -34,6 +35,5 @@ docs/source/sg_execution_times.rst
 docs/source/theory.rst
 docs/source/_static/default.css
 docs/source/_static/thumbnail.png
-docs/source/gallery/index.rst
 tests/__init__.py
 tests/test_0.py

typedunit-0.0.7/.gitignore

@@ -1,28 +0,0 @@
-# General patterns
-*.DS_store
-*.ipynb_checkpoints*
-*__pycache__*
-*.so
-*.a
-.coverage*
-*.pytest_cache
-htmlcov
-dist
-build
-*.egg*
-*.whl
-CMakeCache.txt
-CMakeFiles
-install_manifest.txt
-cmake_install.cmake
-wheelhouse
-
-# Docs-specific patterns
-docs/source/gallery/*
-!docs/source/gallery/index.rst
-PyOptik/data/**/test*
-PyOptik/data/**/example*
-
-# Override for documentation_build
-!documentation_build
-!documentation_build/**

typedunit-0.0.7/docs/source/gallery/index.rst

@@ -1,71 +0,0 @@
-:orphan:
-
-.. _examples_gallery:
-
-Coding examples
-===============
-
-Explore our gallery of examples demonstrating the usage of TypedUnits.
-
-
-
-.. raw:: html
-
-    <div class="sphx-glr-thumbnails">
-
-.. thumbnail-parent-div-open
-
-.. raw:: html
-
-    <div class="sphx-glr-thumbcontainer" tooltip="Workflow - 0">
-
-.. only:: html
-
-  .. image:: /gallery/images/thumb/sphx_glr_example_0_thumb.png
-    :alt:
-
-  :ref:`sphx_glr_gallery_example_0.py`
-
-.. raw:: html
-
-      <div class="sphx-glr-thumbnail-title">Workflow - 0</div>
-    </div>
-
-
-.. raw:: html
-
-    <div class="sphx-glr-thumbcontainer" tooltip="Workflow - 1">
-
-.. only:: html
-
-  .. image:: /gallery/images/thumb/sphx_glr_example_1_thumb.png
-    :alt:
-
-  :ref:`sphx_glr_gallery_example_1.py`
-
-.. raw:: html
-
-      <div class="sphx-glr-thumbnail-title">Workflow - 1</div>
-    </div>
-
-
-.. thumbnail-parent-div-close
-
-.. raw:: html
-
-    </div>
-
-
-.. toctree::
-   :hidden:
-
-   /gallery/example_0
-   /gallery/example_1
-
-
-
-.. only:: html
-
- .. rst-class:: sphx-glr-signature
-
-    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_