KafkaHandlerCallWrapper
faststream.kafka.call_wrapper.KafkaHandlerCallWrapper #
KafkaHandlerCallWrapper(
call: Callable[P_HandlerParams, T_HandlerReturn],
outer_config: BrokerConfig,
)
Bases: KafkaCallAssertions, HandlerCallWrapper[P_HandlerParams, T_HandlerReturn]
The wrapper of a Kafka handler: its Call assertions take key and partition.
Initialize a handler.
Source code in faststream/_internal/endpoint/call_wrapper.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | |
mock property #
mock: MagicMock
The mock recording the endpoint's calls, available under a test broker.
assert_called_once_with async #
assert_called_once_with(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert the endpoint was called once, with the message described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | |
assert_called_with async #
assert_called_with(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert the last message the endpoint saw is the one described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
assert_any_call async #
assert_any_call(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert one of the messages the endpoint saw is the one described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | |
call_wrapped async #
call_wrapped(message: StreamMessage[Any]) -> Any
Calls the wrapped function with the given message.
Source code in faststream/_internal/endpoint/call_wrapper.py
105 106 107 108 109 110 | |
set_wrapped #
set_wrapped(
*,
dependencies: Sequence[Dependant],
_call_decorators: Reversible[Decorator],
config: FastDependsConfig,
) -> CallModel
Source code in faststream/_internal/endpoint/call_wrapper.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | |
wait_call async #
wait_call(timeout: float | None = None) -> None
Waits for a call with an optional timeout.
Source code in faststream/_internal/endpoint/call_wrapper.py
131 132 133 134 135 | |
set_test #
set_test() -> None
Source code in faststream/_internal/endpoint/call_wrapper.py
137 138 139 | |
reset_test #
reset_test() -> None
Source code in faststream/_internal/endpoint/call_wrapper.py
141 142 143 144 145 | |
trigger #
trigger(
result: Any = None, error: BaseException | None = None
) -> None
Source code in faststream/_internal/endpoint/call_wrapper.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | |
refresh #
refresh(with_mock: bool = False) -> None
Source code in faststream/_internal/endpoint/call_wrapper.py
170 171 172 173 174 175 | |