Skip to content

pydvl.utils.exceptions

catch_and_raise_exception 

catch_and_raise_exception(
    catch_exception_type: Type[CatchExceptionType],
    raise_exception_factory: Callable[[CatchExceptionType], RaiseExceptionType],
) -> Callable

A decorator that catches exceptions of a specified exception type and raises another specified exception.

PARAMETER DESCRIPTION
catch_exception_type

The type of the exception to catch.

TYPE: Type[CatchExceptionType]

raise_exception_factory

A factory function that creates a new exception.

TYPE: Callable[[CatchExceptionType], RaiseExceptionType]

RETURNS DESCRIPTION
Callable

A decorator function that wraps the target function.
Example 
@catch_and_raise_exception(RuntimeError, lambda e: TorchLinalgEighException(e))
def safe_torch_linalg_eigh(*args, **kwargs):
    '''
    A wrapper around `torch.linalg.eigh` that safely handles potential runtime errors
    by raising a custom `TorchLinalgEighException` with more context,
    especially related to the issues reported in
    https://github.com/pytorch/pytorch/issues/92141.

    Args:
    *args: Positional arguments passed to `torch.linalg.eigh`.
    **kwargs: Keyword arguments passed to `torch.linalg.eigh`.

    Returns:
    The result of calling `torch.linalg.eigh` with the provided arguments.

    Raises:
    TorchLinalgEighException: If a `RuntimeError` occurs during the execution of
    `torch.linalg.eigh`.
    '''
    return torch.linalg.eigh(*args, **kwargs)
Source code in src/pydvl/utils/exceptions.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def catch_and_raise_exception(
    catch_exception_type: Type[CatchExceptionType],
    raise_exception_factory: Callable[[CatchExceptionType], RaiseExceptionType],
) -> Callable:
    """
    A decorator that catches exceptions of a specified exception type and raises
    another specified exception.

    Args:
        catch_exception_type: The type of the exception to catch.
        raise_exception_factory: A factory function that creates a new exception.

    Returns:
        A decorator function that wraps the target function.

    ??? Example

        ```python
        @catch_and_raise_exception(RuntimeError, lambda e: TorchLinalgEighException(e))
        def safe_torch_linalg_eigh(*args, **kwargs):
            '''
            A wrapper around `torch.linalg.eigh` that safely handles potential runtime errors
            by raising a custom `TorchLinalgEighException` with more context,
            especially related to the issues reported in
            https://github.com/pytorch/pytorch/issues/92141.

            Args:
            *args: Positional arguments passed to `torch.linalg.eigh`.
            **kwargs: Keyword arguments passed to `torch.linalg.eigh`.

            Returns:
            The result of calling `torch.linalg.eigh` with the provided arguments.

            Raises:
            TorchLinalgEighException: If a `RuntimeError` occurs during the execution of
            `torch.linalg.eigh`.
            '''
            return torch.linalg.eigh(*args, **kwargs)
        ```
    """

    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            try:
                return func(*args, **kwargs)
            except catch_exception_type as e:
                raise raise_exception_factory(e) from e

        return wrapper

    return decorator