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

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[NoneType]], on_partitions_assigned: Callable[Set[faust.types.tuples.TP], Awaitable[NoneType]], *, commit_interval: float = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs) → None

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.

track_message(message: faust.types.tuples.Message) → None

Return type:None

ack(message: faust.types.tuples.Message) → bool

Return type:bool

assignment() → Set[faust.types.tuples.TP]

Return type:Set[TP]

highwater(tp: faust.types.tuples.TP) → int

Return type:int

close() → None

Return type:None

unacked

coroutine commit(self, topics: AbstractSet[Union[str, faust.types.tuples.TP]] = None) → bool

Return type:bool

coroutine create_topic(self, topic: str, partitions: int, replication: int, *, config: Mapping[str, Any] = None, timeout: Union[datetime.timedelta, float, str] = 1000.0, retention: Union[datetime.timedelta, float, str] = None, compacting: bool = None, deleting: bool = None, ensure_created: bool = False) → None

Return type:None

coroutine earliest_offsets(self, *partitions) → MutableMapping[faust.types.tuples.TP, int]

Return type:MutableMapping[TP, int]

coroutine getmany(self, timeout: float) → AsyncIterator[Tuple[faust.types.tuples.TP, faust.types.tuples.Message]]

coroutine highwaters(self, *partitions) → MutableMapping[faust.types.tuples.TP, int]

Return type:MutableMapping[TP, int]

coroutine on_task_error(self, exc: BaseException) → None

Return type:None

coroutine pause_partitions(self, tps: Iterable[faust.types.tuples.TP]) → None

Return type:None

coroutine perform_seek(self) → None

Return type:None

coroutine position(self, tp: faust.types.tuples.TP) → Union[int, NoneType]

Return type:Optional[int]

coroutine resume_partitions(self, tps: Iterable[faust.types.tuples.TP]) → None

Return type:None

coroutine seek(self, partition: faust.types.tuples.TP, offset: int) → None

Return type:None

coroutine subscribe(self, topics: Iterable[str]) → None

Return type:None

coroutine wait_empty(self) → None

Return type:None

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

transport = None

The transport that created this Producer.

key_partition(topic: str, key: bytes) → faust.types.tuples.TP

Return type:TP

coroutine create_topic(self, topic: str, partitions: int, replication: int, *, config: Mapping[str, Any] = None, timeout: Union[datetime.timedelta, float, str] = 1000.0, retention: Union[datetime.timedelta, float, str] = None, compacting: bool = None, deleting: bool = None, ensure_created: bool = False) → None

Return type:None

coroutine send(self, topic: str, key: Union[bytes, NoneType], value: Union[bytes, NoneType], partition: Union[int, NoneType]) → Awaitable[faust.types.tuples.RecordMetadata]

Return type:Awaitable[RecordMetadata]

coroutine send_and_wait(self, topic: str, key: Union[bytes, NoneType], value: Union[bytes, NoneType], partition: Union[int, NoneType]) → faust.types.tuples.RecordMetadata

Return type:RecordMetadata

class faust.types.transports.ConductorT(app: faust.types.transports.AppT, **kwargs) → None

acks_enabled_for(topic: str) → bool

Return type:bool

coroutine commit(self, topics: AbstractSet[Union[str, faust.types.tuples.TP]]) → bool

Return type:bool

coroutine on_partitions_assigned(self, assigned: Set[faust.types.tuples.TP]) → None

Return type:None

coroutine on_partitions_revoked(self, revoked: Set[faust.types.tuples.TP]) → None

Return type:None

coroutine wait_for_subscriptions(self) → None

Return type:None

class faust.types.transports.TransportT(url: Union[str, yarl.URL], app: faust.types.transports.AppT, loop: asyncio.events.AbstractEventLoop = None) → None

Consumer = None

The Consumer class used for this type of transport.

Producer = None

The Producer class used for this type of transport.

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

The URL to use for this transport (e.g. kafka – //localhost).

driver_version = None

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

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

Return type:ConsumerT[]

create_producer(**kwargs) → faust.types.transports.ProducerT

Return type:ProducerT[]

create_conductor(**kwargs) → faust.types.transports.ConductorT

Return type:ConductorT[]