add more properties

Author: NoureldinYosri

test/test_value.py

@@ -229,3 +229,28 @@ def test_divison_with_dimensionless_preserves_ratios() -> None:
     assert B / A == Value(1.2, 'GHz^-2')
 
     assert A / B == Value(10 / 12, 'GHz^2')
+
+
+def test_units() -> None:
+    A, B = Value(1, 'GHz^2'), Value(1200, 'MHz/GHz')
+    assert A.units == 'GHz^2'
+    assert B.units == 'MHz/GHz'
+
+
+def test_base_unit() -> None:
+    A, B = Value(1, 'GHz^2'), Value(1200, 'MHz/GHz')
+    assert A.base_unit == Value(1, 'Hz^2')
+    assert B.base_unit == Value(1, '')
+
+
+def test_name() -> None:
+    A, B = Value(1, 'GHz^2'), Value(1200, 'MHz/GHz')
+    assert A.name == 'GHz^2'
+    with pytest.raises(AssertionError):
+        _ = B.name
+
+
+def test_sign() -> None:
+    for x in np.linspace(-10, 10, 20):
+        v = Value(x, 'ns')
+        assert v.sign() == np.sign(x)

test/test_value_array.py

@@ -203,3 +203,21 @@ def test_divison_with_dimensionless_preserves_ratios() -> None:
     assert B / A == ValueArray([1.2], 'GHz^-2')
 
     assert A / B == ValueArray([10 / 12], 'GHz^2')
+
+
+def test_units() -> None:
+    A, B = Value(np.random.random(10), 'GHz^2'), Value(np.random.random(10), 'MHz/GHz')
+    assert A.units == 'GHz^2'
+    assert B.units == 'MHz/GHz'
+
+
+def test_base_unit() -> None:
+    A, B = Value(np.random.random(10), 'GHz^2'), Value(np.random.random(10), 'MHz/GHz')
+    assert A.base_unit == Value(1, 'Hz^2')
+    assert B.base_unit == Value(1, '')
+
+
+def test_sign() -> None:
+    for x in np.random.random((10, 3, 4)):
+        v = Value(x, 'ns')
+        np.testing.assert_equal(v.sign(), np.sign(x))

tunits/core/__init__.pyi

@@ -183,6 +183,9 @@ class WithUnit:
     real: 'Value' | 'ValueArray'
     imag: 'Value' | 'ValueArray'
     is_dimensionless: bool
+    units: str
+    base_unit: 'Value'
+    name: str
 
     def __init__(
         self, value: Any, unit: 'WithUnit' | UnitTerm | UnitArray | str | None = None
@@ -313,6 +316,7 @@ class Value(Generic[NumericalT], WithUnit, np.generic, SupportsIndex):
     def value_in_base_units(self) -> NumericalT: ...
     def __index__(self) -> int: ...
     def __pow__(self, other: Any, modulus: Any = None) -> Value: ...
+    def sign(self) -> int: ...
 
 class ValueArray(Generic[ValueType2], WithUnit):
     value: NDArray[Any]
@@ -373,6 +377,7 @@ class ValueArray(Generic[ValueType2], WithUnit):
         self, ufunc: Callable[..., Any], method: str, *inputs: Any, **kwargs: Any
     ) -> ValueArray: ...
     def __pow__(self, other: Any, modulus: Any = None) -> ValueArray: ...
+    def sign(self) -> NDArray[np.integer]: ...
 
 def init_base_unit_functions(
     try_interpret_as_with_unit: Callable[[Any, bool], WithUnit | None],

tunits/core/cython/with_unit.pyx

@@ -149,6 +149,17 @@ cdef class WithUnit:
     property exp10:
         def __get__(self):
             return self.conv.exp10
+    property units:
+        def __get__(self):
+            return str(self.display_units)
+    property base_unit:
+        def __get__(self):
+            return Value(1, str(self.base_units))
+
+    property name:
+        def __get__(self):
+            assert self.value == 1
+            return str(self.display_units)
 
     def __init__(WithUnit self, value, unit=None):
         """
@@ -655,6 +666,9 @@ cdef class WithUnit:
         except NotTUnitsLikeError:
             return NotImplemented
 
+    def sign(self) -> int | np.ndarray:
+        return np.sign(self.value_in_base_units())
+
 _try_interpret_as_with_unit = None
 _is_value_consistent_with_default_unit_database = None
 def init_base_unit_functions(