Skip to content

result

Module for result which every method in the module returns.

Error

Bases: Result[S, E]

Represents Error result class.

Source code in aniwrap/result.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class Error(Result[S, E]):
    """Represents Error result class."""

    __slots__ = ()

    def __init__(self, error) -> None:
        self._error = error

    @property
    def is_success(self) -> bool:
        """Returns `False` for success result."""

        return False

    @property
    def is_error(self) -> bool:
        """Returns `True` for success result."""

        return True

    @property
    def value(self) -> S:
        return None

    @property
    def error(self) -> E:
        return self._error

is_error property 

is_error: bool

Returns True for success result.

is_success property 

is_success: bool

Returns False for success result.

Result

Bases: Generic[S, E], ABC

Represents Result.

Source code in aniwrap/result.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class Result(Generic[S, E], abc.ABC):
    """Represents Result."""

    __slots__ = ("_error", "_value")

    def __init__(self, value, error) -> None:
        self._value = value
        self._error = error

    @property
    def is_success(self) -> bool:
        """Returns `True` for success result and `False` for error result."""

    @property
    def is_error(self) -> bool:
        """Returns `True` for error result and `False` for success result."""

    @property
    def value(self) -> S:
        """Returns data for a success result and `None` for an error result."""

    @property
    def error(self) -> E:
        """Returns error for an error result and `None` for a success result."""

error property 

error: E

Returns error for an error result and None for a success result.

is_error property 

is_error: bool

Returns True for error result and False for success result.

is_success property 

is_success: bool

Returns True for success result and False for error result.

value property 

value: S

Returns data for a success result and None for an error result.

Success

Bases: Result[S, E]

Reprsents Success result class.

Source code in aniwrap/result.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class Success(Result[S, E]):
    """Reprsents Success result class."""

    __slots__ = ()

    def __init__(self, value) -> None:
        self._value = value

    @property
    def is_success(self) -> bool:
        """Returns `True` for success result."""

        return True

    @property
    def is_error(self) -> bool:
        """Returns `False` for success result."""

        return False

    @property
    def value(self) -> S:
        return self._value

    @property
    def error(self) -> E:
        return None

is_error property 

is_error: bool

Returns False for success result.

is_success property 

is_success: bool

Returns True for success result.