faust.types.streams

faust.types.streams.Processor

alias of typing.Callable

faust.types.streams.GroupByKeyArg = typing.Union[faust.types.models.FieldDescriptorT, typing.Callable[[~T], typing.Union[bytes, faust.types.core.ModelT, typing.Any, NoneType]]]

Type of the key argument to Stream.group_by()

class faust.types.streams.StreamT(channel: AsyncIterator[T_co] = None, *, app: faust.types.streams.AppT = None, processors: Iterable[Callable[T]] = None, combined: List[faust.types.streams.JoinableT] = None, on_start: Callable = None, join_strategy: faust.types.streams.JoinT = None, beacon: mode.utils.types.trees.NodeT = None, concurrency_index: int = None, prev: Union[faust.types.streams.StreamT, NoneType] = None, active_partitions: Set[faust.types.tuples.TP] = None, enable_acks: bool = True, loop: asyncio.events.AbstractEventLoop = None) → None

outbox = None

join_strategy = None

task_owner = None

current_event = None

active_partitions = None

concurrency_index = None

enable_acks = True

get_active_stream() → faust.types.streams.StreamT

Return type:StreamT[+T_co]

add_processor(processor: Callable[T]) → None

Return type:None

info() → Mapping[str, Any]

Return type:Mapping[str, Any]

clone(**kwargs) → faust.types.streams.StreamT

Return type:StreamT[+T_co]

enumerate(start: int = 0) → AsyncIterable[Tuple[int, T_co]]

Return type:AsyncIterable[Tuple[int, +T_co]]

through(channel: Union[str, faust.types.channels.ChannelT]) → faust.types.streams.StreamT

Return type:StreamT[+T_co]

echo(*channels) → faust.types.streams.StreamT

Return type:StreamT[+T_co]

group_by(key: Union[faust.types.models.FieldDescriptorT, typing.Callable[[~T], typing.Union[bytes, faust.types.core.ModelT, typing.Any, NoneType]]], *, name: str = None, topic: faust.types.topics.TopicT = None) → faust.types.streams.StreamT

Return type:StreamT[+T_co]

derive_topic(name: str, *, key_type: Union[typing.Type[faust.types.models.ModelT], typing.Type[bytes], typing.Type[str]] = None, value_type: Union[typing.Type[faust.types.models.ModelT], typing.Type[bytes], typing.Type[str]] = None, prefix: str = '', suffix: str = '') → faust.types.topics.TopicT

Return type:TopicT[]

coroutine ack(self, event: faust.types.events.EventT) → bool

Return type:bool

coroutine events(self) → AsyncIterable[faust.types.events.EventT]

coroutine items(self) → AsyncIterator[Tuple[Union[bytes, faust.types.core.ModelT, typing.Any, NoneType], T_co]]

coroutine send(self, value: T_contra) → None

Return type:None

coroutine take(self, max_: int, within: Union[datetime.timedelta, float, str]) → AsyncIterable[Sequence[T_co]]

coroutine throw(self, exc: BaseException) → None

Return type:None