Source code for astropy.coordinates.angles.errors

# Licensed under a 3-clause BSD style license - see LICENSE.rst

"""Custom angle errors and exceptions used in :mod:`astropy.coordinates.angles`."""

__all__ = [
    "BoundsError",
    "IllegalHourError",
    "IllegalHourWarning",
    "IllegalMinuteError",
    "IllegalMinuteWarning",
    "IllegalSecondError",
    "IllegalSecondWarning",
    "RangeError",
]

from astropy.utils.exceptions import AstropyWarning


[docs] class RangeError(ValueError): """ Raised when some part of an angle is out of its valid range. """
[docs] class BoundsError(RangeError): """ Raised when an angle is outside of its user-specified bounds. """
[docs] class IllegalHourError(RangeError): """ Raised when an hour value is not in the range [0,24). Parameters ---------- hour : int, float Examples -------- .. code-block:: python if not 0 <= hr < 24: raise IllegalHourError(hour) """ def __init__(self, hour): self.hour = hour def __str__(self): return ( f"An invalid value for 'hours' was found ('{self.hour}'); must be in the" " range [0,24)." )
[docs] class IllegalHourWarning(AstropyWarning): """ Raised when an hour value is 24. Parameters ---------- hour : int, float """ def __init__(self, hour, alternativeactionstr=None): self.hour = hour self.alternativeactionstr = alternativeactionstr def __str__(self): message = ( f"'hour' was found to be '{self.hour}', which is not in range (-24, 24)." ) if self.alternativeactionstr is not None: message += " " + self.alternativeactionstr return message
[docs] class IllegalMinuteError(RangeError): """ Raised when an minute value is not in the range [0,60]. Parameters ---------- minute : int, float Examples -------- .. code-block:: python if not 0 <= min < 60: raise IllegalMinuteError(minute) """ def __init__(self, minute): self.minute = minute def __str__(self): return ( f"An invalid value for 'minute' was found ('{self.minute}'); should be in" " the range [0,60)." )
[docs] class IllegalMinuteWarning(AstropyWarning): """ Raised when a minute value is 60. Parameters ---------- minute : int, float """ def __init__(self, minute, alternativeactionstr=None): self.minute = minute self.alternativeactionstr = alternativeactionstr def __str__(self): message = ( f"'minute' was found to be '{self.minute}', which is not in range [0,60)." ) if self.alternativeactionstr is not None: message += " " + self.alternativeactionstr return message
[docs] class IllegalSecondError(RangeError): """ Raised when an second value (time) is not in the range [0,60]. Parameters ---------- second : int, float Examples -------- .. code-block:: python if not 0 <= sec < 60: raise IllegalSecondError(second) """ def __init__(self, second): self.second = second def __str__(self): return ( f"An invalid value for 'second' was found ('{self.second}'); should be in" " the range [0,60)." )
[docs] class IllegalSecondWarning(AstropyWarning): """ Raised when a second value is 60. Parameters ---------- second : int, float """ def __init__(self, second, alternativeactionstr=None): self.second = second self.alternativeactionstr = alternativeactionstr def __str__(self): message = ( f"'second' was found to be '{self.second}', which is not in range [0,60)." ) if self.alternativeactionstr is not None: message += " " + self.alternativeactionstr return message