Skip to content

errors

Exception types raised by the library. Note that API errors do not raise - they come back as an Err; these exceptions cover misuse such as unwrapping the wrong Result variant.

This module contains various exceptions used by the project.

UnwrapError

Bases: WomError

Raised when calling unwrap() or unwrap_err() incorrectly.

Parameters:

Name Type Description Default
message str

The error message.

 required
Source code in wom/errors.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class UnwrapError(WomError):
    """Raised when calling [`unwrap()`][wom.Result.unwrap] or
    [`unwrap_err()`][wom.Result.unwrap_err] incorrectly.

    Parameters
    ----------
    message : str
        The error message.
    """

    __slots__ = ()

    def __init__(self, message: str) -> None:
        super().__init__(f"Unwrap failed: {message}")

WomError

Bases: Exception

The base error all wom errors inherit from.

Source code in wom/errors.py 
29
30
31
32
class WomError(Exception):
    """The base error all wom errors inherit from."""

    __slots__ = ()