DefaultPublisher
faststream.confluent.publisher.usecase.DefaultPublisher #
DefaultPublisher(
config: KafkaPublisherConfig,
specifcication: PublisherSpecification[Any, Any],
)
Bases: LogicPublisher
Source code in faststream/confluent/publisher/usecase.py
108 109 110 111 112 113 114 115 | |
mock property #
mock: MagicMock
The mock recording the endpoint's calls, available under a test broker.
publish async #
publish(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
reply_to: str = "",
no_confirm: Literal[False] = False,
) -> Message | None
publish(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
reply_to: str = "",
no_confirm: Literal[True] = ...,
) -> Future[Message | None]
publish(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
reply_to: str = "",
no_confirm: bool = False,
) -> Future[Message | None] | Message | None
publish(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
reply_to: str = "",
no_confirm: bool = False,
) -> Future[Message | None] | Message | None
Source code in faststream/confluent/publisher/usecase.py
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | |
request async #
request(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
timeout: float = 0.5,
) -> KafkaMessage
Source code in faststream/confluent/publisher/usecase.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | |
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 | |
start async #
start() -> None
Source code in faststream/_internal/endpoint/publisher/usecase.py
57 58 | |
set_test #
set_test(
*, recorder: CallRecorder | None = None, with_fake: bool
) -> None
Turn publisher to testing mode, sharing recorder when one is given.
Source code in faststream/_internal/endpoint/publisher/usecase.py
60 61 62 63 64 65 66 67 68 69 70 71 72 | |
reset_test #
reset_test() -> None
Turn off publisher's testing mode.
Source code in faststream/_internal/endpoint/publisher/usecase.py
74 75 76 77 78 79 80 | |
schema #
schema() -> dict[str, PublisherSpec]
Source code in faststream/_internal/endpoint/publisher/usecase.py
157 158 | |
flush async #
flush() -> None
Source code in faststream/confluent/publisher/usecase.py
100 101 102 | |