test_cli_runner() — flask Function Reference

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

Function python ApplicationCore Scaffolding

Entity Profile

ApplicationCore→ Scaffolding→ test_cli_runner() — flask Function Reference

Dependency Diagram

graph TD
  d026f8fc_11fe_544d_ffef_729860628157["test_cli_runner()"]
  9f8cc56e_d5c4_e7a8_438a_3124c0dd5de5["Flask"]
  d026f8fc_11fe_544d_ffef_729860628157 -->|defined in| 9f8cc56e_d5c4_e7a8_438a_3124c0dd5de5
  style d026f8fc_11fe_544d_ffef_729860628157 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/app.py lines 812–827

    def test_cli_runner(self, **kwargs: t.Any) -> FlaskCliRunner:
        """Create a CLI runner for testing CLI commands.
        See :ref:`testing-cli`.

        Returns an instance of :attr:`test_cli_runner_class`, by default
        :class:`~flask.testing.FlaskCliRunner`. The Flask app object is
        passed as the first argument.

        .. versionadded:: 1.0
        """
        cls = self.test_cli_runner_class

        if cls is None:
            from .testing import FlaskCliRunner as cls

        return cls(self, **kwargs)  # type: ignore