join_unit

justunits.join_unit(attribute: Union[int, float, str], unit: Union[str, justunits.DerivedUnit, justunits.AUnit, justunits.UnknownUnit], target_format: Optional[int] = None) → str

Joins attribute and unit using one of six separators.

Parameters

  • attribute – The attribute’s name which the unit is attached to.

  • unit – The unit which is being attached.

  • target_format –

Returns

str

Examples

>>> import justunits
>>> from justunits import UnitStyle, AttributeUnitSeparators
>>> join_unit(1.23, "apples")
'1.23 [apples]'

>>> join_unit(1.23, "")
'1.23'

>>> join_unit(1.23, None)
'1.23'

>>> join_unit("max. pressure", "MPa", AttributeUnitSeparators.WHITESPACE_IN)
'max. pressure in MPa'

>>> join_unit("torque", "Nm", AttributeUnitSeparators.UNDERLINED_IN)
'torque_in_Nm'

>>> join_unit("distance", "mm", AttributeUnitSeparators.WHITESPACE_BOXED)
'distance [mm]'

>>> join_unit("distance", "mm", AttributeUnitSeparators.HASH_SIGN)
'distance#mm'

>>> join_unit(1.23, "apples", AttributeUnitSeparators.SINGLE_WHITESPACE)
'1.23 apples'

>>> join_unit("width", "mm", AttributeUnitSeparators.SINGLE_UNDERLINE)
'width_mm'

>>> stress = justunits.from_string("N/mm")
>>> stress
(AUnit(N 'newton' force, weight), AUnit(mm 'millimeter' length, 0.001m; power=-1))
>>> join_unit(1.23, stress, AttributeUnitSeparators.WHITESPACE_IN)
'1.23 in N/mm'