HttpRequest クラス

  • リファレンス

HTTP 要求を表します。

URL はクエリ パラメーターなしで指定できます。後で "format_parameters" を使用して追加できます。

継承
builtins.object
HttpRequest

コンストラクター

HttpRequest(method: str, url: str, headers: Mapping[str, str] | None = None, files: Any | None = None, data: bytes | str | Dict[str, str | int] | None = None)

パラメーター

method
str
必須

HTTP メソッド (GET、HEADなど)

url
str
必須

少なくとも完全なスキーム/ホスト/パス

headers
dict[str,str]
既定値: None

HTTP ヘッダー

files
dict[str, tuple[str, IO, str, dict]] または dict[str, IO]
既定値: None

マルチパート エンコードアップロード用の 'name': file-like-objects (または {'name': file-tuple}) のディクショナリ。 file-tuple には、2 タプル ('filename', fileobj)、3 タプル ('filename', fileobj, 'content_type') 、または 4 タプル ('filename', fileobj, 'content_type', custom_headers)を指定できます。ここで 'content_type' 、 は、指定されたファイルのコンテンツ タイプを定義する文字列と、 custom_headers ファイルに追加する追加のヘッダーを含む dict のようなオブジェクトです。

data
bytes または dict (<xref:for form>)
既定値: None

送信する本文。

メソッド

format_parameters

パラメーターを有効なクエリ文字列に書式設定します。 すべてのパラメーターが有効な URL 文字列として既に引用符で囲まれています。
prepare_multipart_body

マルチパート情報に従って、この要求の本文を準備します。

この呼び出しでは、on_request ポリシーが正しいコンテキスト (sync/async) に既に適用されていることを前提としています

"set_multipart_mixed" が呼び出されなかった場合は何も行いません。
serialize

アプリケーション/http 仕様を使用してこの要求をシリアル化します。
set_bytes_body

要求の本文として汎用バイトを設定します。

コンテンツの長さを設定します。
set_formdata_body

フォームでエンコードされたデータを要求の本文として設定します。
set_json_body

JSON フレンドリ オブジェクトを要求の本文として設定します。
set_multipart_mixed

マルチパート/混合の部分を設定します。

現時点でサポートされている引数のみが HttpRequest オブジェクトです。

boundary は省略可能であり、指定しない場合は生成されます。 境界では検証が行われず、RFC1341 7.2.1 を尊重し、正しい境界を提供する方法を知っているので、これは十分に高度と見なされます。

追加の kwargs は、要求ごとのポリシー構成のパイプライン コンテキストに渡されます。
set_streamed_data_body

ストリーミング可能なデータ本文を設定します。
set_text_body

テキストを要求の本文として設定します。
set_xml_body

XML 要素ツリーを要求の本文として設定します。

format_parameters

パラメーターを有効なクエリ文字列に書式設定します。 すべてのパラメーターが有効な URL 文字列として既に引用符で囲まれています。

format_parameters(params: Dict[str, str]) -> None

パラメーター

params
dict
必須

パラメーターのディクショナリ。

prepare_multipart_body

マルチパート情報に従って、この要求の本文を準備します。

この呼び出しでは、on_request ポリシーが正しいコンテキスト (sync/async) に既に適用されていることを前提としています

"set_multipart_mixed" が呼び出されなかった場合は何も行いません。

prepare_multipart_body(content_index: int = 0) -> int

パラメーター

content_index
int
既定値: 0

バッチ メッセージ内の部分の現在のインデックス。

戻り値

この要求のすべての部分が追加された後の更新されたインデックス。

の戻り値の型 :

int

serialize

アプリケーション/http 仕様を使用してこの要求をシリアル化します。

serialize() -> bytes

戻り値

要求は HTTP 低レベル メッセージとしてバイト単位でシリアル化されます。

の戻り値の型 :

bytes

set_bytes_body

要求の本文として汎用バイトを設定します。

コンテンツの長さを設定します。

set_bytes_body(data: bytes) -> None

パラメーター

data
bytes
必須

要求フィールド データ。

set_formdata_body

フォームでエンコードされたデータを要求の本文として設定します。

set_formdata_body(data: Dict[str, str] | None = None) -> None

パラメーター

data
dict
既定値: None

要求フィールド データ。

set_json_body

JSON フレンドリ オブジェクトを要求の本文として設定します。

set_json_body(data: Any) -> None

パラメーター

data
dict
必須

JSON シリアル化可能なオブジェクト

set_multipart_mixed

マルチパート/混合の部分を設定します。

現時点でサポートされている引数のみが HttpRequest オブジェクトです。

boundary は省略可能であり、指定しない場合は生成されます。 境界では検証が行われず、RFC1341 7.2.1 を尊重し、正しい境界を提供する方法を知っているので、これは十分に高度と見なされます。

追加の kwargs は、要求ごとのポリシー構成のパイプライン コンテキストに渡されます。

set_multipart_mixed(*requests: HttpRequest, policies: List[SansIOHTTPPolicy[HTTPRequestType, HTTPResponseType]] | None = None, boundary: str | None = None, **kwargs: Any) -> None

パラメーター

requests
HttpRequest
必須

multipart/mixed に追加する要求

policies
list[SansIOHTTPPolicy]

準備時に適用する SansIOPolicy

boundary
str

オプションの境界

set_streamed_data_body

ストリーミング可能なデータ本文を設定します。

set_streamed_data_body(data: Any) -> None

パラメーター

data
<xref:stream> または <xref:generator> または <xref:asyncgenerator>
必須

要求フィールド データ。

set_text_body

テキストを要求の本文として設定します。

set_text_body(data: str) -> None

パラメーター

data
str
必須

本文として送信するテキスト。

set_xml_body

XML 要素ツリーを要求の本文として設定します。

set_xml_body(data: Any) -> None

パラメーター

data
<xref:<xref:XML node>>
必須

要求フィールド データ。

属性

body

データの別名。

戻り値

要求の本文。

の戻り値の型 :

bytes,
str,
dict,
None

query

要求のクエリ パラメーターをディクテーションとして指定します。

戻り値

要求のクエリ パラメーターをディクテーションとして指定します。

の戻り値の型 :

dict[str, str]