Skip to content

SubscriberProto

faststream.broker.subscriber.proto.SubscriberProto #

Bases: AsyncAPIProto, EndpointProto, WrapperProto[MsgType]

title_ instance-attribute #

title_

AsyncAPI object title.

description_ instance-attribute #

description_

AsyncAPI object description.

include_in_schema instance-attribute #

include_in_schema

Whetever to include operation in AsyncAPI schema or not.

name abstractmethod property #

name

Returns the name of the API operation.

description abstractmethod property #

description

Returns the description of the API operation.

calls instance-attribute #

calls

running instance-attribute #

running

call_name abstractmethod property #

call_name

add_prefix abstractmethod #

add_prefix(prefix)
Source code in faststream/broker/proto.py 
11
12
@abstractmethod
def add_prefix(self, prefix: str) -> None: ...

schema abstractmethod #

schema()

Generate AsyncAPI schema.

Source code in faststream/asyncapi/proto.py 
61
62
63
64
@abstractmethod
def schema(self) -> Dict[str, "Channel"]:
    """Generate AsyncAPI schema."""
    ...

add_middleware abstractmethod #

add_middleware(middleware)
Source code in faststream/broker/subscriber/proto.py 
48
49
@abstractmethod
def add_middleware(self, middleware: "BrokerMiddleware[MsgType]") -> None: ...

get_log_context abstractmethod #

get_log_context(msg)
Source code in faststream/broker/subscriber/proto.py 
51
52
53
54
55
56
@abstractmethod
def get_log_context(
    self,
    msg: Optional["StreamMessage[MsgType]"],
    /,
) -> Dict[str, str]: ...

setup abstractmethod #

setup(*, logger, graceful_timeout, broker_parser, broker_decoder, producer, extra_context, apply_types, is_validate, _get_dependant, _call_decorators)
Source code in faststream/broker/subscriber/proto.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
@override
@abstractmethod
def setup(  # type: ignore[override]
    self,
    *,
    logger: Optional["LoggerProto"],
    graceful_timeout: Optional[float],
    broker_parser: Optional["CustomCallable"],
    broker_decoder: Optional["CustomCallable"],
    producer: Optional["ProducerProto"],
    extra_context: "AnyDict",
    # FastDepends options
    apply_types: bool,
    is_validate: bool,
    _get_dependant: Optional[Callable[..., Any]],
    _call_decorators: Iterable["Decorator"],
) -> None: ...

start abstractmethod async #

start()
Source code in faststream/broker/subscriber/proto.py 
86
87
@abstractmethod
async def start(self) -> None: ...

close abstractmethod async #

close()
Source code in faststream/broker/subscriber/proto.py 
89
90
@abstractmethod
async def close(self) -> None: ...

consume abstractmethod async #

consume(msg)
Source code in faststream/broker/subscriber/proto.py 
92
93
@abstractmethod
async def consume(self, msg: MsgType) -> Any: ...

process_message abstractmethod async #

process_message(msg)
Source code in faststream/broker/subscriber/proto.py 
95
96
@abstractmethod
async def process_message(self, msg: MsgType) -> "Response": ...

get_one abstractmethod async #

get_one(*, timeout=5.0)
Source code in faststream/broker/subscriber/proto.py 
 98
 99
100
101
@abstractmethod
async def get_one(
    self, *, timeout: float = 5.0
) -> "Optional[StreamMessage[MsgType]]": ...

add_call abstractmethod #

add_call(*, filter_, parser_, decoder_, middlewares_, dependencies_)
Source code in faststream/broker/subscriber/proto.py 
103
104
105
106
107
108
109
110
111
112
@abstractmethod
def add_call(
    self,
    *,
    filter_: "Filter[Any]",
    parser_: "CustomCallable",
    decoder_: "CustomCallable",
    middlewares_: Sequence["SubscriberMiddleware[Any]"],
    dependencies_: Iterable["Depends"],
) -> Self: ...