VOUnit

class astropy.units.format.VOUnit(*args, **kwargs)

Bases: Base, _GenericParserMixin

The IVOA standard for units used by the VO.

This is an implementation of Units in the VO 1.0.

Attributes Summary

name

Methods Summary

format_exponential_notation(val[, format_spec])	Formats a value in exponential notation.
parse(s[, debug])	Convert a string to a unit object.
to_string(unit[, fraction, deprecations])	Convert a unit to its string representation.

Attributes Documentation

name = 'vounit'

Methods Documentation

classmethod format_exponential_notation(val, format_spec='.8g')

Formats a value in exponential notation.

Parameters:

valnumber

The value to be formatted

format_specpython:str, optional

Format used to split up mantissa and exponent

Returns:

python:str

The value in exponential notation in a this class’s format.

classmethod parse(s, debug=False)

Convert a string to a unit object.

classmethod to_string(unit, fraction=False, deprecations=DeprecatedUnitAction.WARN)

Convert a unit to its string representation.

Implementation for to_string.

Parameters:

unit|Unit|

The unit to convert.

deprecations{“warn”, “silent”, “raise”, “convert”}, optional, keyword-only

Whether deprecated units should emit a warning, be handled silently or raise an error. The “convert” option replaces the deprecated unit if possible and emits a warning otherwise.

fraction{False|True|’inline’|’multiline’}, optional

Options are as follows:

• False : display unit bases with negative powers as they are (e.g., km s-1);

• ‘inline’ or True : use a single-line fraction (e.g., km / s);

• ‘multiline’ : use a multiline fraction if possible (available for the latex, console and unicode formats; e.g., $\mathrm{\frac{km}{s}}$). If not possible, use ‘inline’.

Raises:

ValueError

If fraction is not recognized.