prepare() — requests Function Reference

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

Function python CoreAPI VerbHandlers calls 8 called by 2

Entity Profile

CoreAPI→ VerbHandlers→ prepare() — requests Function Reference

Dependency Diagram

graph TD
  3fc6c343_3d70_670f_636f_1fcab0f8a681["prepare()"]
  c8cfcd0c_a36a_3124_6cd4_1516b06c63b3["PreparedRequest"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|defined in| c8cfcd0c_a36a_3124_6cd4_1516b06c63b3
  2b8e3c1b_1e51_43b6_6d22_360c4395b029["prepare()"]
  2b8e3c1b_1e51_43b6_6d22_360c4395b029 -->|calls| 3fc6c343_3d70_670f_636f_1fcab0f8a681
  a4eb532d_c481_9e3e_ad07_8d203ffafd2d["prepare_request()"]
  a4eb532d_c481_9e3e_ad07_8d203ffafd2d -->|calls| 3fc6c343_3d70_670f_636f_1fcab0f8a681
  918832c2_0c83_1556_bca4_78b83a2cc415["prepare_method()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| 918832c2_0c83_1556_bca4_78b83a2cc415
  77892816_404a_4492_b558_b565f63d2ad0["prepare_url()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| 77892816_404a_4492_b558_b565f63d2ad0
  cf59faf9_2b09_589c_b9c7_f2e4c7d65c4d["prepare_headers()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| cf59faf9_2b09_589c_b9c7_f2e4c7d65c4d
  f54e6687_0796_d413_58a1_971b32410667["prepare_cookies()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| f54e6687_0796_d413_58a1_971b32410667
  fdb744d2_4cc0_a0f9_c288_a0abeac5e58e["prepare_body()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| fdb744d2_4cc0_a0f9_c288_a0abeac5e58e
  bea876a9_383a_fe0e_3e83_080ef6697c9f["prepare_auth()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| bea876a9_383a_fe0e_3e83_080ef6697c9f
  a3ee9d20_5f94_9ee9_4c40_009b9b7e5597["prepare_hooks()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| a3ee9d20_5f94_9ee9_4c40_009b9b7e5597
  2b8e3c1b_1e51_43b6_6d22_360c4395b029["prepare()"]
  3fc6c343_3d70_670f_636f_1fcab0f8a681 -->|calls| 2b8e3c1b_1e51_43b6_6d22_360c4395b029
  style 3fc6c343_3d70_670f_636f_1fcab0f8a681 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/models.py lines 353–379

    def prepare(
        self,
        method=None,
        url=None,
        headers=None,
        files=None,
        data=None,
        params=None,
        auth=None,
        cookies=None,
        hooks=None,
        json=None,
    ):
        """Prepares the entire request with the given parameters."""

        self.prepare_method(method)
        self.prepare_url(url, params)
        self.prepare_headers(headers)
        self.prepare_cookies(cookies)
        self.prepare_body(data, files, json)
        self.prepare_auth(auth, url)

        # Note that prepare_auth must be last to enable authentication schemes
        # such as OAuth to work on a fully prepared request.

        # This MUST go after prepare_auth. Authenticators could add a hook
        self.prepare_hooks(hooks)