Skip to content

KafkaBrokerConfig

faststream.confluent.configs.KafkaBrokerConfig dataclass #

KafkaBrokerConfig(
    *,
    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: AsyncConfluentFastProducer = FakeConfluentFastProducer(),
    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(),
    connection_config: ConfluentFastConfig = ConfluentFastConfig(),
    admin: AdminService = AdminService(),
    client_id: str | None = SERVICE_NAME,
)

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

connection_config class-attribute instance-attribute #

connection_config: ConfluentFastConfig = field(
    default_factory=ConfluentFastConfig
)

admin class-attribute instance-attribute #

admin: AdminService = field(default_factory=AdminService)

client_id class-attribute instance-attribute #

client_id: str | None = SERVICE_NAME

builder class-attribute instance-attribute #

builder: Callable[..., AsyncConfluentConsumer] = field(
    init=False
)

producer class-attribute instance-attribute #

producer: AsyncConfluentFastProducer = field(
    default_factory=FakeConfluentFastProducer
)

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 async #

connect() -> None
Source code in faststream/confluent/configs/broker.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
async def connect(self) -> "None":
    native_producer = AsyncConfluentProducer(
        config=self.connection_config,
        logger=self.logger,
    )
    self.producer.connect(
        native_producer,
        serializer=self.fd_config._serializer,
        codec=self.broker_codec or DefaultCodec(),
    )
    await self.admin.connect(
        self.connection_config,
        logger=self.logger,
    )

disconnect async #

disconnect() -> None
Source code in faststream/confluent/configs/broker.py 
130
131
132
async def disconnect(self) -> "None":
    await self.producer.disconnect()
    await self.admin.disconnect()