physpyx 2.1.1__tar.gz → 2.2.1__tar.gz

{physpyx-2.1.1 → physpyx-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: physpyx
-Version: 2.1.1
+Version: 2.2.1
 Summary: Provides a way to use python code in LaTeX
 Author: Jérôme Dufour
 Author-email: Jérôme Dufour <jerome.dufour@eduvaud.ch>

{physpyx-2.1.1 → physpyx-2.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "physpyx"
-version = "2.1.1"
+version = "2.2.1"
 authors = [
 	{ name="Jérôme Dufour", email="jerome.dufour@eduvaud.ch" },
 ]

{physpyx-2.1.1 → physpyx-2.2.1}/src/physpyx/__init__.py

@@ -1,6 +1,7 @@
 from .astronomy import Orbit
+from .context import NuclearContext
 from .nuclide import NuclideTable
 from .physpyx import PhysPyX
 from .qty import Qty
 
-__all__ = ["NuclideTable", "PhysPyX", "Qty", "Orbit"]
+__all__ = ["NuclideTable", "NuclearContext", "Orbit", "PhysPyX", "Qty"]

physpyx-2.2.1/src/physpyx/context.py

@@ -0,0 +1,35 @@
+from pint.facets.context import Context
+from pint.facets.plain.objects import UnitsContainer
+
+
+class SiunitxContext(Context):
+    preferred_units: dict[UnitsContainer, str]
+
+
+class NuclearContext(SiunitxContext):
+    def __init__(self, preferred_units: bool = True):
+        super().__init__("nuclear")
+        self.add_transformation(
+            "[mass]",
+            "[mass] * [length]**2 / [time]**2",
+            lambda ureg, x: x * ureg.speed_of_light * ureg.speed_of_light,
+        )
+        self.add_transformation(
+            "[mass] * [length]**2 / [time]**2",
+            "[mass]",
+            lambda ureg, x: x / ureg.speed_of_light / ureg.speed_of_light,
+        )
+        self.preferred_units = (
+            {
+                UnitsContainer({"[mass]": 1}): "amu",
+                UnitsContainer(
+                    {
+                        "[mass]": 1,
+                        "[length]": 2,
+                        "[time]": -2,
+                    }
+                ): "megaelectronvolt",
+            }
+            if preferred_units
+            else {}
+        )

{physpyx-2.1.1 → physpyx-2.2.1}/src/physpyx/qty.py

@@ -2,10 +2,16 @@ import re
 import sys
 
 from logging import getLogger
-from pint._typing import Scalar
+from typing import TYPE_CHECKING
+
+from pint.facets.context import Context
+
 from physpyx.manager import PTManager
 from physpyx.quantity import AltDict, Constants, SiunitxQuantity, SiunitxUnitRegistry
 
+if TYPE_CHECKING:
+    from pint._typing import Scalar
+
 logger = getLogger(__name__)
 
 
@@ -14,7 +20,7 @@ class Qty(PTManager):
     This class should be used as a context manager.
     """
 
-    def __init__(self, fname: str, context: str = ""):
+    def __init__(self, fname: str, context: Context | str = ""):
         """
         :param fname: name of the ".pyx" file saved on exit
         :param context: `Pint` feature that allows unit conversion. For Instance, if
@@ -24,18 +30,6 @@ class Qty(PTManager):
         super().__init__(fname)
         self._constants = Constants(self._fname.parent / "physpyx_constants.json")
         self._ureg = SiunitxUnitRegistry()
-        self._ureg.define("heure = hour")
-        self._ureg.define("heures = hours")
-        self._ureg.define("jour = day")
-        self._ureg.define("jours = days")
-        self._ureg.define("semaine = week")
-        self._ureg.define("semaines = weeks")
-        self._ureg.define("mois = month")
-        self._ureg.define("an = year")
-        self._ureg.define("ans = years")
-        self._ureg.define("celerity = speed_of_light")
-        self._ureg.define("chf = [currency] = franc")
-        self._ureg.define("ct = 0.01 * chf = centime")
         if context:
             self._ureg.enable_contexts(context)
 

{physpyx-2.1.1 → physpyx-2.2.1}/src/physpyx/quantity.py

@@ -2,12 +2,16 @@ from json import loads
 from logging import getLogger
 from numpy import cross, ndarray, linalg
 from pathlib import Path
-from pint._typing import Magnitude, UnitLike
 from pint.registry import GenericUnitRegistry, Quantity, Unit
-from typing import Generator, TypedDict, cast
+from pint.facets.context import Context
+from typing import TYPE_CHECKING, Any, Generator, TypedDict, cast
 
+from physpyx.context import SiunitxContext
 from physpyx.nuclide import NuclideTable
 
+if TYPE_CHECKING:
+    from pint._typing import Magnitude, UnitLike
+
 logger = getLogger(__name__)
 
 
@@ -40,29 +44,6 @@ class SiunitxQuantity(Quantity):
         "meter_Hg": "mHg",
         "watt_hour": "watthour",
     }
-    _preferred_units = {
-        Unit(name).dimensionality: name
-        for name in [
-            "meter",
-            "second",
-            "kilogram",
-            "ampere",
-            "kelvin",
-            "mole",
-            "meter per second",
-            "meter per second squared",
-            "newton",
-            "joule",
-            "watt",
-            "pascal",
-            "volt",
-            "ohm",
-            "tesla",
-            "henry",
-            "farad",
-            "coulomb",
-        ]
-    }
 
     def __new__(
         cls,
@@ -110,12 +91,7 @@ class SiunitxQuantity(Quantity):
         if self._base:
             quantity = cast(SiunitxQuantity, self.to_base_units())
         elif self._preferred:
-            quantity = cast(
-                SiunitxQuantity,
-                self.to(to)
-                if (to := self._preferred_units.get(self.dimensionality, None))
-                else self.to_reduced_units(),
-            )
+            quantity = self._REGISTRY.to_preferred_units(self)
         if self._compact:
             quantity = cast(SiunitxQuantity, self.to_compact())
 
@@ -170,6 +146,11 @@ class SiunitxQuantity(Quantity):
         # "PlainQuantity[Unknown]"'
         return cast(SiunitxQuantity, super().__neg__())
 
+    def __add__(self, other: object) -> "SiunitxQuantity":
+        # NOTE: to fix typing warning 'Cannot access attribute "???" for class
+        # "PlainQuantity[Unknown]"'
+        return cast(SiunitxQuantity, super().__add__(other))
+
     def _format_unit(self) -> str:
         num = ""
         den = ""
@@ -209,9 +190,8 @@ class SiunitxQuantity(Quantity):
                 else str(self),
             )
         except ValueError as e:
-            # TODO: report the correct error in
-            # PTManager.write_errorfile, not the one raised in
-            # PTManager.__exit__
+            # TODO: report the correct error in PTManager.write_errorfile, not
+            # the one raised in PTManager.__exit__
             logger.error(f"exporting {name} failed, {self._fmt}")
             e.add_note(f"exporting {name} failed")
             raise e
@@ -288,6 +268,58 @@ class SiunitxUnitRegistry(GenericUnitRegistry):
     Quantity: type = SiunitxQuantity
     Unit: type = Unit
 
+    def __init__(self):
+        super().__init__()
+        self.define("heure = hour")
+        self.define("heures = hours")
+        self.define("jour = day")
+        self.define("jours = days")
+        self.define("semaine = week")
+        self.define("semaines = weeks")
+        self.define("mois = month")
+        self.define("an = year")
+        self.define("ans = years")
+        self.define("celerity = speed_of_light")
+        self.define("chf = [currency] = franc")
+        self.define("ct = 0.01 * chf = centime")
+        self._preferred_units = {
+            Unit(name).dimensionality: name
+            for name in [
+                "meter",
+                "second",
+                "kilogram",
+                "ampere",
+                "kelvin",
+                "mole",
+                "meter per second",
+                "meter per second squared",
+                "newton",
+                "joule",
+                "watt",
+                "pascal",
+                "volt",
+                "ohm",
+                "tesla",
+                "henry",
+                "farad",
+                "coulomb",
+            ]
+        }
+
+    def enable_contexts(self, *names_or_contexts: str | Context, **kwargs: Any) -> None:
+        for context in names_or_contexts:
+            if isinstance(context, SiunitxContext):
+                self._preferred_units |= context.preferred_units
+        return super().enable_contexts(*names_or_contexts, **kwargs)
+
+    def to_preferred_units(self, qty: SiunitxQuantity) -> SiunitxQuantity:
+        return cast(
+            SiunitxQuantity,
+            qty.to(to)
+            if (to := self._preferred_units.get(qty.dimensionality, None))
+            else qty.to_reduced_units(),
+        )
+
 
 class Constants:
     _CONSTANTS = {