How to test cli command with Python Click options

Question

I have this function that I'm trying to test. In cli.py I have

import myfunction
import click
@click.command(name="run")
@click.option("--param", required=True, type=int)
@click.option("--plot", required=False, default=False)
def run(param, plot):
    myfunction(param, plot)

In my test_cli.py

from click.testing import CliRunner
from cli import run

def test_cli():
    kwargs = {"int": 5, "plot": False}
    runner = CliRunner()
    result = runner.invoke(run, args=kwargs)
    assert resutlts.output == ""

I get the following error:

Missing option --param

with your edit away from --int your test code has got out of sync (should use param not int). And there's a typo resultlts -> results — 2e0byo
– 2e0byo, Commented Sep 21, 2021 at 14:03

2e0byo · Accepted Answer · 2021-09-21 16:12:54Z

2

CliRunner.invoke takes a list of command line parameters, not function parameters.

Specifically you need to call it like this:

runner.invoke(run, args=["--param", "5"])
runner.invoke(run, "--param 5")

for multiple arguments you can use either pattern:

runner.invoke(run, args=["--param", "5", "6"])
runner.invoke(run, args="--param 5 6")

References

https://click.palletsprojects.com/en/8.0.x/testing/

edited Sep 21, 2021 at 16:12

answered Sep 21, 2021 at 14:00

2e0byo

6,0241 gold badge9 silver badges31 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

abdellah Over a year ago

thanks for your answer, what if my param is a list something like this @click.option("--param", required=True, type=(iint, float)) how can I pass the parameter. I trieed ['--param', "5 2"] and ["--param", (5, 3)] but i did not work it shows : param options requires 2 arguments

2e0byo Over a year ago

how would you pass it on the command line?

abdellah Over a year ago

by typing run --param 5 2 click.palletsprojects.com/en/8.0.x/options/…

2e0byo Over a year ago

see latest update

abdellah Over a year ago

Thanks yes it works

|

Collectives™ on Stack Overflow

How to test cli command with Python Click options

1 Answer 1

References

6 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

References

6 Comments

Your Answer

Sign up or log in

Post as a guest

Related