Pytest

Important

For these helpers to work, you need to install click_extra’s additional dependencies from the pytest extra group:

$ pip install click_extra[pytest]

Utility functions

Todo

Write example and tutorial.

Fixtures

Todo

Write example and tutorial.

click_extra.pytest API

Pytest fixtures and marks to help testing Click CLIs.

click_extra.pytest.runner()

Runner fixture for click_extra.testing.CliRunner.

click_extra.pytest.invoke(runner)

Invoke fixture shorthand for click_extra.testing.CliRunner.invoke().

click_extra.pytest.command_decorators(no_commands=False, no_groups=False, no_click=False, no_cloup=False, no_extra=False, with_parenthesis=True, with_types=False)

Returns collection of Pytest parameters to test all command-like decorators.

Return type:

tuple[ParameterSet, ...]

Returns:

Pytest parameters covering each command-like decorator variant:

• click.command

• click.command()

• cloup.command

• cloup.command()

• click_extra.command

• click_extra.command()

• click.group

• click.group()

• cloup.group

• cloup.group()

• click_extra.group

• click_extra.group()

click_extra.pytest.option_decorators(no_options=False, no_arguments=False, no_click=False, no_cloup=False, no_extra=False, with_parenthesis=True, with_types=False)

Returns collection of Pytest parameters to test all parameter-like decorators.

Return type:

tuple[ParameterSet, ...]

Returns:

Pytest parameters covering each parameter-like decorator variant:

• click.option

• click.option()

• cloup.option

• cloup.option()

• click_extra.option

• click_extra.option()

• click.argument

• click.argument()

• cloup.argument

• cloup.argument()

• click_extra.argument

• click_extra.argument()

click_extra.pytest.create_config(tmp_path)

A generic fixture to produce a temporary configuration file.

click_extra.pytest.assert_output_regex(request)

An assert-like utility for Pytest to compare CLI output against the regex.

Designed for the regexes defined above.