opihiexarata.library.error module

Error, warning, and logging functionality pertinent to the function of Exarata.

exception opihiexarata.library.error.AccuracyWarning

Bases: ExarataWarning

This warning is to be used when something is not as accurate as it should be.

exception opihiexarata.library.error.BeyondScopeError(message: str = None)

Bases: ExarataBaseException

This is an error to be used when what is trying to be done does not seem reasonable. Usually warnings are the better thing for this but this error is used when the assumptions for reasonability guided development and what the user is trying to do is not currently supported by the software.

exception opihiexarata.library.error.CommandLineError(message: str = None)

Bases: ExarataException

An error to be used where the parameters or arguments entered in the command line were not correct.

exception opihiexarata.library.error.ConfigurationError(message: str = None)

Bases: ExarataException

An error to be used where the expectation of how configuration files and configuration parameters are structures are violated.

exception opihiexarata.library.error.DevelopmentError(message: str = None)

Bases: ExarataBaseException

This is an error where the development of OpihiExarata is not correct and something is not coded based on the expectations of the software itself. This is not the fault of the user.

exception opihiexarata.library.error.DirectoryError(message: str = None)

Bases: ExarataException

An error to be used when there are issues specifically with directories and not just files.

exception opihiexarata.library.error.EngineError(message: str = None)

Bases: ExarataException

This error is for when the astrometric, photometric, or asteroid-metric solver engines provided are not valid or expected. This error can also be used when an engine fails to solve or otherwise does not work as intended.

exception opihiexarata.library.error.ExarataBaseException(message: str = None)

Bases: BaseException

The base exception class. This is for exceptions that should never be caught and should bring everything to a halt.

__init__(message: str = None) → None

The initialization of a base exception for OpihiExarata.

Parameters:

message (string) – The message of the error message.

Return type:

None

exception opihiexarata.library.error.ExarataException(message: str = None)

Bases: Exception

The main inheriting class which all exceptions use as their base. This is done for ease of error handling and is something that can and should be managed.

__init__(message: str = None) → None

The initialization of a normal exception.

Parameters:

message (string) – The message of the error message.

Return type:

None

exception opihiexarata.library.error.ExarataWarning

Bases: UserWarning

The base warning class which all of the other OpihiExarata warnings are derived from.

exception opihiexarata.library.error.FileError(message: str = None)

Bases: ExarataException

An error to be used when obtaining data files or configuration files and something fails.

exception opihiexarata.library.error.FilterWarning

Bases: ExarataWarning

This warning is to be used when improper filters were used.

exception opihiexarata.library.error.InputError(message: str = None)

Bases: ExarataException

An error to be used when the inputs to a function are not valid and do not match the expectations of that function.

exception opihiexarata.library.error.InputWarning

Bases: ExarataWarning

This warning is to be used when something was incorrectly input.

exception opihiexarata.library.error.InstallError(message: str = None)

Bases: ExarataException

An error to be used when informing the user or the program that the installation was not done properly and lack some of the features and assumptions which are a consequence of it.

exception opihiexarata.library.error.IntentionalError(message: str = None)

Bases: ExarataException

An error to be used where error catching is helpful. This error generally should always be caught by the code in context.

exception opihiexarata.library.error.LogicFlowError(message: str = None)

Bases: ExarataBaseException

This is an error to ensure that the logic does not flow to a point to a place where it is not supposed to. This is helpful in making sure changes to the code do not screw up the logical flow of the program.

exception opihiexarata.library.error.PracticalityError(message: str = None)

Bases: ExarataException

This is an error to be used when what is trying to be done does not seem reasonable. Usually warnings are the better thing for this. However, this error should be used (as opposed to BeyondScopeError) when what is being attempted is within the design specifications of this software.

exception opihiexarata.library.error.ReadOnlyError(message: str = None)

Bases: ExarataException

An error where variables or files are assumed to be read only, this enforces that notion.

exception opihiexarata.library.error.SequentialOrderError(message: str = None)

Bases: ExarataException

An error used when something is happening out of the expected required order. This order being in place for specific publicly communicated reasons.

exception opihiexarata.library.error.SequentialOrderWarning

Bases: ExarataWarning

This warning is to be used when something is being done out of order or the specific order is not being followed..

exception opihiexarata.library.error.UndiscoveredError(message: str = None)

Bases: ExarataBaseException

This is an error used in cases where the source of the error has not been determined and so a more helpful error message or mitigation strategy cannot be devised.

exception opihiexarata.library.error.UnknownWarning

Bases: ExarataWarning

This warning is to be used when something was incorrectly input.

exception opihiexarata.library.error.WebRequestError(message: str = None)

Bases: ExarataException

An error to be used when a web request to some API fails, either because of something from their end, or our end.

opihiexarata.library.error.warn(warn_class: type[~opihiexarata.library.error.ExarataWarning] = <class 'opihiexarata.library.error.ExarataWarning'>, message: str = '', stacklevel: int = 2)

The common method to use to warn for any OpihiExarata based warnings.

This is used because it has better context manager wrappers.

Parameters:

• warn_class (type, default = ExarataWarning) – The warning class, it must be a subtype of a user warning.

• message (string, default = "") – The warning message.

• stacklevel (integer, default = 2) – The location in the stack that the warning call will highlight.

Return type:

None