open_instance_resource() — flask Function Reference

Architecture documentation for the open_instance_resource() function in app.py from the flask codebase.

Function python ApplicationCore AppLifeCycle calls 1

Entity Profile

ApplicationCore→ AppLifeCycle→ open_instance_resource() — flask Function Reference

Dependency Diagram

graph TD
  5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8["open_instance_resource()"]
  9f8cc56e_d5c4_e7a8_438a_3124c0dd5de5["Flask"]
  5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8 -->|defined in| 9f8cc56e_d5c4_e7a8_438a_3124c0dd5de5
  3dfbf89e_0efa_e73a_439f_b07e59e5d57d["open()"]
  5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8 -->|calls| 3dfbf89e_0efa_e73a_439f_b07e59e5d57d
  style 5a6d3d45_9ce0_b4dc_5aad_19ba0e2d3bd8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/app.py lines 446–466

    def open_instance_resource(
        self, resource: str, mode: str = "rb", encoding: str | None = "utf-8"
    ) -> t.IO[t.AnyStr]:
        """Open a resource file relative to the application's instance folder
        :attr:`instance_path`. Unlike :meth:`open_resource`, files in the
        instance folder can be opened for writing.

        :param resource: Path to the resource relative to :attr:`instance_path`.
        :param mode: Open the file in this mode.
        :param encoding: Open the file with this encoding when opening in text
            mode. This is ignored when opening in binary mode.

        .. versionchanged:: 3.1
            Added the ``encoding`` parameter.
        """
        path = os.path.join(self.instance_path, resource)

        if "b" in mode:
            return open(path, mode)

        return open(path, mode, encoding=encoding)