minos.plugins.kafka.common

Classes

KafkaBrokerBuilderMixin	Kafka Broker Builder Mixin class.
KafkaCircuitBreakerMixin	Kafka Circuit Breaker Mixin class.

class KafkaCircuitBreakerMixin

Bases: CircuitBreakerMixin

Kafka Circuit Breaker Mixin class.

__init__(*args, circuit_breaker_exceptions=tuple(), **kwargs)

Parameters

circuit_breaker_exceptions (Iterable[type]) –

property circuit_breaker: aiomisc.circuit_breaker.CircuitBreaker

Get the circuit breaker.

Returns

A CircuitBreaker instance.

property circuit_breaker_exceptions: tuple[type[Exception]]

Get the circuit breaker exceptions.

Returns

A tuple of Exception types.

property is_circuit_breaker_broken: bool

Check if circuit breaker is passing.

Returns

A bool instance.

property is_circuit_breaker_passing: bool

Check if circuit breaker is passing.

Returns

A bool instance.

property is_circuit_breaker_recovering: bool

Check if circuit breaker is passing.

Returns

A bool instance.

async with_circuit_breaker(fn)

Execute the given function with circuit breaker.

Parameters

fn (Callable[[], Union[Awaitable[R], R]]) – The function to be executed.

Returns

The return of the given function.

Return type

R

class KafkaBrokerBuilderMixin

Bases: Builder

Kafka Broker Builder Mixin class.

with_config(config)

Set config.

Parameters

config (Config) – The config to be set.

Returns

This method return the builder instance.

__init__(instance_cls=None, *args, **kwargs)

Parameters

instance_cls (Optional[type[~Instance]]) –

property already_destroyed: bool

Already Destroy getter.

Returns

A boolean value.

property already_setup: bool

Already Setup getter.

Returns

A boolean value.

build()

Build the instance.

Returns

A Instance instance.

Return type

Instance

copy()

Get a copy of the instance.

Returns

A Builder instance.

Parameters

self (type[~B]) –

Return type

B

async destroy()

Destroy miscellaneous repository things.

Returns

This method does not return anything.

Return type

None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

• config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.

• kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

classmethod new()

Get a new instance.

Returns

A Builder instance.

Return type

B

async setup()

Setup miscellaneous repository things.

Returns

This method does not return anything.

Return type

None

with_cls(cls)

Set class to be built.

Parameters

• cls (type) – The class to be set.

• self (B) –

Returns

This method return the builder instance.

Return type

B

with_kwargs(kwargs)

Set kwargs.

Parameters

• kwargs (dict[str, Any]) – The kwargs to be set.

• self (B) –

Returns

This method return the builder instance.

Return type

B