prepare_cookies() — requests Function Reference

Architecture documentation for the prepare_cookies() function in models.py from the requests codebase.

Function python CoreAPI VerbHandlers calls 2 called by 2

Entity Profile

CoreAPI→ VerbHandlers→ prepare_cookies() — requests Function Reference

Dependency Diagram

graph TD
  f54e6687_0796_d413_58a1_971b32410667["prepare_cookies()"]
  c8cfcd0c_a36a_3124_6cd4_1516b06c63b3["PreparedRequest"]
  f54e6687_0796_d413_58a1_971b32410667 -->|defined in| c8cfcd0c_a36a_3124_6cd4_1516b06c63b3
  3fc6c343_3d70_670f_636f_1fcab0f8a681["prepare()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| f54e6687_0796_d413_58a1_971b32410667
  cbf6862f_d124_817f_3342_f1142c276f25["resolve_redirects()"]
  cbf6862f_d124_817f_3342_f1142c276f25 -->|calls| f54e6687_0796_d413_58a1_971b32410667
  fad58eac_0316_2b83_52d3_1a1829c12c66["cookiejar_from_dict()"]
  f54e6687_0796_d413_58a1_971b32410667 -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  457cc7d3_71b7_615b_a4c8_d4a4dbccde8d["get_cookie_header()"]
  f54e6687_0796_d413_58a1_971b32410667 -->|calls| 457cc7d3_71b7_615b_a4c8_d4a4dbccde8d
  style f54e6687_0796_d413_58a1_971b32410667 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/models.py lines 612–630

    def prepare_cookies(self, cookies):
        """Prepares the given HTTP cookie data.

        This function eventually generates a ``Cookie`` header from the
        given cookies using cookielib. Due to cookielib's design, the header
        will not be regenerated if it already exists, meaning this function
        can only be called once for the life of the
        :class:`PreparedRequest <PreparedRequest>` object. Any subsequent calls
        to ``prepare_cookies`` will have no actual effect, unless the "Cookie"
        header is removed beforehand.
        """
        if isinstance(cookies, cookielib.CookieJar):
            self._cookies = cookies
        else:
            self._cookies = cookiejar_from_dict(cookies)

        cookie_header = get_cookie_header(self._cookies, self)
        if cookie_header is not None:
            self.headers["Cookie"] = cookie_header