from_file() — flask Function Reference

Architecture documentation for the from_file() function in config.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 2

Entity Profile

ApplicationCore→ Scaffolding→ from_file() — flask Function Reference

Dependency Diagram

graph TD
  55ea84cc_e473_fddf_9541_660cc445cb55["from_file()"]
  1e067a59_9e9f_8edb_0434_65b5c5690e36["Config"]
  55ea84cc_e473_fddf_9541_660cc445cb55 -->|defined in| 1e067a59_9e9f_8edb_0434_65b5c5690e36
  78c05fd2_59f8_47ae_0cf0_811efaed6c49["from_mapping()"]
  55ea84cc_e473_fddf_9541_660cc445cb55 -->|calls| 78c05fd2_59f8_47ae_0cf0_811efaed6c49
  b78e55af_d200_5c9a_b306_837877d89a57["load()"]
  55ea84cc_e473_fddf_9541_660cc445cb55 -->|calls| b78e55af_d200_5c9a_b306_837877d89a57
  style 55ea84cc_e473_fddf_9541_660cc445cb55 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/config.py lines 256–302

    def from_file(
        self,
        filename: str | os.PathLike[str],
        load: t.Callable[[t.IO[t.Any]], t.Mapping[str, t.Any]],
        silent: bool = False,
        text: bool = True,
    ) -> bool:
        """Update the values in the config from a file that is loaded
        using the ``load`` parameter. The loaded data is passed to the
        :meth:`from_mapping` method.

        .. code-block:: python

            import json
            app.config.from_file("config.json", load=json.load)

            import tomllib
            app.config.from_file("config.toml", load=tomllib.load, text=False)

        :param filename: The path to the data file. This can be an
            absolute path or relative to the config root path.
        :param load: A callable that takes a file handle and returns a
            mapping of loaded data from the file.
        :type load: ``Callable[[Reader], Mapping]`` where ``Reader``
            implements a ``read`` method.
        :param silent: Ignore the file if it doesn't exist.
        :param text: Open the file in text or binary mode.
        :return: ``True`` if the file was loaded successfully.

        .. versionchanged:: 2.3
            The ``text`` parameter was added.

        .. versionadded:: 2.0
        """
        filename = os.path.join(self.root_path, filename)

        try:
            with open(filename, "r" if text else "rb") as f:
                obj = load(f)
        except OSError as e:
            if silent and e.errno in (errno.ENOENT, errno.EISDIR):
                return False

            e.strerror = f"Unable to load configuration file ({e.strerror})"
            raise

        return self.from_mapping(obj)