class documentation

class FlaskCliRunner(CliRunner): (source)

View In Hierarchy

A :class:`~click.testing.CliRunner` for testing a Flask app's CLI commands. Typically created using :meth:`~flask.Flask.test_cli_runner`. See :ref:`testing-cli`.

Method __init__ Undocumented
Method invoke Invokes a CLI command in an isolated environment. See :meth:`CliRunner.invoke <click.testing.CliRunner.invoke>` for full method documentation. See :ref:`testing-cli` for examples.
Instance Variable app Undocumented
def __init__(self, app: Flask, **kwargs: t.Any): (source)

Undocumented

def invoke(self, cli: t.Any = None, args: t.Any = None, **kwargs: t.Any) -> t.Any: (source)

Invokes a CLI command in an isolated environment. See :meth:`CliRunner.invoke <click.testing.CliRunner.invoke>` for full method documentation. See :ref:`testing-cli` for examples. If the ``obj`` argument is not given, passes an instance of :class:`~flask.cli.ScriptInfo` that knows how to load the Flask app being tested. :param cli: Command object to invoke. Default is the app's :attr:`~flask.app.Flask.cli` group. :param args: List of strings to invoke the command with. :return: a :class:`~click.testing.Result` object.

Undocumented