result package

A fully type-annotated Rust-like Result type for Python.

class Err(_error)

Bases: result.result._ResultMixin[result.result.T, result.result.E]

Err result type.

A value that signifies failure and which stores arbitrary data for the error.

Parameters

_error (~E) –

err()

Returns None if successful or an Exception type otherwise.

Return type

~E

unwrap()

Returns real return type if successful or None otherwise.

Return type

NoReturn

unwrap_or(default)

Returns real return type if successful or default otherwise.

Parameters

default (~T) –

Return type

~T

unwrap_or_else(op)

Returns real return type if successful or op(e) otherwise.

Parameters

op (Callable[[~E], ~T]) –

Return type

~T

class Ok(_value)

Bases: result.result._ResultMixin[result.result.T, result.result.E]

Ok result type.

A value that indicates success and which stores arbitrary data for the return value.

Parameters

_value (~T) –

static err()

Returns None if successful or an Exception type otherwise.

Return type

None

ok()

Return type

~T

unwrap()

Returns real return type if successful or None otherwise.

Return type

~T

unwrap_or(default)

Returns real return type if successful or default otherwise.

Parameters

default (~T) –

Return type

~T

unwrap_or_else(op)

Returns real return type if successful or op(e) otherwise.

Parameters

op (Callable[[~E], ~T]) –

Return type

~T

return_lazy_result(func)

Converts the return type of a function from result to a “lazy” result.

In order to fetch the real return type from lazy_result, you must call lazy_result.result() or any other valid Result method [e.g. lazy_result.unwrap()].

This decorator is useful when dealing with functions that return Result[None, E] (i.e. functions that are used soley for their side-effects), since it makes it harder to ignore potential errors.

Parameters

func (Callable[…, Union[Ok[~T, ~E], Err[~T, ~E]]]) –

Return type

Callable[…, _LazyResult[~T, ~E]]

Submodules