open() — flask Function Reference

Architecture documentation for the open() function in testing.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 2 called by 2

Entity Profile

ApplicationCore→ Scaffolding→ open() — flask Function Reference

Dependency Diagram

graph TD
  3dfbf89e_0efa_e73a_439f_b07e59e5d57d["open()"]
  bd3a5eb6_81cb_6392_c9b8_19dcbec7785f["FlaskClient"]
  3dfbf89e_0efa_e73a_439f_b07e59e5d57d -->|defined in| bd3a5eb6_81cb_6392_c9b8_19dcbec7785f
  c92a3a8a_766d_75a0_8dd5_ab00df390e5d["open_resource()"]
  c92a3a8a_766d_75a0_8dd5_ab00df390e5d -->|calls| 3dfbf89e_0efa_e73a_439f_b07e59e5d57d
  5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8["open_instance_resource()"]
  5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8 -->|calls| 3dfbf89e_0efa_e73a_439f_b07e59e5d57d
  1138f3ac_9053_e93b_3cc9_fa68bae97450["_copy_environ()"]
  3dfbf89e_0efa_e73a_439f_b07e59e5d57d -->|calls| 1138f3ac_9053_e93b_3cc9_fa68bae97450
  4e0af686_482d_2acf_be5d_79822774d7b0["_request_from_builder_args()"]
  3dfbf89e_0efa_e73a_439f_b07e59e5d57d -->|calls| 4e0af686_482d_2acf_be5d_79822774d7b0
  style 3dfbf89e_0efa_e73a_439f_b07e59e5d57d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/testing.py lines 204–247

    def open(
        self,
        *args: t.Any,
        buffered: bool = False,
        follow_redirects: bool = False,
        **kwargs: t.Any,
    ) -> TestResponse:
        if args and isinstance(
            args[0], (werkzeug.test.EnvironBuilder, dict, BaseRequest)
        ):
            if isinstance(args[0], werkzeug.test.EnvironBuilder):
                builder = copy(args[0])
                builder.environ_base = self._copy_environ(builder.environ_base or {})  # type: ignore[arg-type]
                request = builder.get_request()
            elif isinstance(args[0], dict):
                request = EnvironBuilder.from_environ(
                    args[0], app=self.application, environ_base=self._copy_environ({})
                ).get_request()
            else:
                # isinstance(args[0], BaseRequest)
                request = copy(args[0])
                request.environ = self._copy_environ(request.environ)
        else:
            # request is None
            request = self._request_from_builder_args(args, kwargs)

        # Pop any previously preserved contexts. This prevents contexts
        # from being preserved across redirects or multiple requests
        # within a single block.
        self._context_stack.close()

        response = super().open(
            request,
            buffered=buffered,
            follow_redirects=follow_redirects,
        )
        response.json_module = self.application.json  # type: ignore[assignment]

        # Re-push contexts that were preserved during the request.
        for cm in self._new_contexts:
            self._context_stack.enter_context(cm)

        self._new_contexts.clear()
        return response