minos.plugins.kafka.publisher

Classes

`KafkaBrokerPublisher`	Kafka Broker Publisher class.
`KafkaBrokerPublisherBuilder`	Kafka Broker Publisher Builder class.

class KafkaBrokerPublisher[source]

Bases: BrokerPublisher, KafkaCircuitBreakerMixin

Kafka Broker Publisher class.

__init__(*args, host=None, port=None, **kwargs)[source]

Parameters

host (Optional[str]) –
port (Optional[int]) –

property host: str

The host of kafka.

Returns: A str value.

property port: int

The port of kafka.

Returns: A int value.

property client: aiokafka.producer.producer.AIOKafkaProducer

Get the client instance.

Returns: An AIOKafkaProducer instance.

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

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.

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 get_builder()

Get the builder class.

Returns: A Builder instance.
Return type: Builder[Ins]

classmethod get_injectable_name()

Get the injectable name.

Returns: A str value.
Return type: str

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 send(message)

Send a message.

Parameters: message (BrokerMessage) – The message to be sent.
Returns: This method does not return anything.
Return type: None

classmethod set_builder(builder)

Set a builder class.

Parameters: builder (Union[Builder[Ins], type[minos.common.builders.Builder[~Ins]]]) – The builder class to be set.
Returns: This method does not return anything.
Return type: None

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

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 KafkaBrokerPublisherBuilder[source]

Bases: BrokerPublisherBuilder[KafkaBrokerPublisher], KafkaBrokerBuilderMixin

Kafka Broker Publisher Builder class.

__init__(*args, queue_builder=None, queued_cls=None, **kwargs)

Parameters

queue_builder (Optional[Builder]) –
queued_cls (Optional[type[QueuedBrokerPublisher]]) –

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 QueuedBrokerSubscriber instance.
Return type: BrokerPublisher

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_config(config)

Set config.

Parameters: config (Config) – The config to be set.
Returns: This method return the builder instance.

with_kwargs(kwargs)

Set kwargs.

Parameters: kwargs (dict[str, Any]) – The kwargs to be set.
Returns: This method return the builder instance.

with_queue(queue)

Set the queue builder.

Parameters: queue (Union[type[BrokerPublisherQueue], Builder[BrokerPublisherQueue]]) – The queue builder to be set.
Returns: This method return the builder instance.

with_queued_cls(queued_cls)

Set the queued class.

Parameters: queued_cls (type[QueuedBrokerPublisher]) – A subclass of QueuedBrokerPublisher.
Returns: This method return the builder instance.