GitHub

Executor

API reference for Executor.

class Executor[R2 = Never]

breaker.execute(key=...): runs an effect through the circuit.

Functions

__init__

__init__(breaker, key, classify, on_rejection) -> None
ParameterTypeDescription
breakerCircuitBreakerService
keystr
classifyClassifier[Any, Any, R2] | None
on_rejectionOnRejection
def __init__(
    self,
    breaker: CircuitBreakerService,
    key: str,
    classify: Classifier[Any, Any, R2] | None,
    on_rejection: OnRejection,
) -> None:
    self._breaker = breaker
    self._key = key
    self._classify = classify
    self._on_rejection: OnRejection = on_rejection

__call__

__call__[A, E, R](effect) -> Effect[A, E | CircuitBreakerError, R | R2]
ParameterTypeDescription
effectEffect[A, E, R]

Returns Effect[A, E | CircuitBreakerError, R | R2]

def __call__[A, E, R](
    self, effect: Effect[A, E, R]
) -> Effect[A, E | CircuitBreakerError, R | R2]:
    require_effect(effect, "effect")
    return self._breaker.execute(
        effect, key=self._key, classify=self._classify, on_rejection=self._on_rejection
    )