Module core.utils.exceptions

Base Exceptions to use within the framework

These are the two exceptions that are expected to be used at the module level throughout Cdev. Within a module, it should have its own more precise exceptions, but they should be wrapped in these classes before being exposed at the module level. Any other error that is raised will be treated as an uncaught exception and not the responsibility of other modules.

Warning: Something is not correct but the process can continue running. Error: Something has reached a state that should terminate the process.

"""Base Exceptions to use within the framework

These are the two exceptions that are expected to be used at the module level throughout Cdev. Within a module, it should have its own more precise
exceptions, but they should be wrapped in these classes before being exposed at the module level. Any other error that is raised will be treated as
an uncaught exception and not the responsibility of other modules.

Warning: Something is not correct but the process can continue running.
Error: Something has reached a state that should terminate the process.

"""
import sys
from dataclasses import dataclass

from typing import List


@dataclass
class cdev_core_error(Exception):
    error_message: str
    help_message: str
    help_resources: List[str]


@dataclass
class wrapped_base_exception(cdev_core_error):
    original_exception: BaseException
    error_message: str
    help_message: str
    help_resources: List[str]


def wrap_base_exception(e: Exception) -> cdev_core_error:
    return wrapped_base_exception(
        original_exception=e,
        error_message="uncaught base exception",
        help_message="This error is unexpected.",
        help_resources=[],
    )


def end_process():
    sys.exit(1)

Functions

def end_process()

Expand source code

def end_process():
    sys.exit(1)

def wrap_base_exception(e: Exception) ‑> cdev_core_error

Expand source code

def wrap_base_exception(e: Exception) -> cdev_core_error:
    return wrapped_base_exception(
        original_exception=e,
        error_message="uncaught base exception",
        help_message="This error is unexpected.",
        help_resources=[],
    )

Classes

class cdev_core_error (error_message: str, help_message: str, help_resources: List[str])

cdev_core_error(error_message: str, help_message: str, help_resources: List[str])

Expand source code

class cdev_core_error(Exception):
    error_message: str
    help_message: str
    help_resources: List[str]

Ancestors

• builtins.Exception
• builtins.BaseException

Subclasses

• InputError
• BackendError
• BackendError
• SettingsError
• WorkspaceInfoError
• WorkspaceInitializationError
• ResourceNameError
• CommandFinderError
• wrapped_base_exception
• FinderError
• PackageManagerError
• ImportModuleError

Class variables

var error_message : str

var help_message : str

var help_resources : List[str]

class wrapped_base_exception (error_message: str, help_message: str, help_resources: List[str], original_exception: BaseException)

wrapped_base_exception(error_message: str, help_message: str, help_resources: List[str], original_exception: BaseException)

Expand source code

class wrapped_base_exception(cdev_core_error):
    original_exception: BaseException
    error_message: str
    help_message: str
    help_resources: List[str]

Ancestors

• cdev_core_error
• builtins.Exception
• builtins.BaseException

Class variables

var error_message : str

var help_message : str

var help_resources : List[str]

var original_exception : BaseException