Source code for bluecellulab.exceptions

# Copyright 2023-2024 Blue Brain Project / EPFL

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Custom exceptions used within the package."""


from contextlib import contextmanager



[docs]
class BluecellulabError(Exception):
    """Class to identify bluecellulab specific exceptions."""




[docs]
class TargetDoesNotExist(BluecellulabError):
    """It is raised upon calling a target that does not exist."""




[docs]
class UndefinedRNGException(BluecellulabError):
    """Raise when the RNG mode to be used does not exist."""




[docs]
class UnsteadyCellError(BluecellulabError):
    """Raise when the cell gives undesired spikes."""




[docs]
class ConfigError(BluecellulabError):
    """Error due to invalid settings in BlueConfig."""




[docs]
class NeuronEvalError(BluecellulabError):
    """Raise when an unsupported code string is sent to NEURON."""




[docs]
class MissingSonataPropertyError(BluecellulabError):
    """Raise when a property is missing from SONATA."""




[docs]
class ExtraDependencyMissingError(BluecellulabError):
    """Raise when an extra dependency is missing."""

    def __init__(self, dependency_name):
        self.dependency_name = dependency_name
        super().__init__(f"The extra dependency '{dependency_name}' is missing. "
                         f"Please install it to use this feature.")




[docs]
@contextmanager
def error_context(context_info: str):
    """Use when the attribute/lookup error needs more context information.

    Useful for NEURON/HOC attribute/lookup errors.
    E.g. 'AttributeError: 'hoc.HocObject' object has no attribute' or
    LookupError: 'X' is not a defined hoc variable name messages are
    often not very helpful. Extra context information can be added
    to the error message.
    """
    try:
        yield
    except AttributeError as e:
        raise AttributeError(f"{context_info}: {e}")
    except LookupError as e:
        raise LookupError(f"{context_info}: {e}")