StreamPublisher
faststream.redis.publisher.usecase.StreamPublisher #
StreamPublisher(
config: RedisPublisherConfig,
specification: PublisherSpecification[Any, Any],
*,
stream: StreamSub,
)
Bases: LogicPublisher
Source code in faststream/redis/publisher/usecase.py
320 321 322 323 324 325 326 327 328 | |
mock property #
mock: MagicMock
The mock recording the endpoint's calls, available under a test broker.
subscriber_property #
subscriber_property(*, name_only: bool) -> dict[str, Any]
Source code in faststream/redis/publisher/usecase.py
334 335 336 337 338 339 340 | |
publish async #
publish(
message: SendableMessage = None,
stream: str | None = None,
reply_to: str = "",
headers: dict[str, Any] | None = None,
correlation_id: str | None = None,
*,
maxlen: int | None = None,
pipeline: Optional[Pipeline[bytes]] = None,
) -> bytes
Source code in faststream/redis/publisher/usecase.py
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | |
request async #
request(
message: SendableMessage = None,
stream: str | None = None,
*,
maxlen: int | None = None,
correlation_id: str | None = None,
headers: dict[str, Any] | None = None,
timeout: float | None = 30.0,
) -> RedisChannelMessage
Source code in faststream/redis/publisher/usecase.py
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | |
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,
) -> 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: |
Source code in faststream/_internal/testing/calls.py
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 65 | |
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,
) -> 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: |
Source code in faststream/_internal/testing/calls.py
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 | |
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,
) -> 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: |
Source code in faststream/_internal/testing/calls.py
103 104 105 106 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 | |
start async #
start() -> None
Source code in faststream/redis/publisher/usecase.py
43 44 45 46 47 48 49 50 51 52 53 | |
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
53 54 55 56 57 58 59 60 61 62 63 64 65 | |
reset_test #
reset_test() -> None
Turn off publisher's testing mode.
Source code in faststream/_internal/endpoint/publisher/usecase.py
67 68 69 70 71 72 73 | |
schema #
schema() -> dict[str, PublisherSpec]
Source code in faststream/_internal/endpoint/publisher/usecase.py
150 151 | |