Skip to content

errors

Classes:

RESKitDeprecationError 

RESKitDeprecationError(commit_hash)

Bases: Exception

Custom exception for deprecation errors.

Raises an error stating that the method is deprecated and suggests a commit to check out when function is needed for backward compatibility.

commit_hash : str The has to the commit with the last working version of the deprecated method.

Source code in reskit/util/errors.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def __init__(self, commit_hash):
    """
    Raises an error stating that the method is deprecated and suggests
    a commit to check out when function is needed for backward
    compatibility.

    commit_hash : str
        The has to the commit with the last working version
        of the deprecated method.
    """
    # extract function name from where the error wwas raised
    caller_frame = inspect.currentframe().f_back
    calling_function_name = caller_frame.f_code.co_name
    # raise individual error
    message = f"'{calling_function_name}' is deprecated and should not be used anymore. Check out the last working version to reproduce results under: {commit_hash}"
    super().__init__(message)