1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
|
import os
import re
import pytest
import click
from click import Option
def test_prefixes(runner):
@click.command()
@click.option("++foo", is_flag=True, help="das foo")
@click.option("--bar", is_flag=True, help="das bar")
def cli(foo, bar):
click.echo(f"foo={foo} bar={bar}")
result = runner.invoke(cli, ["++foo", "--bar"])
assert not result.exception
assert result.output == "foo=True bar=True\n"
result = runner.invoke(cli, ["--help"])
assert re.search(r"\+\+foo\s+das foo", result.output) is not None
assert re.search(r"--bar\s+das bar", result.output) is not None
def test_invalid_option(runner):
with pytest.raises(TypeError, match="name was passed") as exc_info:
click.Option(["foo"])
message = str(exc_info.value)
assert "name was passed (foo)" in message
assert "declare an argument" in message
assert "'--foo'" in message
def test_invalid_nargs(runner):
with pytest.raises(TypeError, match="nargs=-1"):
@click.command()
@click.option("--foo", nargs=-1)
def cli(foo):
pass
def test_nargs_tup_composite_mult(runner):
@click.command()
@click.option("--item", type=(str, int), multiple=True)
def copy(item):
for name, id in item:
click.echo(f"name={name} id={id:d}")
result = runner.invoke(copy, ["--item", "peter", "1", "--item", "max", "2"])
assert not result.exception
assert result.output.splitlines() == ["name=peter id=1", "name=max id=2"]
def test_counting(runner):
@click.command()
@click.option("-v", count=True, help="Verbosity", type=click.IntRange(0, 3))
def cli(v):
click.echo(f"verbosity={v:d}")
result = runner.invoke(cli, ["-vvv"])
assert not result.exception
assert result.output == "verbosity=3\n"
result = runner.invoke(cli, ["-vvvv"])
assert result.exception
assert "Invalid value for '-v': 4 is not in the range 0<=x<=3." in result.output
result = runner.invoke(cli, [])
assert not result.exception
assert result.output == "verbosity=0\n"
result = runner.invoke(cli, ["--help"])
assert re.search(r"-v\s+Verbosity", result.output) is not None
@pytest.mark.parametrize("unknown_flag", ["--foo", "-f"])
def test_unknown_options(runner, unknown_flag):
@click.command()
def cli():
pass
result = runner.invoke(cli, [unknown_flag])
assert result.exception
assert f"No such option: {unknown_flag}" in result.output
@pytest.mark.parametrize(
("value", "expect"),
[
("--cat", "Did you mean --count?"),
("--bounds", "(Possible options: --bound, --count)"),
("--bount", "(Possible options: --bound, --count)"),
],
)
def test_suggest_possible_options(runner, value, expect):
cli = click.Command(
"cli", params=[click.Option(["--bound"]), click.Option(["--count"])]
)
result = runner.invoke(cli, [value])
assert expect in result.output
def test_multiple_required(runner):
@click.command()
@click.option("-m", "--message", multiple=True, required=True)
def cli(message):
click.echo("\n".join(message))
result = runner.invoke(cli, ["-m", "foo", "-mbar"])
assert not result.exception
assert result.output == "foo\nbar\n"
result = runner.invoke(cli, [])
assert result.exception
assert "Error: Missing option '-m' / '--message'." in result.output
@pytest.mark.parametrize(
("multiple", "nargs", "default"),
[
(True, 1, []),
(True, 1, [1]),
# (False, -1, []),
# (False, -1, [1]),
(False, 2, [1, 2]),
# (True, -1, [[]]),
# (True, -1, []),
# (True, -1, [[1]]),
(True, 2, []),
(True, 2, [[1, 2]]),
],
)
def test_init_good_default_list(runner, multiple, nargs, default):
click.Option(["-a"], multiple=multiple, nargs=nargs, default=default)
@pytest.mark.parametrize(
("multiple", "nargs", "default"),
[
(True, 1, 1),
# (False, -1, 1),
(False, 2, [1]),
(True, 2, [[1]]),
],
)
def test_init_bad_default_list(runner, multiple, nargs, default):
type = (str, str) if nargs == 2 else None
with pytest.raises(ValueError, match="default"):
click.Option(["-a"], type=type, multiple=multiple, nargs=nargs, default=default)
@pytest.mark.parametrize("env_key", ["MYPATH", "AUTO_MYPATH"])
def test_empty_envvar(runner, env_key):
@click.command()
@click.option("--mypath", type=click.Path(exists=True), envvar="MYPATH")
def cli(mypath):
click.echo(f"mypath: {mypath}")
result = runner.invoke(cli, env={env_key: ""}, auto_envvar_prefix="AUTO")
assert result.exception is None
assert result.output == "mypath: None\n"
def test_multiple_envvar(runner):
@click.command()
@click.option("--arg", multiple=True)
def cmd(arg):
click.echo("|".join(arg))
result = runner.invoke(
cmd, [], auto_envvar_prefix="TEST", env={"TEST_ARG": "foo bar baz"}
)
assert not result.exception
assert result.output == "foo|bar|baz\n"
@click.command()
@click.option("--arg", multiple=True, envvar="X")
def cmd(arg):
click.echo("|".join(arg))
result = runner.invoke(cmd, [], env={"X": "foo bar baz"})
assert not result.exception
assert result.output == "foo|bar|baz\n"
@click.command()
@click.option("--arg", multiple=True, type=click.Path())
def cmd(arg):
click.echo("|".join(arg))
result = runner.invoke(
cmd,
[],
auto_envvar_prefix="TEST",
env={"TEST_ARG": f"foo{os.path.pathsep}bar"},
)
assert not result.exception
assert result.output == "foo|bar\n"
def test_trailing_blanks_boolean_envvar(runner):
@click.command()
@click.option("--shout/--no-shout", envvar="SHOUT")
def cli(shout):
click.echo(f"shout: {shout!r}")
result = runner.invoke(cli, [], env={"SHOUT": " true "})
assert result.exit_code == 0
assert result.output == "shout: True\n"
def test_multiple_default_help(runner):
@click.command()
@click.option("--arg1", multiple=True, default=("foo", "bar"), show_default=True)
@click.option("--arg2", multiple=True, default=(1, 2), type=int, show_default=True)
def cmd(arg, arg2):
pass
result = runner.invoke(cmd, ["--help"])
assert not result.exception
assert "foo, bar" in result.output
assert "1, 2" in result.output
def test_show_default_default_map(runner):
@click.command()
@click.option("--arg", default="a", show_default=True)
def cmd(arg):
click.echo(arg)
result = runner.invoke(cmd, ["--help"], default_map={"arg": "b"})
assert not result.exception
assert "[default: b]" in result.output
def test_multiple_default_type():
opt = click.Option(["-a"], multiple=True, default=(1, 2))
assert opt.nargs == 1
assert opt.multiple
assert opt.type is click.INT
ctx = click.Context(click.Command("test"))
assert opt.get_default(ctx) == (1, 2)
def test_multiple_default_composite_type():
opt = click.Option(["-a"], multiple=True, default=[(1, "a")])
assert opt.nargs == 2
assert opt.multiple
assert isinstance(opt.type, click.Tuple)
assert opt.type.types == [click.INT, click.STRING]
ctx = click.Context(click.Command("test"))
assert opt.type_cast_value(ctx, opt.get_default(ctx)) == ((1, "a"),)
def test_parse_multiple_default_composite_type(runner):
@click.command()
@click.option("-a", multiple=True, default=("a", "b"))
@click.option("-b", multiple=True, default=[(1, "a")])
def cmd(a, b):
click.echo(a)
click.echo(b)
# result = runner.invoke(cmd, "-a c -a 1 -a d -b 2 two -b 4 four".split())
# assert result.output == "('c', '1', 'd')\n((2, 'two'), (4, 'four'))\n"
result = runner.invoke(cmd)
assert result.output == "('a', 'b')\n((1, 'a'),)\n"
def test_dynamic_default_help_unset(runner):
@click.command()
@click.option(
"--username",
prompt=True,
default=lambda: os.environ.get("USER", ""),
show_default=True,
)
def cmd(username):
print("Hello,", username)
result = runner.invoke(cmd, ["--help"])
assert result.exit_code == 0
assert "--username" in result.output
assert "lambda" not in result.output
assert "(dynamic)" in result.output
def test_dynamic_default_help_text(runner):
@click.command()
@click.option(
"--username",
prompt=True,
default=lambda: os.environ.get("USER", ""),
show_default="current user",
)
def cmd(username):
print("Hello,", username)
result = runner.invoke(cmd, ["--help"])
assert result.exit_code == 0
assert "--username" in result.output
assert "lambda" not in result.output
assert "(current user)" in result.output
def test_dynamic_default_help_special_method(runner):
class Value:
def __call__(self):
return 42
def __str__(self):
return "special value"
opt = click.Option(["-a"], default=Value(), show_default=True)
ctx = click.Context(click.Command("cli"))
assert "special value" in opt.get_help_record(ctx)[1]
@pytest.mark.parametrize(
("type", "expect"),
[
(click.IntRange(1, 32), "1<=x<=32"),
(click.IntRange(1, 32, min_open=True, max_open=True), "1<x<32"),
(click.IntRange(1), "x>=1"),
(click.IntRange(max=32), "x<=32"),
],
)
def test_intrange_default_help_text(type, expect):
option = click.Option(["--num"], type=type, show_default=True, default=2)
context = click.Context(click.Command("test"))
result = option.get_help_record(context)[1]
assert expect in result
def test_count_default_type_help():
"""A count option with the default type should not show >=0 in help."""
option = click.Option(["--count"], count=True, help="some words")
context = click.Context(click.Command("test"))
result = option.get_help_record(context)[1]
assert result == "some words"
def test_file_type_help_default():
"""The default for a File type is a filename string. The string
should be displayed in help, not an open file object.
Type casting is only applied to defaults in processing, not when
getting the default value.
"""
option = click.Option(
["--in"], type=click.File(), default=__file__, show_default=True
)
context = click.Context(click.Command("test"))
result = option.get_help_record(context)[1]
assert __file__ in result
def test_toupper_envvar_prefix(runner):
@click.command()
@click.option("--arg")
def cmd(arg):
click.echo(arg)
result = runner.invoke(cmd, [], auto_envvar_prefix="test", env={"TEST_ARG": "foo"})
assert not result.exception
assert result.output == "foo\n"
def test_nargs_envvar(runner):
@click.command()
@click.option("--arg", nargs=2)
def cmd(arg):
click.echo("|".join(arg))
result = runner.invoke(
cmd, [], auto_envvar_prefix="TEST", env={"TEST_ARG": "foo bar"}
)
assert not result.exception
assert result.output == "foo|bar\n"
@click.command()
@click.option("--arg", nargs=2, multiple=True)
def cmd(arg):
for item in arg:
click.echo("|".join(item))
result = runner.invoke(
cmd, [], auto_envvar_prefix="TEST", env={"TEST_ARG": "x 1 y 2"}
)
assert not result.exception
assert result.output == "x|1\ny|2\n"
def test_show_envvar(runner):
@click.command()
@click.option("--arg1", envvar="ARG1", show_envvar=True)
def cmd(arg):
pass
result = runner.invoke(cmd, ["--help"])
assert not result.exception
assert "ARG1" in result.output
def test_show_envvar_auto_prefix(runner):
@click.command()
@click.option("--arg1", show_envvar=True)
def cmd(arg):
pass
result = runner.invoke(cmd, ["--help"], auto_envvar_prefix="TEST")
assert not result.exception
assert "TEST_ARG1" in result.output
def test_show_envvar_auto_prefix_dash_in_command(runner):
@click.group()
def cli():
pass
@cli.command()
@click.option("--baz", show_envvar=True)
def foo_bar(baz):
pass
result = runner.invoke(cli, ["foo-bar", "--help"], auto_envvar_prefix="TEST")
assert not result.exception
assert "TEST_FOO_BAR_BAZ" in result.output
def test_custom_validation(runner):
def validate_pos_int(ctx, param, value):
if value < 0:
raise click.BadParameter("Value needs to be positive")
return value
@click.command()
@click.option("--foo", callback=validate_pos_int, default=1)
def cmd(foo):
click.echo(foo)
result = runner.invoke(cmd, ["--foo", "-1"])
assert "Invalid value for '--foo': Value needs to be positive" in result.output
result = runner.invoke(cmd, ["--foo", "42"])
assert result.output == "42\n"
def test_callback_validates_prompt(runner, monkeypatch):
def validate(ctx, param, value):
if value < 0:
raise click.BadParameter("should be positive")
return value
@click.command()
@click.option("-a", type=int, callback=validate, prompt=True)
def cli(a):
click.echo(a)
result = runner.invoke(cli, input="-12\n60\n")
assert result.output == "A: -12\nError: should be positive\nA: 60\n60\n"
def test_winstyle_options(runner):
@click.command()
@click.option("/debug;/no-debug", help="Enables or disables debug mode.")
def cmd(debug):
click.echo(debug)
result = runner.invoke(cmd, ["/debug"], help_option_names=["/?"])
assert result.output == "True\n"
result = runner.invoke(cmd, ["/no-debug"], help_option_names=["/?"])
assert result.output == "False\n"
result = runner.invoke(cmd, [], help_option_names=["/?"])
assert result.output == "False\n"
result = runner.invoke(cmd, ["/?"], help_option_names=["/?"])
assert "/debug; /no-debug Enables or disables debug mode." in result.output
assert "/? Show this message and exit." in result.output
def test_legacy_options(runner):
@click.command()
@click.option("-whatever")
def cmd(whatever):
click.echo(whatever)
result = runner.invoke(cmd, ["-whatever", "42"])
assert result.output == "42\n"
result = runner.invoke(cmd, ["-whatever=23"])
assert result.output == "23\n"
def test_missing_option_string_cast():
ctx = click.Context(click.Command(""))
with pytest.raises(click.MissingParameter) as excinfo:
click.Option(["-a"], required=True).process_value(ctx, None)
assert str(excinfo.value) == "Missing parameter: a"
def test_missing_required_flag(runner):
cli = click.Command(
"cli", params=[click.Option(["--on/--off"], is_flag=True, required=True)]
)
result = runner.invoke(cli)
assert result.exit_code == 2
assert "Error: Missing option '--on'." in result.output
def test_missing_choice(runner):
@click.command()
@click.option("--foo", type=click.Choice(["foo", "bar"]), required=True)
def cmd(foo):
click.echo(foo)
result = runner.invoke(cmd)
assert result.exit_code == 2
error, separator, choices = result.output.partition("Choose from")
assert "Error: Missing option '--foo'. " in error
assert "Choose from" in separator
assert "foo" in choices
assert "bar" in choices
def test_case_insensitive_choice(runner):
@click.command()
@click.option("--foo", type=click.Choice(["Orange", "Apple"], case_sensitive=False))
def cmd(foo):
click.echo(foo)
result = runner.invoke(cmd, ["--foo", "apple"])
assert result.exit_code == 0
assert result.output == "Apple\n"
result = runner.invoke(cmd, ["--foo", "oRANGe"])
assert result.exit_code == 0
assert result.output == "Orange\n"
result = runner.invoke(cmd, ["--foo", "Apple"])
assert result.exit_code == 0
assert result.output == "Apple\n"
@click.command()
@click.option("--foo", type=click.Choice(["Orange", "Apple"]))
def cmd2(foo):
click.echo(foo)
result = runner.invoke(cmd2, ["--foo", "apple"])
assert result.exit_code == 2
result = runner.invoke(cmd2, ["--foo", "oRANGe"])
assert result.exit_code == 2
result = runner.invoke(cmd2, ["--foo", "Apple"])
assert result.exit_code == 0
def test_case_insensitive_choice_returned_exactly(runner):
@click.command()
@click.option("--foo", type=click.Choice(["Orange", "Apple"], case_sensitive=False))
def cmd(foo):
click.echo(foo)
result = runner.invoke(cmd, ["--foo", "apple"])
assert result.exit_code == 0
assert result.output == "Apple\n"
def test_option_help_preserve_paragraphs(runner):
@click.command()
@click.option(
"-C",
"--config",
type=click.Path(),
help="""Configuration file to use.
If not given, the environment variable CONFIG_FILE is consulted
and used if set. If neither are given, a default configuration
file is loaded.""",
)
def cmd(config):
pass
result = runner.invoke(cmd, ["--help"])
assert result.exit_code == 0
i = " " * 21
assert (
" -C, --config PATH Configuration file to use.\n"
f"{i}\n"
f"{i}If not given, the environment variable CONFIG_FILE is\n"
f"{i}consulted and used if set. If neither are given, a default\n"
f"{i}configuration file is loaded."
) in result.output
def test_argument_custom_class(runner):
class CustomArgument(click.Argument):
def get_default(self, ctx, call=True):
"""a dumb override of a default value for testing"""
return "I am a default"
@click.command()
@click.argument("testarg", cls=CustomArgument, default="you wont see me")
def cmd(testarg):
click.echo(testarg)
result = runner.invoke(cmd)
assert "I am a default" in result.output
assert "you wont see me" not in result.output
def test_option_custom_class(runner):
class CustomOption(click.Option):
def get_help_record(self, ctx):
"""a dumb override of a help text for testing"""
return ("--help", "I am a help text")
@click.command()
@click.option("--testoption", cls=CustomOption, help="you wont see me")
def cmd(testoption):
click.echo(testoption)
result = runner.invoke(cmd, ["--help"])
assert "I am a help text" in result.output
assert "you wont see me" not in result.output
def test_option_custom_class_reusable(runner):
"""Ensure we can reuse a custom class option. See Issue #926"""
class CustomOption(click.Option):
def get_help_record(self, ctx):
"""a dumb override of a help text for testing"""
return ("--help", "I am a help text")
# Assign to a variable to re-use the decorator.
testoption = click.option("--testoption", cls=CustomOption, help="you wont see me")
@click.command()
@testoption
def cmd1(testoption):
click.echo(testoption)
@click.command()
@testoption
def cmd2(testoption):
click.echo(testoption)
# Both of the commands should have the --help option now.
for cmd in (cmd1, cmd2):
result = runner.invoke(cmd, ["--help"])
assert "I am a help text" in result.output
assert "you wont see me" not in result.output
def test_bool_flag_with_type(runner):
@click.command()
@click.option("--shout/--no-shout", default=False, type=bool)
def cmd(shout):
pass
result = runner.invoke(cmd)
assert not result.exception
def test_aliases_for_flags(runner):
@click.command()
@click.option("--warnings/--no-warnings", " /-W", default=True)
def cli(warnings):
click.echo(warnings)
result = runner.invoke(cli, ["--warnings"])
assert result.output == "True\n"
result = runner.invoke(cli, ["--no-warnings"])
assert result.output == "False\n"
result = runner.invoke(cli, ["-W"])
assert result.output == "False\n"
@click.command()
@click.option("--warnings/--no-warnings", "-w", default=True)
def cli_alt(warnings):
click.echo(warnings)
result = runner.invoke(cli_alt, ["--warnings"])
assert result.output == "True\n"
result = runner.invoke(cli_alt, ["--no-warnings"])
assert result.output == "False\n"
result = runner.invoke(cli_alt, ["-w"])
assert result.output == "True\n"
@pytest.mark.parametrize(
"option_args,expected",
[
(["--aggressive", "--all", "-a"], "aggressive"),
(["--first", "--second", "--third", "-a", "-b", "-c"], "first"),
(["--apple", "--banana", "--cantaloupe", "-a", "-b", "-c"], "apple"),
(["--cantaloupe", "--banana", "--apple", "-c", "-b", "-a"], "cantaloupe"),
(["-a", "-b", "-c"], "a"),
(["-c", "-b", "-a"], "c"),
(["-a", "--apple", "-b", "--banana", "-c", "--cantaloupe"], "apple"),
(["-c", "-a", "--cantaloupe", "-b", "--banana", "--apple"], "cantaloupe"),
(["--from", "-f", "_from"], "_from"),
(["--return", "-r", "_ret"], "_ret"),
],
)
def test_option_names(runner, option_args, expected):
@click.command()
@click.option(*option_args, is_flag=True)
def cmd(**kwargs):
click.echo(str(kwargs[expected]))
assert cmd.params[0].name == expected
for form in option_args:
if form.startswith("-"):
result = runner.invoke(cmd, [form])
assert result.output == "True\n"
def test_flag_duplicate_names(runner):
with pytest.raises(ValueError, match="cannot use the same flag for true/false"):
click.Option(["--foo/--foo"], default=False)
@pytest.mark.parametrize(("default", "expect"), [(False, "no-cache"), (True, "cache")])
def test_show_default_boolean_flag_name(runner, default, expect):
"""When a boolean flag has distinct True/False opts, it should show
the default opt name instead of the default value. It should only
show one name even if multiple are declared.
"""
opt = click.Option(
("--cache/--no-cache", "--c/--nc"),
default=default,
show_default=True,
help="Enable/Disable the cache.",
)
ctx = click.Context(click.Command("test"))
message = opt.get_help_record(ctx)[1]
assert f"[default: {expect}]" in message
def test_show_true_default_boolean_flag_value(runner):
"""When a boolean flag only has one opt and its default is True,
it will show the default value, not the opt name.
"""
opt = click.Option(
("--cache",),
is_flag=True,
show_default=True,
default=True,
help="Enable the cache.",
)
ctx = click.Context(click.Command("test"))
message = opt.get_help_record(ctx)[1]
assert "[default: True]" in message
@pytest.mark.parametrize("default", [False, None])
def test_hide_false_default_boolean_flag_value(runner, default):
"""When a boolean flag only has one opt and its default is False or
None, it will not show the default
"""
opt = click.Option(
("--cache",),
is_flag=True,
show_default=True,
default=default,
help="Enable the cache.",
)
ctx = click.Context(click.Command("test"))
message = opt.get_help_record(ctx)[1]
assert "[default: " not in message
def test_show_default_string(runner):
"""When show_default is a string show that value as default."""
opt = click.Option(["--limit"], show_default="unlimited")
ctx = click.Context(click.Command("cli"))
message = opt.get_help_record(ctx)[1]
assert "[default: (unlimited)]" in message
def test_show_default_with_empty_string(runner):
"""When show_default is True and default is set to an empty string."""
opt = click.Option(["--limit"], default="", show_default=True)
ctx = click.Context(click.Command("cli"))
message = opt.get_help_record(ctx)[1]
assert '[default: ""]' in message
def test_do_not_show_no_default(runner):
"""When show_default is True and no default is set do not show None."""
opt = click.Option(["--limit"], show_default=True)
ctx = click.Context(click.Command("cli"))
message = opt.get_help_record(ctx)[1]
assert "[default: None]" not in message
def test_do_not_show_default_empty_multiple():
"""When show_default is True and multiple=True is set, it should not
print empty default value in --help output.
"""
opt = click.Option(["-a"], multiple=True, help="values", show_default=True)
ctx = click.Context(click.Command("cli"))
message = opt.get_help_record(ctx)[1]
assert message == "values"
@pytest.mark.parametrize(
("ctx_value", "opt_value", "expect"),
[
(None, None, False),
(None, False, False),
(None, True, True),
(False, None, False),
(False, False, False),
(False, True, True),
(True, None, True),
(True, False, False),
(True, True, True),
(False, "one", True),
],
)
def test_show_default_precedence(ctx_value, opt_value, expect):
ctx = click.Context(click.Command("test"), show_default=ctx_value)
opt = click.Option("-a", default=1, help="value", show_default=opt_value)
help = opt.get_help_record(ctx)[1]
assert ("default:" in help) is expect
@pytest.mark.parametrize(
("args", "expect"),
[
(None, (None, None, ())),
(["--opt"], ("flag", None, ())),
(["--opt", "-a", 42], ("flag", "42", ())),
(["--opt", "test", "-a", 42], ("test", "42", ())),
(["--opt=test", "-a", 42], ("test", "42", ())),
(["-o"], ("flag", None, ())),
(["-o", "-a", 42], ("flag", "42", ())),
(["-o", "test", "-a", 42], ("test", "42", ())),
(["-otest", "-a", 42], ("test", "42", ())),
(["a", "b", "c"], (None, None, ("a", "b", "c"))),
(["--opt", "a", "b", "c"], ("a", None, ("b", "c"))),
(["--opt", "test"], ("test", None, ())),
(["-otest", "a", "b", "c"], ("test", None, ("a", "b", "c"))),
(["--opt=test", "a", "b", "c"], ("test", None, ("a", "b", "c"))),
],
)
def test_option_with_optional_value(runner, args, expect):
@click.command()
@click.option("-o", "--opt", is_flag=False, flag_value="flag")
@click.option("-a")
@click.argument("b", nargs=-1)
def cli(opt, a, b):
return opt, a, b
result = runner.invoke(cli, args, standalone_mode=False, catch_exceptions=False)
assert result.return_value == expect
def test_multiple_option_with_optional_value(runner):
cli = click.Command(
"cli",
params=[
click.Option(["-f"], is_flag=False, flag_value="flag", multiple=True),
click.Option(["-a"]),
click.Argument(["b"], nargs=-1),
],
callback=lambda **kwargs: kwargs,
)
result = runner.invoke(
cli,
["-f", "-f", "other", "-f", "-a", "1", "a", "b"],
standalone_mode=False,
catch_exceptions=False,
)
assert result.return_value == {
"f": ("flag", "other", "flag"),
"a": "1",
"b": ("a", "b"),
}
def test_type_from_flag_value():
param = click.Option(["-a", "x"], default=True, flag_value=4)
assert param.type is click.INT
param = click.Option(["-b", "x"], flag_value=8)
assert param.type is click.INT
@pytest.mark.parametrize(
("option", "expected"),
[
# Not boolean flags
pytest.param(Option(["-a"], type=int), False, id="int option"),
pytest.param(Option(["-a"], type=bool), False, id="bool non-flag [None]"),
pytest.param(Option(["-a"], default=True), False, id="bool non-flag [True]"),
pytest.param(Option(["-a"], default=False), False, id="bool non-flag [False]"),
pytest.param(Option(["-a"], flag_value=1), False, id="non-bool flag_value"),
# Boolean flags
pytest.param(Option(["-a"], is_flag=True), True, id="is_flag=True"),
pytest.param(Option(["-a/-A"]), True, id="secondary option [implicit flag]"),
pytest.param(Option(["-a"], flag_value=True), True, id="bool flag_value"),
],
)
def test_is_bool_flag_is_correctly_set(option, expected):
assert option.is_bool_flag is expected
@pytest.mark.parametrize(
("kwargs", "message"),
[
({"count": True, "multiple": True}, "'count' is not valid with 'multiple'."),
({"count": True, "is_flag": True}, "'count' is not valid with 'is_flag'."),
],
)
def test_invalid_flag_combinations(runner, kwargs, message):
with pytest.raises(TypeError) as e:
click.Option(["-a"], **kwargs)
assert message in str(e.value)
|