LogicPublisher
faststream.nats.publisher.usecase.LogicPublisher #
LogicPublisher(
config: NatsPublisherConfig,
specification: PublisherSpecification[Any, Any],
)
Bases: PublisherUsecase
A class to represent a NATS publisher.
Initialize NATS publisher object.
Source code in faststream/nats/publisher/usecase.py
38 39 40 41 42 43 44 45 46 47 48 49 50 | |
subject property #
subject: Address
The subject this Publisher was declared with, and its Broker address.
mock property #
mock: MagicMock
The mock recording the endpoint's calls, available under a test broker.
publish async #
publish(
message: SendableMessage,
subject: str = "",
headers: dict[str, str] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
stream: None = None,
timeout: float | None = None,
) -> None
publish(
message: SendableMessage,
subject: str = "",
headers: dict[str, str] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
stream: str | None = None,
timeout: float | None = None,
) -> PubAck
publish(
message: SendableMessage,
subject: str = "",
headers: dict[str, str] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
stream: str | None = None,
timeout: float | None = None,
) -> Optional[PubAck]
Publish message directly.
| PARAMETER | DESCRIPTION |
|---|---|
message | Message body to send. Can be any encodable object (native python types or TYPE: |
subject | NATS subject to send message. TYPE: |
headers | Message headers to store metainformation. content-type and correlation_id will be set automatically by framework anyway. TYPE: |
reply_to | NATS subject name to send response. TYPE: |
correlation_id | Manual message correlation_id setter. correlation_id is a useful option to trace messages. TYPE: |
stream | This option validates that the target subject is in presented stream. Can be omitted without any effect if you doesn't want PubAck frame. TYPE: |
timeout | Timeout to send message to NATS. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
Optional[PubAck] |
|
Optional[PubAck] |
|
Source code in faststream/nats/publisher/usecase.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 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 138 139 140 141 142 143 144 145 146 147 148 | |
request async #
request(
message: SendableMessage,
subject: str = "",
headers: dict[str, str] | None = None,
correlation_id: str | None = None,
stream: str | None = None,
timeout: float = 0.5,
) -> NatsMessage
Make a synchronous request to outer subscriber.
If out subscriber listens subject by stream, you should setup the same stream explicitly. Another way you will reseave confirmation frame as a response.
| PARAMETER | DESCRIPTION |
|---|---|
message | Message body to send. Can be any encodable object (native python types or TYPE: |
subject | NATS subject to send message. TYPE: |
headers | Message headers to store metainformation. content-type and correlation_id will be set automatically by framework anyway. TYPE: |
correlation_id | Manual message correlation_id setter. correlation_id is a useful option to trace messages. TYPE: |
stream | This allows to make RPC calls over JetStream subjects. TYPE: |
timeout | Timeout to send message to NATS. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
NatsMessage |
|
Source code in faststream/nats/publisher/usecase.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
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
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 66 | |
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
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 | |
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 | |