faust.types.transports

faust.types.transports.ConsumerCallback

alias of typing.Callable

faust.types.transports.TPorTopicSet

alias of typing.AbstractSet

faust.types.transports.PartitionsRevokedCallback

alias of typing.Callable

faust.types.transports.PartitionsAssignedCallback

alias of typing.Callable

faust.types.transports.PartitionerT

alias of typing.Callable

class faust.types.transports.ProducerT(transport: faust.types.transports.TransportT, loop: asyncio.events.AbstractEventLoop = None, **kwargs) → None[source]
transport = None

The transport that created this Producer.

abstract key_partition(topic: str, key: bytes) → faust.types.tuples.TP[source]
Return type

TP

abstract supports_headers() → bool[source]
Return type

bool

class faust.types.transports.TransactionManagerT(transport: faust.types.transports.TransportT, loop: asyncio.events.AbstractEventLoop = None, *, consumer: faust.types.transports.ConsumerT, producer: faust.types.transports.ProducerT, **kwargs) → None[source]
class faust.types.transports.ConsumerT(transport: faust.types.transports.TransportT, callback: Callable[faust.types.tuples.Message, Awaitable], on_partitions_revoked: Callable[Set[faust.types.tuples.TP], Awaitable[None]], on_partitions_assigned: Callable[Set[faust.types.tuples.TP], Awaitable[None]], *, commit_interval: float = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs) → None[source]
transport = None

The transport that created this Consumer.

commit_interval = None

How often we commit topic offsets. See broker_commit_interval.

randomly_assigned_topics = None

Set of topic names that are considered “randomly assigned”. This means we don’t crash if it’s not part of our assignment. Used by e.g. the leader assignor service.

abstract track_message(message: faust.types.tuples.Message) → None[source]
Return type

None

abstract ack(message: faust.types.tuples.Message) → bool[source]
Return type

bool

abstract assignment() → Set[faust.types.tuples.TP][source]
Return type

Set[TP]

abstract highwater(tp: faust.types.tuples.TP) → int[source]
Return type

int

abstract stop_flow() → None[source]
Return type

None

abstract resume_flow() → None[source]
Return type

None

abstract pause_partitions(tps: Iterable[faust.types.tuples.TP]) → None[source]
Return type

None

abstract resume_partitions(tps: Iterable[faust.types.tuples.TP]) → None[source]
Return type

None

abstract topic_partitions(topic: str) → Optional[int][source]
Return type

Optional[int]

abstract key_partition(topic: str, key: Optional[bytes], partition: int = None) → Optional[int][source]
Return type

Optional[int]

abstract close() → None[source]
Return type

None

abstract property unacked
Return type

Set[Message]

class faust.types.transports.ConductorT(app: faust.types.transports._AppT, **kwargs) → None[source]
abstract acks_enabled_for(topic: str) → bool[source]
Return type

bool

class faust.types.transports.TransportT(url: List[yarl.URL], app: faust.types.transports._AppT, loop: asyncio.events.AbstractEventLoop = None) → None[source]
Consumer = None

The Consumer class used for this type of transport.

Producer = None

The Producer class used for this type of transport.

TransactionManager = None

The TransactionManager class used for managing multiple transactions.

Conductor = None

The Conductor class used to delegate messages from Consumer to streams.

Fetcher = None

The Fetcher service used for this type of transport.

app = None

The faust.App that created this transport.

url = None

//localhost).

Type

The URL to use for this transport (e.g. kafka

driver_version = None

String identifying the underlying driver used for this transport. E.g. for aiokafka this could be aiokafka 0.4.1.

abstract create_consumer(callback: Callable[faust.types.tuples.Message, Awaitable], **kwargs) → faust.types.transports.ConsumerT[source]
Return type

ConsumerT[]

abstract create_producer(**kwargs) → faust.types.transports.ProducerT[source]
Return type

ProducerT[]

abstract create_transaction_manager(consumer: faust.types.transports.ConsumerT, producer: faust.types.transports.ProducerT, **kwargs) → faust.types.transports.TransactionManagerT[source]
Return type

TransactionManagerT[]

abstract create_conductor(**kwargs) → faust.types.transports.ConductorT[source]
Return type

ConductorT[]