DefaultPublisher
faststream.confluent.publisher.usecase.DefaultPublisher #
DefaultPublisher(
config: KafkaPublisherConfig,
specifcication: PublisherSpecification[Any, Any],
)
Bases: LogicPublisher
Source code in faststream/confluent/publisher/usecase.py
mock property #
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: dict[str, str] | 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: dict[str, str] | 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: dict[str, str] | 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: dict[str, str] | 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
request async #
request(
message: SendableMessage,
topic: str = "",
*,
key: bytes | str | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: dict[str, str] | None = None,
correlation_id: str | None = None,
timeout: float = 0.5,
) -> KafkaMessage
Source code in faststream/confluent/publisher/usecase.py
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
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
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
start async #
set_test #
Turn publisher to testing mode, sharing recorder when one is given.
Source code in faststream/_internal/endpoint/publisher/usecase.py
reset_test #
Turn off publisher's testing mode.
Source code in faststream/_internal/endpoint/publisher/usecase.py
schema #
schema() -> dict[str, PublisherSpec]