# Licensed under a 3-clause BSD style license - see LICENSE.rst
"""
Handles the "VOUnit" unit format.
"""
from __future__ import annotations
import re
import warnings
from typing import TYPE_CHECKING
from astropy.units.errors import UnitParserWarning, UnitScaleError, UnitsError
from astropy.utils import classproperty
from . import core, utils
from .fits import FITS
if TYPE_CHECKING:
from re import Pattern
from typing import ClassVar, Literal
import numpy as np
from astropy.extern.ply.lex import LexToken
from astropy.units import NamedUnit, UnitBase
[docs]
class VOUnit(FITS):
"""
The IVOA standard for units used by the VO.
This is an implementation of `Units in the VO 1.0
<http://www.ivoa.net/documents/VOUnits/>`_.
"""
_explicit_custom_unit_regex: ClassVar[Pattern[str]] = re.compile(
r"^[YZEPTGMkhdcmunpfazy]?'((?!\d)\w)+'$"
)
_custom_unit_regex: ClassVar[Pattern[str]] = re.compile(r"^((?!\d)\w)+$")
_custom_units: ClassVar[dict[str, UnitBase]] = {}
_space: ClassVar[str] = "."
_scale_unit_separator: ClassVar[str] = ""
@classproperty(lazy=True)
def _all_units(cls) -> tuple[dict[str, UnitBase], frozenset[str]]:
from astropy import units as u
from astropy.units import required_by_vounit as uvo
names = {}
deprecated_names = set()
# The tropical year is missing here compared to the standard
bases = [
"A", "a", "adu", "arcmin", "arcsec", "barn", "beam", "bin",
"C", "cd", "chan", "count", "ct", "d", "D", "deg", "erg", "eV",
"F", "g", "G", "H", "h", "Hz", "J", "Jy", "K", "lm", "lx", "lyr",
"m", "mag", "min", "mol", "N", "Ohm", "Pa", "pc", "ph", "photon",
"pix", "pixel", "R", "rad", "Ry", "s", "S", "solLum", "solMass",
"solRad", "sr", "T", "u", "V", "voxel", "W", "Wb", "yr",
] # fmt: skip
binary_bases = ["bit", "byte", "B"]
simple_units = ["Angstrom", "angstrom", "AU", "au", "Ba", "dB", "mas", "Sun"]
si_prefixes = [
"y", "z", "a", "f", "p", "n", "u", "m", "c", "d",
"", "da", "h", "k", "M", "G", "T", "P", "E", "Z", "Y"
] # fmt: skip
# While zebi and yobi are part of the standard for binary prefixes,
# they are not implemented here due to computation limitations
binary_prefixes = ["Ki", "Mi", "Gi", "Ti", "Pi", "Ei"]
deprecated_units = {"angstrom", "Angstrom", "Ba", "barn", "erg", "G", "ta"}
def do_defines(bases, prefixes, skips=[]):
for key, base in utils.get_non_keyword_units(bases, prefixes):
if key not in skips:
names[key] = getattr(u if hasattr(u, key) else uvo, key)
if base in deprecated_units:
deprecated_names.add(key)
do_defines(bases, si_prefixes, ["pct", "pcount", "yd"])
do_defines(binary_bases, si_prefixes + binary_prefixes, ["dB", "dbyte"])
do_defines(simple_units, [""])
return names, frozenset(deprecated_names)
@classproperty(lazy=True)
def _units(cls) -> dict[str, UnitBase]:
return cls._all_units[0]
@classproperty(lazy=True)
def _deprecated_units(cls) -> frozenset[str]:
return cls._all_units[1]
[docs]
@classmethod
def parse(cls, s: str, debug: bool = False) -> UnitBase:
if s in ("unknown", "UNKNOWN"):
return None
if s == "":
return core.dimensionless_unscaled
# Check for excess solidi, but exclude fractional exponents (allowed)
if s.count("/") > 1 and s.count("/") - len(re.findall(r"\(\d+/\d+\)", s)) > 1:
raise UnitsError(
f"'{s}' contains multiple slashes, which is "
"disallowed by the VOUnit standard."
)
result = cls._do_parse(s, debug=debug)
if hasattr(result, "function_unit"):
raise ValueError("Function units are not yet supported in VOUnit.")
return result
@classmethod
def _get_unit(cls, t: LexToken) -> UnitBase:
try:
return super()._get_unit(t)
except ValueError:
if cls._explicit_custom_unit_regex.match(t.value):
return cls._def_custom_unit(t.value)
if cls._custom_unit_regex.match(t.value):
warnings.warn(
UnitParserWarning(
f"Unit {t.value!r} not supported by the VOUnit standard. "
+ cls._did_you_mean_units(t.value)
)
)
return cls._def_custom_unit(t.value)
raise
@classmethod
def _parse_unit(cls, unit: str, detailed_exception: bool = True) -> UnitBase:
super()._validate_unit(unit, detailed_exception=False)
return cls._units[unit]
@classmethod
def _validate_unit(cls, unit: str, detailed_exception: bool = True) -> None:
if unit not in cls._custom_units:
super()._validate_unit(unit, detailed_exception)
@classmethod
def _get_unit_name(cls, unit: NamedUnit) -> str:
# The da- and d- prefixes are discouraged. This has the
# effect of adding a scale to value in the result.
if isinstance(unit, core.PrefixUnit):
if unit._represents.scale == 10.0:
raise ValueError(
f"In '{unit}': VOUnit can not represent units with the 'da' "
"(deka) prefix"
)
elif unit._represents.scale == 0.1:
raise ValueError(
f"In '{unit}': VOUnit can not represent units with the 'd' "
"(deci) prefix"
)
return super()._get_unit_name(unit)
@classmethod
def _def_custom_unit(cls, unit: str) -> UnitBase:
def def_base(name):
if name in cls._custom_units:
return cls._custom_units[name]
if name.startswith("'"):
return core.def_unit(
[name[1:-1], name],
format={"vounit": name},
namespace=cls._custom_units,
)
else:
return core.def_unit(name, namespace=cls._custom_units)
if unit in cls._custom_units:
return cls._custom_units[unit]
for short, full, factor in core.si_prefixes:
for prefix in short:
if unit.startswith(prefix):
base_name = unit[len(prefix) :]
base_unit = def_base(base_name)
return core.PrefixUnit(
[prefix + x for x in base_unit.names],
core.CompositeUnit(
factor, [base_unit], [1], _error_check=False
),
format={"vounit": prefix + base_unit.names[-1]},
namespace=cls._custom_units,
)
return def_base(unit)
@classmethod
def _format_superscript(cls, number: str) -> str:
return f"**({number})" if "/" in number or "." in number else f"**{number}"
@classmethod
def _format_inline_fraction(
cls, scale: str, numerator: str, denominator: str
) -> str:
if cls._space in denominator:
denominator = f"({denominator})"
if scale and numerator == "1":
return f"{scale}/{denominator}"
return f"{scale}{numerator}/{denominator}"
[docs]
@classmethod
def to_string(
cls, unit: UnitBase, fraction: bool | Literal["inline"] = False
) -> str:
# Remove units that aren't known to the format
unit = cls._decompose_to_known_units(unit)
if unit.physical_type == "dimensionless" and unit.scale != 1:
raise UnitScaleError(
"The VOUnit format is not able to "
"represent scale for dimensionless units. "
f"Multiply your data by {unit.scale:e}."
)
return cls._to_string(unit, fraction=fraction)
@classmethod
def _fix_deprecated(cls, x: str) -> list[str]:
return (
[f"{x} (deprecated)", cls.to_string(cls._units[x]._represents)]
if x in cls._deprecated_units
else [x]
)
@classmethod
def _try_decomposed(cls, unit: UnitBase) -> str:
return cls.to_string(unit._represents)
