Source code for r2x_core.exceptions

"""Custom exceptions for r2x-core package."""


class R2XCoreError(Exception):
    """Base exception for all r2x-core errors."""




class ParserError(R2XCoreError):
    """Exception raised for parser-related errors.

    This exception is raised when there are issues during the parsing
    and system building process, such as invalid data, missing required
    files, or configuration errors.

    Parameters
    ----------
    message : str
        Description of the error.

    Examples
    --------
    >>> raise ParserError("Required file 'buses.csv' not found in data store")
    """





class ValidationError(R2XCoreError):
    """Exception raised for validation errors.

    This exception is raised when data or configuration validation fails,
    such as invalid years, missing required fields, or constraint violations.

    Parameters
    ----------
    message : str
        Description of the validation error.

    Examples
    --------
    >>> raise ValidationError("Model year 2019 not found in available years: [2020, 2025, 2030]")
    """





class ComponentCreationError(R2XCoreError):
    """Exception raised when component creation fails.

    This exception is raised when there are issues creating component instances,
    such as invalid field values or type mismatches.

    Parameters
    ----------
    message : str
        Description of the component creation error.

    Examples
    --------
    >>> raise ComponentCreationError("Failed to create Bus: missing required field 'voltage'")
    """





class ExporterError(R2XCoreError):
    """Exception raised for exporter-related errors.

    This exception is raised when there are issues during the export process,
    such as missing required components, invalid output formats, or file
    writing errors.

    Parameters
    ----------
    message : str
        Description of the error.

    Examples
    --------
    >>> raise ExporterError("No Generator components found in system")
    >>> raise ExporterError("Output directory does not exist: /path/to/output")
    """