A server request made from an HttpClientRequest (Effect's
fromClientRequest), as test clients send.
Attributes#
| Attribute | Type | Description |
|---|---|---|
source | HttpClientRequest | |
original_url | str | |
method | str | |
stream | Stream[bytes, HttpServerError] | |
json | Effect[Json, HttpServerError] | |
multipart_stream | Stream[Part, Any] |
Functions#
__init__#
__init__(source, original_url) -> None| Parameter | Type | Description |
|---|---|---|
source | HttpClientRequest | |
original_url | str |
def __init__(self, source: HttpClientRequest, original_url: str) -> None:
super().__init__()
self._source = source
self._original_url = original_url
self._bytes: Effect[bytes, HttpServerError] | None = Noneupgrade_with#
upgrade_with(*, headers=None) -> Effect[SocketService, HttpServerError]Upgrade the connection to a WebSocket, answering with headers
too; a request that cannot be upgraded fails.
| Parameter | Type | Description |
|---|---|---|
headers | HeadersInput | None = None |
Returns Effect[SocketService, HttpServerError]
def upgrade_with(
self, *, headers: HeadersInput | None = None
) -> Effect[SocketService, HttpServerError]:
"""Upgrade the connection to a WebSocket, answering with ``headers``
too; a request that cannot be upgraded fails."""
del headers
return fail(request_parse_error(self, "Not an upgradeable ServerRequest"))modify#
modify(*, url=None, headers=None, remote_address=_UNSET, peer_address=None, protocol=None) -> ServerRequestThe request with these parts replaced (remote_address=None
removes it); its body is this request's.
| Parameter | Type | Description |
|---|---|---|
url | str | None = None | |
headers | Headers | None = None | |
remote_address | str | _Unset | None = _UNSET | |
peer_address | str | None = None | |
protocol | RequestProtocol | None = None |
Returns ServerRequest
def modify(
self,
*,
url: str | None = None,
headers: Headers | None = None,
remote_address: str | _Unset | None = _UNSET,
peer_address: str | None = None,
protocol: RequestProtocol | None = None,
) -> ServerRequest:
"""The request with these parts replaced (``remote_address=None``
removes it); its body is this request's."""
copy = self._copy()
copy._url = self.url if url is None else url
copy._headers = self._headers if headers is None else headers
copy._remote_address = (
self._remote_address if isinstance(remote_address, _Unset) else remote_address
)
copy._peer_address = self._peer_address if peer_address is None else peer_address
copy._protocol = self._protocol if protocol is None else protocol
return copyto_json#
to_json() -> dict[str, object]Returns dict[str, object]
def to_json(self) -> dict[str, object]:
from pyfect.http.url_params import redact_url
return {
"_id": "HttpServerRequest",
"method": self.method,
"url": redact_url(self.original_url),
"headers": self.headers.to_json(),
"remoteAddress": self.remote_address,
}