OpenFF Recharge documentation

openff-recharge

Source code for openff.recharge.esp.storage.exceptions

"""Exceptions raised when storing ESP and electric field data"""

from openff.recharge.utilities.exceptions import RechargeException


class IncompatibleDBVersion(RechargeException):
    """An exception raised when attempting to load an ESP store whose
    version does not match the version expected by the framework.
    """

    def __init__(self, found_version: int, expected_version: int):
        """

        Parameters
        ----------
        found_version
            The version of the database being loaded.
        expected_version
            The expected version of the database.
        """

        super().__init__(
            f"The database being loaded is currently at version {found_version} "
            f"while the framework expects a version of {expected_version}. There "
            f"is no way to upgrade the database at this time, although this may "
            f"be added in future versions. Either regenerate the database, or use "
            f"an older compatible version of the `openff-recharge` framework."
        )

        self.found_version = found_version
        self.expected_version = expected_version