Method __init__

httpx/_models.py:383–439

(
        self,
        method: str,
        url: URL | str,
        *,
        params: QueryParamTypes | None = None,
        headers: HeaderTypes | None = None,
        cookies: CookieTypes | None = None,
        content: RequestContent | None = None,
        data: RequestData | None = None,
        files: RequestFiles | None = None,
        json: typing.Any | None = None,
        stream: SyncByteStream | AsyncByteStream | None = None,
        extensions: RequestExtensions | None = None,
    )

class Request:
    def __init__(
        self,
        method: str,
        url: URL | str,
        *,
        params: QueryParamTypes | None = None,
        headers: HeaderTypes | None = None,
        cookies: CookieTypes | None = None,
        content: RequestContent | None = None,
        data: RequestData | None = None,
        files: RequestFiles | None = None,
        json: typing.Any | None = None,
        stream: SyncByteStream | AsyncByteStream | None = None,
        extensions: RequestExtensions | None = None,
    ) -> None:
        self.method = method.upper()
        self.url = URL(url) if params is None else URL(url, params=params)
        self.headers = Headers(headers)
        self.extensions = {} if extensions is None else dict(extensions)

        if cookies:
            Cookies(cookies).set_cookie_header(self)

        if stream is None:
            content_type: str | None = self.headers.get(class="st">"content-type")
            headers, stream = encode_request(
                content=content,
                data=data,
                files=files,
                json=json,
                boundary=get_multipart_boundary_from_content_type(
                    content_type=content_type.encode(self.headers.encoding)
                    if content_type
                    else None
                ),
            )
            self._prepare(headers)
            self.stream = stream
            class="cm"># Load the request body, except for streaming content.
            if isinstance(stream, ByteStream):
                self.read()
        else:
            class="cm"># There's an important distinction between `Request(content=...)`,
            class="cm"># and `Request(stream=...)`.
            class="cm">#
            class="cm"># Using `content=...` implies automatically populated `Host` and content
            class="cm"># headers, of either `Content-Length: ...` or `Transfer-Encoding: chunked`.
            class="cm">#
            class="cm"># Using `stream=...` will not automatically include *any*
            class="cm"># auto-populated headers.
            class="cm">#
            class="cm"># As an end-user you donclass="st">'t really need `stream=...`. It's only
            class="cm"># useful when:
            class="cm">#
            class="cm"># * Preserving the request stream when copying requests, eg for redirects.
            class="cm"># * Creating request instances on the *server-side* of the transport API.
            self.stream = stream