stdlibx.result package

exception stdlibx.result.ResultError[source]

Bases: Exception

exception stdlibx.result.ResultExpectError[source]

Bases: ResultError

exception stdlibx.result.ResultUnwrapError[source]

Bases: ResultError

stdlibx.result.and_(other)[source]
Parameters:

other (Result[U, F])

Return type:

Operation[Result[T, E], Result[U, Union[E, F]]]

stdlibx.result.and_then(func)[source]
Parameters:

func (Callable[[T], Result[U, F]])

Return type:

Operation[Result[T, E], Result[U, Union[E, F]]]

stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], /) Result[tuple[T1, T2], E1 | E2][source]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], /) Result[tuple[T1, T2, T3], E1 | E2 | E3]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], /) Result[tuple[T1, T2, T3, T4], E1 | E2 | E3 | E4]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], e: Result[T5, E5], /) Result[tuple[T1, T2, T3, T4, T5], E1 | E2 | E3 | E4 | E5]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], e: Result[T5, E5], f: Result[T6, E6], /) Result[tuple[T1, T2, T3, T4, T5, T6], E1 | E2 | E3 | E4 | E5 | E6]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], e: Result[T5, E5], f: Result[T6, E6], g: Result[T7, E7], /) Result[tuple[T1, T2, T3, T4, T5, T6, T7], E1 | E2 | E3 | E4 | E5 | E6 | E7]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], e: Result[T5, E5], f: Result[T6, E6], g: Result[T7, E7], h: Result[T8, E8], /) Result[tuple[T1, T2, T3, T4, T5, T6, T7, T8], E1 | E2 | E3 | E4 | E5 | E6 | E7 | E8]
stdlibx.result.collect(a: Result[T1, E1], b: Result[T2, E2], c: Result[T3, E3], d: Result[T4, E4], e: Result[T5, E5], f: Result[T6, E6], g: Result[T7, E7], h: Result[T8, E8], i: Result[T9, E9], /) Result[tuple[T1, T2, T3, T4, T5, T6, T7, T8, T9], E1 | E2 | E3 | E4 | E5 | E6 | E7 | E8 | E9]
Parameters:
  • initial (Result[Any, Any])

  • others (Result[Any, Any])

Return type:

Result[tuple[Any, …], Any]

stdlibx.result.collect_all(iterable)[source]
Parameters:

iterable (Iterable[Result[T, E]])

Return type:

Result[tuple[T, …], E]

stdlibx.result.error(error)[source]
Parameters:

error (E)

Return type:

Result[T, E]

stdlibx.result.expect(msg)[source]
Parameters:

msg (str)

Return type:

Operation[Result[T, E], T]

stdlibx.result.expect_err(msg)[source]
Parameters:

msg (str)

Return type:

Operation[Result[T, E], E]

stdlibx.result.flatten()[source]
Return type:

Operation[Result[Result[T, E], F], Result[T, Union[E, F]]]

stdlibx.result.get_error()[source]
Return type:

Operation[Result[T, E], Option[E]]

stdlibx.result.get_ok()[source]
Return type:

Operation[Result[T, E], Option[T]]

stdlibx.result.inspect(func)[source]
Parameters:

func (Callable[[T], None])

Return type:

Operation[Result[T, E], Result[T, E]]

stdlibx.result.inspect_err(func)[source]
Parameters:

func (Callable[[E], None])

Return type:

Operation[Result[T, E], Result[T, E]]

stdlibx.result.is_err(result)[source]
Parameters:

result (Result[T, E])

Return type:

TypeIs[Error[E]]

stdlibx.result.is_err_and(func)[source]
Parameters:

func (Callable[[E], bool])

Return type:

Operation[Result[T, E], bool]

stdlibx.result.is_ok(result)[source]
Parameters:

result (Result[T, E])

Return type:

TypeIs[Ok[T]]

stdlibx.result.is_ok_and(func)[source]
Parameters:

func (Callable[[T], bool])

Return type:

Operation[Result[T, E], bool]

stdlibx.result.map_(func)[source]
Parameters:

func (Callable[[T], U])

Return type:

Operation[Result[T, E], Result[U, E]]

stdlibx.result.map_err(func)[source]
Parameters:

func (Callable[[E], F])

Return type:

Operation[Result[T, E], Result[T, F]]

stdlibx.result.map_or(default, func)[source]
Parameters:
  • default (U)

  • func (Callable[[T], U])

Return type:

Operation[Result[T, E], U]

stdlibx.result.map_or_else(default, func)[source]
Parameters:
  • default (Callable[[E], U])

  • func (Callable[[T], U])

Return type:

Operation[Result[T, E], U]

stdlibx.result.ok(value)[source]
Parameters:

value (T)

Return type:

Result[T, E]

stdlibx.result.or_(default)[source]
Parameters:

default (Result[T, F])

Return type:

Operation[Result[T, E], Result[T, F]]

stdlibx.result.or_else(default)[source]
Parameters:

default (Callable[[E], Result[T, F]])

Return type:

Operation[Result[T, E], Result[T, F]]

stdlibx.result.safe(func)[source]
Parameters:

func (Callable[P, T])

Return type:

Callable[P, Result[T, Exception]]

stdlibx.result.transpose()[source]
Return type:

Operation[Result[Option[U], E], Option[Result[U, E]]]

stdlibx.result.try_(func, *args, **kwargs)[source]
Parameters:
  • func (Callable[P, T])

  • args (P.args)

  • kwargs (P.kwargs)

Return type:

Result[T, Exception]

stdlibx.result.unwrap()[source]
Return type:

Operation[Result[T, E], T]

stdlibx.result.unwrap_err()[source]
Return type:

Operation[Result[T, E], E]

stdlibx.result.unwrap_or(default)[source]
Parameters:

default (T)

Return type:

Operation[Result[T, E], T]

stdlibx.result.unwrap_or_else(default)[source]
Parameters:

default (Callable[[E], T])

Return type:

Operation[Result[T, E], T]

stdlibx.result.unwrap_or_raise()[source]
Return type:

Operation[Result[T, _AnyException], T]

stdlibx.result.zipped(func)[source]
Parameters:

func (Callable[[Unpack[Ts]], Result[U, E]])

Return type:

Operation[Result[tuple[Unpack[Ts]], E], Result[tuple[Unpack[Ts], U], E]]

Subpackages

Submodules