Source code for utils.exceptions_interface

"""
Module
------

    exceptions_interface.py

Description
-----------

    This module loads the exceptions package.

Classes
-------

    ArgumentsInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/arguments_interface module; it is a sub-class of Error.

    AWSCLIInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/awscli_interface module; it is a sub-class of Error.

    Boto3InterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/boto3_interface module; it is a sub-class of Error.

    CLIInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        execute/cli_interface module; it is a sub-class of Error.

    ContainerInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        execute/container_interface module; it is a sub-class of
        Error.

    CurlInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/curl_interface module; it is a sub-class of Error.

    DateTimeInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        tools/datetime_interface module; it is a sub-class of Error.

    EnviroInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/enviro_interface module; it is a sub-class of Error.

    GRIBInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/grib_interface module; it is a sub-class of Error.

    HashLibInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/hashlib_interface module; it is a sub-class of Error.

    Jinja2InterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/jinja2_interface module; it is a sub-class of Error.

    JSONInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/json_interface module; it is a sub-class of Error.

    NamelistInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/namelist_interface module; it is a sub-class of Error.

    NetCDF4InterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/netcdf4_interface module; it is a sub-class of Error.

    NOAAHPSSInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/noaahpss_interface module; it is a sub-class of Error.

    ParserInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        tools/parser_interface module; it is a sub-class of Error.

    SchemaInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/schema_interface module; it is a sub-class of Error.

    SQLite3InterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/sqlite3_interface module; it is a sub-class of Error.

    SubprocessInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        execute/subprocess_interface module; it is a sub-class of
        Error.

    TarFileInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/tarfile_interface module; it is a sub-class of Error.

    TCVitalsInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/tcvitalsinterface module; it is a sub-class of Error.

    TemplateInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/template_interface module; it is a sub-class of Error.

    TimestampInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        utils/timestamp_interface module; it is a sub-class of Error.

    URLInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/url_interface module; it is a sub-class of Error.

    UFSLoggerError(msg)

        This is the base-class for exceptions encountered within the
        scripts/ufs_logger.py application; is it a sub-class of Error.

    WgetInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/wget_interface module; it is a sub-class of Error.

    XArrayInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        ioapps/xarray_interface module; it is a sub-class of Error.

    XMLInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/xml_interface module; it is a sub-class of Error.

    YAMLInterfaceError(msg)

        This is the base-class for exceptions encountered within the
        confs/yaml_interface module; it is a sub-class of Error.

Author(s)
---------

    Henry R. Winterbottom; 28 December 2022

History
-------

    2022-12-28: Henry Winterbottom -- Initial implementation.

"""

# ----

from utils.error_interface import Error

# ----

# Define all available module properties.
__all__ = [
    "ArgumentsInterfaceError",
    "AWSCLIInterfaceError",
    "Boto3InterfaceError",
    "CLIInterfaceError",
    "ContainerInterfaceError",
    "CurlInterfaceError",
    "DateTimeInterfaceError",
    "EnviroInterfaceError",
    "GRIBInterfaceError",
    "HashLibInterfaceError",
    "Jinja2InterfaceError",
    "JSONInterfaceError",
    "NamelistInterfaceError",
    "NetCDF4InterfaceError",
    "NOAAHPSSInterfaceError",
    "ParserInterfaceError",
    "SchemaInterfaceError",
    "SQLite3InterfaceError",
    "SubprocessInterfaceError",
    "TarFileInterfaceError",
    "TCVitalsInterfaceError",
    "TemplateInterfaceError",
    "TimestampInterfaceError",
    "UFSLoggerError",
    "URLInterfaceError",
    "WgetInterfaceError",
    "XArrayInterfaceError",
    "XMLInterfaceError",
    "YAMLInterfaceError",
]

# ----


class ArgumentsInterfaceError(Error):
    """
    Description
    -----------

    This is the base-class for exceptions encountered within the
    utils/arguments_interface module; it is a sub-class of Error.

    """


# ----


[docs]class AWSCLIInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/awscli_interface module; it is a sub-class of Error. """
# ----
[docs]class Boto3InterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/boto3_interface module; it is a sub-class of Error. """
# ----
[docs]class CLIInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the execute/cli_interface module; it is a sub-class of Error. """
# ---- class ContainerInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the execute/container_interface module; it is a sub-class of Error. """ # ----
[docs]class CurlInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/curl_interface module; it is a sub-class of Error. """
# ----
[docs]class DateTimeInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the tools/datetime_interface module; it is a sub-class of Error. """
# ----
[docs]class EnviroInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/enviro_interface module; it is a sub-class of Error. """
# ----
[docs]class GRIBInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/grib_interface module; it is a sub-class of Error. """
# ----
[docs]class HashLibInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/hashlib_interface module; it is a sub-class of Error. """
# ----
[docs]class Jinja2InterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/jinja2_interface module; it is a sub-class of Error. """
# ----
[docs]class JSONInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/json_interface module; it is a sub-class of Error. """
# ---- class NamelistInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/namelist_interface module; it is a sub-class of Error. """ # ----
[docs]class NetCDF4InterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/netcdf4_interface module; it is a sub-class of Error. """
# ----
[docs]class NOAAHPSSInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/noaahpss_interface module; it is a sub-class of Error. """
# ----
[docs]class ParserInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the tools/parser_interface module; it is a sub-class of Error. """
# ----
[docs]class SchemaInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the utils/schema_interface module; it is a sub-class of Error. """
# ----
[docs]class SQLite3InterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/sqlite3_interface module; it is a sub-class of Error. """
# ----
[docs]class SubprocessInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the execute/subprocess_interface module; it is a sub-class of Error. """
# ----
[docs]class TarFileInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/tarfile_interface module; it is a sub-class of Error. """
# ---- class TCVitalsInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/tcvitals_interface module; it is a sub-class of Error. """ # ----
[docs]class TemplateInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/template_interface module; it is a sub-class of Error. """
# ----
[docs]class TimestampInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the utils/timestamp_interface module; it is a sub-class of Error. """
# ---- class UFSLoggerError(Error): """ Description ----------- This is the base-class for exceptions encountered within the scripts/ufs_logger.py application; is it a sub-class of Error. """ # ----
[docs]class URLInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/url_interface module; it is a sub-class of Error. """
# ----
[docs]class WgetInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/wget_interface module; it is a sub-class of Error. """
# ----
[docs]class XArrayInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the ioapps/xarray_interface module; it is a sub-class of Error. """
# ----
[docs]class XMLInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/xml_interface module; it is a sub-class of Error. """
# ----
[docs]class YAMLInterfaceError(Error): """ Description ----------- This is the base-class for exceptions encountered within the confs/yaml_interface module; it is a sub-class of Error. """