Source code for TidalPy.exceptions

class TidalPyException(Exception):
    """ Default exception for all TidalPy-specific errors
    """

    default_message = 'A Default TidalPy Error Occurred.'

    def __init__(self, *args, **kwargs):

        # If no input is provided then the base exception will look at the class attribute 'default_message'
        #   and send that to sys.stderr
        if args or kwargs:
            super().__init__(*args)
        else:
            super().__init__(self.default_message)



# Package Errors


class IOException(TidalPyException):
    default_message = 'An issue arose when accessing system disk (either loading or saving data)'


# Initialization Errors


class InitializationError(TidalPyException):
    default_message = 'An issue occurred during TidalPy initialization.'


# General Errors


class NotYetImplementedError(TidalPyException):
    default_message = 'Tried to use functionality that is not yet implemented.'



# Argument Errors


class ArgumentException(TidalPyException):
    default_message = 'There was an error with one or more of a function or method arguments.'





class IncorrectArgumentType(ArgumentException):
    default_message = 'A method or function argument was provided the incorrect type.'





class MissingArgumentError(ArgumentException):
    default_message = 'One or more required argument(s) and/or key-word argument(s) were not provided.'



# TidalPy Value Error


class TidalPyValueException(TidalPyException):
    default_message = 'There is an issue with the value of a variable.'





class BadArrayShape(TidalPyValueException):
    default_message = 'TidalPy requires certain arrays maintain the same shape for all layers and planets. ' \
                      'It has found an array with an unexpected shape.'





class BadValueError(TidalPyValueException):
    default_message = 'An unrealistic value was encountered.'





class UnusualRealValueError(TidalPyValueException):
    default_message = 'An usually large or small value was encountered for a parameter. ' \
                      'Confirm proper dimensional units.'



# Class / OOP Error


class TidalPyOOPException(TidalPyException):
    default_message = 'There was an error with a TidalPy class or OOP process.'





class ImplementedBySubclassError(TidalPyOOPException):
    default_message = 'Trying to access sub-class functionality from a base class.'





class FailedForcedStateUpdate(TidalPyOOPException):
    default_message = 'The state of a class was forced to update but was unable to do so.'





class ReinitError(TidalPyOOPException):
    default_message = 'One or more critical parameters have changed since planet was made. ' \
                      'Construct new planet instead.'





class ReinitNotAllowedError(ReinitError):
    default_message = 'This class should be fully re-initialized upon load. ' \
                      'Partial reinit (via self.reinit()) is not supported.'



# Attribute/Property or Method Error


class AttributeException(TidalPyOOPException):
    default_message = 'There was a problem with one or more class attributes or methods.'



# # Property Handling


class ImproperPropertyHandling(AttributeException):
    default_message = 'The attribute you are attempting to set must be set by a different class or method.'





class IncorrectMethodToSetStateProperty(ImproperPropertyHandling):
    default_message = "This particular state property is set by a different method than the one attempted. It may be " \
                      "set by a different object entirely."





class InitiatedPropertyChangeError(ImproperPropertyHandling):
    default_message = "Attempted to change an initiated class property. These are set when an instance is created and " \
                      "can only be changed by that object's methods (or not at all). Try to make a new instance or " \
                      "use the object's methods instead of changing its initiated properties."





class ConfigPropertyChangeError(ImproperPropertyHandling):
    default_message = "Attempted to change a configuration class property. These must be changed in the " \
                      "world/layer's configuration (`<instance>.config`) followed by a call to its `reinit` method."





class ImproperGeometryPropertyHandling(ConfigPropertyChangeError):
    default_message = 'The attribute you are attempting to set must be set by the set_geometry method ' \
                      'or in the configurations.'





class OuterscopePropertySetError(ImproperPropertyHandling):
    default_message = "Attempted to set a property of an object from a separate object that is inside the scope of " \
                      "the first. Try to set this property to the outer object."





class InnerscopePropertySetError(ImproperPropertyHandling):
    default_message = "Attempted to set a property of an object that is inside the scope of the object where the " \
                      "setter was called from. Try to set this property to the object of interest."



# # Attribute Issues


class MissingAttributeError(AttributeException):
    default_message = 'The attribute you are attempting to access has not been set.'





class IncorrectAttributeType(AttributeException):
    default_message = 'An attribute was set with incorrect type.'





class AttributeNotSetError(AttributeException):
    default_message = 'An attribute has not been changed from its default value.'





class BadAttributeValueError(AttributeException):
    default_message = 'Bad value found in attribute setter.'



# Configuration Error


class ConfigurationException(TidalPyException):
    default_message = 'An error was encountered when handling a configuration, parameter, or model.'





class ModelException(ConfigurationException):
    default_message = 'An error was encountered when handling a model.'





class UnknownModelError(ModelException):
    default_message = 'A selected model, parameter, or switch is not currently supported.'





class IncompatibleModelError(ModelException):
    default_message = 'One or more model parameters are not compatible with each other'





class ParameterException(ConfigurationException):
    default_message = 'An error was encountered when handling a parameter.'





class ParameterMissingError(ParameterException):
    default_message = 'One or more parameter(s) or configuration(s) are missing and have no defaults. ' \
                      'Check that keys have correct spelling and capitalization.'





class ParameterTypeError(ParameterException):
    default_message = 'One or more parameters were found to have an incorrect type.'





class ParameterValueError(ParameterException):
    default_message = 'One or more parameter values are invalid or not supported.'





class IncompatibleModelConfigError(ConfigurationException):
    default_message = 'One or more model parameters are not compatible with each other'





class UnknownTidalPyConfigValue(ConfigurationException):
    default_message = 'A configuration set in TidalPy.configurations is not know or has not yet been implemented.'



# World Errors


class TidalPyWorldError(TidalPyOOPException):
    default_message = 'There was a problem related to the functionality or building of a TidalPy world.'





class UnknownWorld(TidalPyWorldError):
    default_message = 'User provided world name does not match any prebuilt world configs. ' \
                      'Check name or provide a manual configuration dictionary.'





class UnknownWorldType(TidalPyWorldError):
    default_message = 'A world type was encountered that is either unknown, contains a typo, or is not yet implemented.'





class TidalPyLayerError(TidalPyException):
    default_message = 'There was a problem related to the functionality or building of a TidalPy layer.'



# Orbit Errors


class TidalPyOrbitError(TidalPyOOPException):
    default_message = 'There was a problem related to the functionality or building of a TidalPy orbit.'





class BadWorldSignature(TidalPyOrbitError):
    default_message = 'A bad world signature was provided to an orbit class.'





class BadWorldSignatureType(BadWorldSignature):
    default_message = 'An unexpected type was encountered for a world signature provided to an orbit class.'



# TidalPy Integration Error


class TidalPyIntegrationException(TidalPyException):
    default_message = 'An issue arose during time integration.'





class SolutionFailedError(TidalPyIntegrationException):
    default_message = 'A solution was not able to be found.'





class IntegrationTimeOut(TidalPyIntegrationException):
    default_message = 'Integration was stopped due to long integration time'





class IntegrationFailed(TidalPyIntegrationException):
    default_message = 'Integration was not successful'