Skip to content

units

Loads and defines shared Units and Quantiies to be used.

Quantity = pint.Quantity module-attribute

Quantity type that contains a magnitude and a Unit.

Unit = pint.Unit module-attribute

Type for Units.

Units = pint.UnitRegistry() module-attribute

Unit registry, contains all common units (use lowercase and singular unit name as attribute).

quantity_to_str(quantity)

Converts a quantity to string, not adding dimensionless if there are no units.

Source code in mlte/measurement/units.py
17
18
19
20
21
22
23
def quantity_to_str(quantity: Quantity) -> str:  # type: ignore[type-arg]
    """Converts a quantity to string, not adding `dimensionless` if there are no units."""
    return (
        f"{quantity}"
        if str(quantity.units) != "dimensionless"
        else f"{quantity.magnitude}"
    )

str_to_unit(unit_str)

Converts string to Unit, returning None if it is None.

Source code in mlte/measurement/units.py
31
32
33
def str_to_unit(unit_str: Optional[str]) -> Optional[Unit]:
    """Converts string to Unit, returning None if it is None."""
    return Units.Unit(unit_str) if unit_str else None

unit_to_str(unit)

Converts unit to string, returning None if it is None.

Source code in mlte/measurement/units.py
26
27
28
def unit_to_str(unit: Optional[Unit]) -> Optional[str]:
    """Converts unit to string, returning None if it is None."""
    return str(unit) if unit else None