oryx.core.reap

Transforms a function into one that returns its sown values.

oryx.core.reap(
    f,
    *,
    tag: Hashable,
    allowlist: Optional[Iterable[str]] = None,
    blocklist: Iterable[str] = frozenset(),
    exclusive: bool = False
)

f a function to be transformed.
tag a string tag; only sown values with tag will be reaped.
allowlist an optional sequence of string names, which if provided will enforce that only sows with names in the allowlist will be reaped.
blocklist an optional sequence of string names, which if provided will enforce that only no sows with names in the blocklist will be reaped.
exclusive determines whether or not to execute in "exclusive" mode where other tags are removed during execution.

A new function that executes the original and returns its sown values.