Skip to content

RabbitBrokerConfig

faststream.rabbit.configs.RabbitBrokerConfig dataclass #

RabbitBrokerConfig(
    *,
    prefix: str = "",
    include_in_schema: bool | None = True,
    broker_middlewares: Sequence[
        BrokerMiddleware[Any]
    ] = (),
    broker_parser: Optional[CustomCallable] = None,
    broker_decoder: Optional[CustomCallable] = None,
    broker_codec: Optional[CodecProto] = None,
    producer: AioPikaFastProducer = FakeAioPikaFastProducer(),
    logger: LoggerState = LoggerState(),
    fd_config: FastDependsConfig = FastDependsConfig(),
    id_generator: IdGenerator = gen_cor_id,
    underlying_driver_annotations: UnderlyingDriverAnnotations = dict(),
    default_driver_annotations: UnderlyingDriverAnnotations = _context_annotations_factory(),
    broker_dependencies: Sequence[Dependant] = (),
    graceful_timeout: float | None = 15.0,
    ack_policy: AckPolicy = (lambda: EMPTY)(),
    extra_context: dict[str, Any] = dict(),
    channel_manager: ChannelManager = FakeChannelManager(),
    declarer: RabbitDeclarer = FakeRabbitDeclarer(),
    virtual_host: str = "",
    app_id: str | None = None,
)

Bases: BrokerConfig

prefix class-attribute instance-attribute #

prefix: str = ''

include_in_schema class-attribute instance-attribute #

include_in_schema: bool | None = True

broker_middlewares class-attribute instance-attribute #

broker_middlewares: Sequence[BrokerMiddleware[Any]] = ()

broker_parser class-attribute instance-attribute #

broker_parser: Optional[CustomCallable] = None

broker_decoder class-attribute instance-attribute #

broker_decoder: Optional[CustomCallable] = None

broker_codec class-attribute instance-attribute #

broker_codec: Optional[CodecProto] = None

logger class-attribute instance-attribute #

logger: LoggerState = field(default_factory=LoggerState)

fd_config class-attribute instance-attribute #

fd_config: FastDependsConfig = field(
    default_factory=FastDependsConfig
)

id_generator class-attribute instance-attribute #

id_generator: IdGenerator = gen_cor_id

underlying_driver_annotations class-attribute instance-attribute #

underlying_driver_annotations: UnderlyingDriverAnnotations = field(
    default_factory=dict
)

broker_dependencies class-attribute instance-attribute #

broker_dependencies: Sequence[Dependant] = ()

graceful_timeout class-attribute instance-attribute #

graceful_timeout: float | None = 15.0

ack_policy class-attribute instance-attribute #

ack_policy: AckPolicy = field(default_factory=lambda: EMPTY)

extra_context class-attribute instance-attribute #

extra_context: dict[str, Any] = field(default_factory=dict)

resolved_underlying_driver_annotations property #

resolved_underlying_driver_annotations: (
    UnderlyingDriverAnnotations
)

context property #

context: ContextRepo

channel_manager class-attribute instance-attribute #

channel_manager: ChannelManager = field(
    default_factory=FakeChannelManager
)

declarer class-attribute instance-attribute #

declarer: RabbitDeclarer = field(
    default_factory=FakeRabbitDeclarer
)

producer class-attribute instance-attribute #

producer: AioPikaFastProducer = field(
    default_factory=FakeAioPikaFastProducer
)

virtual_host class-attribute instance-attribute #

virtual_host: str = ''

app_id class-attribute instance-attribute #

app_id: str | None = None

default_driver_annotations class-attribute instance-attribute #

default_driver_annotations: UnderlyingDriverAnnotations = (
    field(default_factory=_context_annotations_factory)
)

add_middleware #

add_middleware(middleware: BrokerMiddleware[Any]) -> None
Source code in faststream/_internal/configs/broker.py 
95
96
def add_middleware(self, middleware: "BrokerMiddleware[Any]") -> None:
    self.broker_middlewares = (*self.broker_middlewares, middleware)

insert_middleware #

insert_middleware(
    middleware: BrokerMiddleware[Any],
) -> None
Source code in faststream/_internal/configs/broker.py 
98
99
def insert_middleware(self, middleware: "BrokerMiddleware[Any]") -> None:
    self.broker_middlewares = (middleware, *self.broker_middlewares)

connect #

connect(connection: RobustConnection) -> None
Source code in faststream/rabbit/configs/broker.py 
84
85
86
87
88
89
def connect(self, connection: "RobustConnection") -> None:
    self.channel_manager.connect(connection)
    self.producer.connect(
        serializer=self.fd_config._serializer,
        codec=self.broker_codec or DefaultCodec(),
    )

disconnect #

disconnect() -> None
Source code in faststream/rabbit/configs/broker.py 
91
92
93
94
def disconnect(self) -> None:
    self.channel_manager.disconnect()
    self.declarer.disconnect()
    self.producer.disconnect()