import os from itertools import chain import pytest import click def test_basic_functionality(runner): @click.command() def cli(): """Hello World!""" click.echo("I EXECUTED") result = runner.invoke(cli, ["--help"]) assert not result.exception assert "Hello World!" in result.output assert "Show this message and exit." in result.output assert result.exit_code == 0 assert "I EXECUTED" not in result.output result = runner.invoke(cli, []) assert not result.exception assert "I EXECUTED" in result.output assert result.exit_code == 0 def test_repr(): @click.command() def command(): pass @click.group() def group(): pass @group.command() def subcommand(): pass assert repr(command) == "" assert repr(group) == "" assert repr(subcommand) == "" def test_return_values(): @click.command() def cli(): return 42 with cli.make_context("foo", []) as ctx: rv = cli.invoke(ctx) assert rv == 42 def test_basic_group(runner): @click.group() def cli(): """This is the root.""" click.echo("ROOT EXECUTED") @cli.command() def subcommand(): """This is a subcommand.""" click.echo("SUBCOMMAND EXECUTED") result = runner.invoke(cli, ["--help"]) assert not result.exception assert "COMMAND [ARGS]..." in result.output assert "This is the root" in result.output assert "This is a subcommand." in result.output assert result.exit_code == 0 assert "ROOT EXECUTED" not in result.output result = runner.invoke(cli, ["subcommand"]) assert not result.exception assert result.exit_code == 0 assert "ROOT EXECUTED" in result.output assert "SUBCOMMAND EXECUTED" in result.output def test_group_commands_dict(runner): """A Group can be built with a dict of commands.""" @click.command() def sub(): click.echo("sub", nl=False) cli = click.Group(commands={"other": sub}) result = runner.invoke(cli, ["other"]) assert result.output == "sub" def test_group_from_list(runner): """A Group can be built with a list of commands.""" @click.command() def sub(): click.echo("sub", nl=False) cli = click.Group(commands=[sub]) result = runner.invoke(cli, ["sub"]) assert result.output == "sub" @pytest.mark.parametrize( ("args", "expect"), [ ([], "S:[no value]"), (["--s=42"], "S:[42]"), (["--s"], "Error: Option '--s' requires an argument."), (["--s="], "S:[]"), (["--s=\N{SNOWMAN}"], "S:[\N{SNOWMAN}]"), ], ) def test_string_option(runner, args, expect): @click.command() @click.option("--s", default="no value") def cli(s): click.echo(f"S:[{s}]") result = runner.invoke(cli, args) assert expect in result.output if expect.startswith("Error:"): assert result.exception is not None else: assert result.exception is None @pytest.mark.parametrize( ("args", "expect"), [ ([], "I:[84]"), (["--i=23"], "I:[46]"), (["--i=x"], "Error: Invalid value for '--i': 'x' is not a valid integer."), ], ) def test_int_option(runner, args, expect): @click.command() @click.option("--i", default=42) def cli(i): click.echo(f"I:[{i * 2}]") result = runner.invoke(cli, args) assert expect in result.output if expect.startswith("Error:"): assert result.exception is not None else: assert result.exception is None @pytest.mark.parametrize( ("args", "expect"), [ ([], "U:[ba122011-349f-423b-873b-9d6a79c688ab]"), ( ["--u=821592c1-c50e-4971-9cd6-e89dc6832f86"], "U:[821592c1-c50e-4971-9cd6-e89dc6832f86]", ), (["--u=x"], "Error: Invalid value for '--u': 'x' is not a valid UUID."), ], ) def test_uuid_option(runner, args, expect): @click.command() @click.option( "--u", default="ba122011-349f-423b-873b-9d6a79c688ab", type=click.UUID ) def cli(u): click.echo(f"U:[{u}]") result = runner.invoke(cli, args) assert expect in result.output if expect.startswith("Error:"): assert result.exception is not None else: assert result.exception is None @pytest.mark.parametrize( ("args", "expect"), [ ([], "F:[42.0]"), ("--f=23.5", "F:[23.5]"), ("--f=x", "Error: Invalid value for '--f': 'x' is not a valid float."), ], ) def test_float_option(runner, args, expect): @click.command() @click.option("--f", default=42.0) def cli(f): click.echo(f"F:[{f}]") result = runner.invoke(cli, args) assert expect in result.output if expect.startswith("Error:"): assert result.exception is not None else: assert result.exception is None @pytest.mark.parametrize("default", [True, False]) @pytest.mark.parametrize( ("args", "expect"), [(["--on"], True), (["--off"], False), ([], None)] ) def test_boolean_switch(runner, default, args, expect): @click.command() @click.option("--on/--off", default=default) def cli(on): return on if expect is None: expect = default result = runner.invoke(cli, args, standalone_mode=False) assert result.return_value is expect @pytest.mark.parametrize("default", [True, False]) @pytest.mark.parametrize(("args", "expect"), [(["--f"], True), ([], False)]) def test_boolean_flag(runner, default, args, expect): @click.command() @click.option("--f", is_flag=True, default=default) def cli(f): return f if default: expect = not expect result = runner.invoke(cli, args, standalone_mode=False) assert result.return_value is expect @pytest.mark.parametrize( ("value", "expect"), chain( ((x, "True") for x in ("1", "true", "t", "yes", "y", "on")), ((x, "False") for x in ("0", "false", "f", "no", "n", "off")), ), ) def test_boolean_conversion(runner, value, expect): @click.command() @click.option("--flag", type=bool) def cli(flag): click.echo(flag, nl=False) result = runner.invoke(cli, ["--flag", value]) assert result.output == expect result = runner.invoke(cli, ["--flag", value.title()]) assert result.output == expect def test_file_option(runner): @click.command() @click.option("--file", type=click.File("w")) def input(file): file.write("Hello World!\n") @click.command() @click.option("--file", type=click.File("r")) def output(file): click.echo(file.read()) with runner.isolated_filesystem(): result_in = runner.invoke(input, ["--file=example.txt"]) result_out = runner.invoke(output, ["--file=example.txt"]) assert not result_in.exception assert result_in.output == "" assert not result_out.exception assert result_out.output == "Hello World!\n\n" def test_file_lazy_mode(runner): do_io = False @click.command() @click.option("--file", type=click.File("w")) def input(file): if do_io: file.write("Hello World!\n") @click.command() @click.option("--file", type=click.File("r")) def output(file): pass with runner.isolated_filesystem(): os.mkdir("example.txt") do_io = True result_in = runner.invoke(input, ["--file=example.txt"]) assert result_in.exit_code == 1 do_io = False result_in = runner.invoke(input, ["--file=example.txt"]) assert result_in.exit_code == 0 result_out = runner.invoke(output, ["--file=example.txt"]) assert result_out.exception @click.command() @click.option("--file", type=click.File("w", lazy=False)) def input_non_lazy(file): file.write("Hello World!\n") with runner.isolated_filesystem(): os.mkdir("example.txt") result_in = runner.invoke(input_non_lazy, ["--file=example.txt"]) assert result_in.exit_code == 2 assert "Invalid value for '--file': 'example.txt'" in result_in.output def test_path_option(runner): @click.command() @click.option("-O", type=click.Path(file_okay=False, exists=True, writable=True)) def write_to_dir(o): with open(os.path.join(o, "foo.txt"), "wb") as f: f.write(b"meh\n") with runner.isolated_filesystem(): os.mkdir("test") result = runner.invoke(write_to_dir, ["-O", "test"]) assert not result.exception with open("test/foo.txt", "rb") as f: assert f.read() == b"meh\n" result = runner.invoke(write_to_dir, ["-O", "test/foo.txt"]) assert "is a file" in result.output @click.command() @click.option("-f", type=click.Path(exists=True)) def showtype(f): click.echo(f"is_file={os.path.isfile(f)}") click.echo(f"is_dir={os.path.isdir(f)}") with runner.isolated_filesystem(): result = runner.invoke(showtype, ["-f", "xxx"]) assert "does not exist" in result.output result = runner.invoke(showtype, ["-f", "."]) assert "is_file=False" in result.output assert "is_dir=True" in result.output @click.command() @click.option("-f", type=click.Path()) def exists(f): click.echo(f"exists={os.path.exists(f)}") with runner.isolated_filesystem(): result = runner.invoke(exists, ["-f", "xxx"]) assert "exists=False" in result.output result = runner.invoke(exists, ["-f", "."]) assert "exists=True" in result.output def test_choice_option(runner): @click.command() @click.option("--method", type=click.Choice(["foo", "bar", "baz"])) def cli(method): click.echo(method) result = runner.invoke(cli, ["--method=foo"]) assert not result.exception assert result.output == "foo\n" result = runner.invoke(cli, ["--method=meh"]) assert result.exit_code == 2 assert ( "Invalid value for '--method': 'meh' is not one of 'foo', 'bar', 'baz'." in result.output ) result = runner.invoke(cli, ["--help"]) assert "--method [foo|bar|baz]" in result.output def test_choice_argument(runner): @click.command() @click.argument("method", type=click.Choice(["foo", "bar", "baz"])) def cli(method): click.echo(method) result = runner.invoke(cli, ["foo"]) assert not result.exception assert result.output == "foo\n" result = runner.invoke(cli, ["meh"]) assert result.exit_code == 2 assert ( "Invalid value for '{foo|bar|baz}': 'meh' is not one of 'foo'," " 'bar', 'baz'." in result.output ) result = runner.invoke(cli, ["--help"]) assert "{foo|bar|baz}" in result.output def test_datetime_option_default(runner): @click.command() @click.option("--start_date", type=click.DateTime()) def cli(start_date): click.echo(start_date.strftime("%Y-%m-%dT%H:%M:%S")) result = runner.invoke(cli, ["--start_date=2015-09-29"]) assert not result.exception assert result.output == "2015-09-29T00:00:00\n" result = runner.invoke(cli, ["--start_date=2015-09-29T09:11:22"]) assert not result.exception assert result.output == "2015-09-29T09:11:22\n" result = runner.invoke(cli, ["--start_date=2015-09"]) assert result.exit_code == 2 assert ( "Invalid value for '--start_date': '2015-09' does not match the formats" " '%Y-%m-%d', '%Y-%m-%dT%H:%M:%S', '%Y-%m-%d %H:%M:%S'." ) in result.output result = runner.invoke(cli, ["--help"]) assert ( "--start_date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]" in result.output ) def test_datetime_option_custom(runner): @click.command() @click.option("--start_date", type=click.DateTime(formats=["%A %B %d, %Y"])) def cli(start_date): click.echo(start_date.strftime("%Y-%m-%dT%H:%M:%S")) result = runner.invoke(cli, ["--start_date=Wednesday June 05, 2010"]) assert not result.exception assert result.output == "2010-06-05T00:00:00\n" def test_required_option(runner): @click.command() @click.option("--foo", required=True) def cli(foo): click.echo(foo) result = runner.invoke(cli, []) assert result.exit_code == 2 assert "Missing option '--foo'" in result.output def test_evaluation_order(runner): called = [] def memo(ctx, param, value): called.append(value) return value @click.command() @click.option("--missing", default="missing", is_eager=False, callback=memo) @click.option("--eager-flag1", flag_value="eager1", is_eager=True, callback=memo) @click.option("--eager-flag2", flag_value="eager2", is_eager=True, callback=memo) @click.option("--eager-flag3", flag_value="eager3", is_eager=True, callback=memo) @click.option("--normal-flag1", flag_value="normal1", is_eager=False, callback=memo) @click.option("--normal-flag2", flag_value="normal2", is_eager=False, callback=memo) @click.option("--normal-flag3", flag_value="normal3", is_eager=False, callback=memo) def cli(**x): pass result = runner.invoke( cli, [ "--eager-flag2", "--eager-flag1", "--normal-flag2", "--eager-flag3", "--normal-flag3", "--normal-flag3", "--normal-flag1", "--normal-flag1", ], ) assert not result.exception assert called == [ "eager2", "eager1", "eager3", "normal2", "normal3", "normal1", "missing", ] def test_hidden_option(runner): @click.command() @click.option("--nope", hidden=True) def cli(nope): click.echo(nope) result = runner.invoke(cli, ["--help"]) assert result.exit_code == 0 assert "--nope" not in result.output def test_hidden_command(runner): @click.group() def cli(): pass @cli.command(hidden=True) def nope(): pass result = runner.invoke(cli, ["--help"]) assert result.exit_code == 0 assert "nope" not in result.output def test_hidden_group(runner): @click.group() def cli(): pass @cli.group(hidden=True) def subgroup(): pass @subgroup.command() def nope(): pass result = runner.invoke(cli, ["--help"]) assert result.exit_code == 0 assert "subgroup" not in result.output assert "nope" not in result.output def test_summary_line(runner): @click.group() def cli(): pass @cli.command() def cmd(): """ Summary line without period Here is a sentence. And here too. """ pass result = runner.invoke(cli, ["--help"]) assert "Summary line without period" in result.output assert "Here is a sentence." not in result.output def test_help_invalid_default(runner): cli = click.Command( "cli", params=[ click.Option( ["-a"], type=click.Path(exists=True), default="not found", show_default=True, ), ], ) result = runner.invoke(cli, ["--help"]) assert result.exit_code == 0 assert "default: not found" in result.output