Source code for astropy.coordinates.errors
# -*- coding: utf-8 -*-
# Licensed under a 3-clause BSD style license - see LICENSE.rst
''' This module defines custom errors and exceptions used in astropy.coordinates.
'''
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from ..utils.exceptions import AstropyWarning
__all__ = ['RangeError', 'BoundsError', 'IllegalHourError',
'IllegalMinuteError', 'IllegalSecondError', 'ConvertError',
'IllegalHourWarning', 'IllegalMinuteWarning', 'IllegalSecondWarning']
[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 "An invalid value for 'hours' was found ('{0}'); must be in the range [0,24).".format(self.hour)
[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 = "'hour' was found to be '{0}', which is not in range (-24, 24).".format(self.hour)
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 "An invalid value for 'minute' was found ('{0}'); should be in the range [0,60).".format(self.minute)
[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 = "'minute' was found to be '{0}', which is not in range [0,60).".format(self.minute)
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 "An invalid value for 'second' was found ('{0}'); should be in the range [0,60).".format(self.second)
[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 = "'second' was found to be '{0}', which is not in range [0,60).".format(self.second)
if self.alternativeactionstr is not None:
message += ' ' + self.alternativeactionstr
return message
# TODO: consider if this should be used to `units`?
class UnitsError(ValueError):
"""
Raised if units are missing or invalid.
"""
[docs]class ConvertError(Exception):
"""
Raised if a coordinate system cannot be converted to another
"""