Skip to content

KafkaSubscriberSpecification

faststream.kafka.subscriber.specification.KafkaSubscriberSpecification #

KafkaSubscriberSpecification(
    _outer_config: T_BrokerConfig,
    specification_config: T_SpecificationConfig,
    calls: CallsCollection[Any],
)

Bases: SubscriberSpecification[KafkaBrokerConfig, KafkaSubscriberSpecificationConfig]

Source code in faststream/_internal/endpoint/subscriber/specification.py 
32
33
34
35
36
37
38
39
def __init__(
    self,
    _outer_config: "T_BrokerConfig",
    specification_config: "T_SpecificationConfig",
    calls: "CallsCollection[Any]",
) -> None:
    super().__init__(_outer_config, specification_config)
    self.calls = calls

topics property #

topics: list[str]

The topics this endpoint reads, in the order they were declared.

Deduped through a dict rather than a set: set order varies per process and would reach the document as the order of its channels.

channel_labels property #

channel_labels: list[str]

config instance-attribute #

config = specification_config

include_in_schema property #

include_in_schema: bool

calls instance-attribute #

calls = calls

description property #

description: str | None

call_name property #

call_name: str

name property #

name: str

The key of the first channel this endpoint names.

get_schema #

get_schema() -> dict[str, SubscriberSpec]
Source code in faststream/kafka/subscriber/specification.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def get_schema(self) -> dict[str, SubscriberSpec]:
    payloads = self.get_payloads()

    topics = self.topics
    split = len(topics) > 1

    channels = {}
    for t in topics:
        handler_name = self._channel_key(t, split=split)

        channels[handler_name] = SubscriberSpec(
            address=t,
            description=self.description,
            operation=Operation(
                message=Message(
                    title=f"{handler_name}:Message",
                    payload=resolve_payloads(payloads),
                ),
                bindings=None,
            ),
            bindings=ChannelBinding(
                kafka=kafka.ChannelBinding(
                    topic=t,
                    partitions=None,
                    replicas=None,
                ),
            ),
        )

    return channels

get_payloads #

get_payloads() -> list[tuple[dict[str, Any], str]]
Source code in faststream/_internal/endpoint/subscriber/specification.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def get_payloads(self) -> list[tuple["dict[str, Any]", str]]:
    payloads: list[tuple[dict[str, Any], str]] = []

    call_name = self.call_name

    for h in self.calls:
        if h.dependant is None:
            msg = "You should setup `Handler` at first."
            raise SetupError(msg)

        body = parse_handler_params(
            h.dependant,
            prefix=f"{self.config.title_ or call_name}:Message",
        )
        payloads.append((body, to_camelcase(h.name)))

    if not self.calls:
        payloads.append(
            (
                {
                    "title": f"{self.config.title_ or call_name}:Message:Payload",
                },
                to_camelcase(call_name),
            ),
        )

    return payloads