hydra.overlay.python.lib.optionals module

Python implementations of hydra.overlay.python.lib.optionals primitives.

hydra.overlay.python.lib.optionals.apply(f: object, x: object) → object

Apply a function to an argument (applicative).

hydra.overlay.python.lib.optionals.bind(x: object, f: Callable[[A], object]) → object

Chain operations on optional values, handling none cases automatically.

hydra.overlay.python.lib.optionals.compose(f: Callable[[A], object], g: Callable[[B], object], x: A) → object

Compose two optional-returning functions (Kleisli composition).

hydra.overlay.python.lib.optionals.given(x: A) → object

Lift a value into the optional type.

hydra.overlay.python.lib.optionals.givens(xs: Sequence[object]) → tuple

Filter out none values from a list.

hydra.overlay.python.lib.optionals.is_given(x: object) → bool

Check if a value is given.

hydra.overlay.python.lib.optionals.is_none(x: object) → bool

Check if a value is none.

hydra.overlay.python.lib.optionals.map(f: Callable[[A], B], x: object) → object

Map a function over an optional value.

hydra.overlay.python.lib.optionals.map_optional(f: Callable[[A], object], xs: Sequence[A]) → tuple

Map a function over a list and collect given results.

hydra.overlay.python.lib.optionals.match(m: object, n: B | Callable[[], B], j: Callable[[A], B]) → B

Handle an optional value with the maybe value as the first argument.

hydra.overlay.python.lib.optionals.to_list(x: object) → tuple

Convert an optional to a list: given x becomes [x], none becomes [].

hydra.overlay.python.lib.optionals.with_default(default: A | Callable[[], A], x: object) → A

Get a value from an optional value, or return a default value.