Merge stable into main. (#3674)

Author: Rowlando13

tests/test_utils.py

@@ -0,0 +1,10 @@
+import click
+
+
+def test_iter_keepopenfile(tmpdir):
+    expected = list(map(str, range(10)))
+    p = tmpdir.mkdir("testdir").join("testfile")
+    p.write("\n".join(expected))
+    with p.open() as f:
+        for e_line, a_line in zip(expected, click.utils.KeepOpenFile(f), strict=False):
+            assert e_line == a_line.strip()

tests/test_utils/__init__.py

@@ -0,0 +1,11 @@
+import click
+
+
+def test_iter_lazyfile(tmpdir):
+    expected = list(map(str, range(10)))
+    p = tmpdir.mkdir("testdir").join("testfile")
+    p.write("\n".join(expected))
+    with p.open() as f:
+        with click.utils.LazyFile(f.name) as lf:
+            for e_line, a_line in zip(expected, lf, strict=False):
+                assert e_line == a_line.strip()

tests/test_utils/test_KeepOpenFile.py

@@ -0,0 +1,27 @@
+import pathlib
+
+import pytest
+
+import click
+
+
+class MockMain:
+    __slots__ = "__package__"
+
+    def __init__(self, package_name):
+        self.__package__ = package_name
+
+
+@pytest.mark.parametrize(
+    ("path", "main", "expected"),
+    [
+        ("example.py", None, "example.py"),
+        (str(pathlib.Path("/foo/bar/example.py")), None, "example.py"),
+        ("example", None, "example"),
+        (str(pathlib.Path("example/__main__.py")), "example", "python -m example"),
+        (str(pathlib.Path("example/cli.py")), "example", "python -m example.cli"),
+        (str(pathlib.Path("./example")), "", "example"),
+    ],
+)
+def test_detect_program_name(path, main, expected):
+    assert click.utils._detect_program_name(path, _main=MockMain(main)) == expected

tests/test_utils/test_LazyFile.py

@@ -0,0 +1,17 @@
+import os
+
+import click
+
+
+def test_expand_args(monkeypatch):
+    user = os.path.expanduser("~")
+    assert user in click.utils._expand_args(["~"])
+    monkeypatch.setenv("CLICK_TEST", "hello")
+    assert "hello" in click.utils._expand_args(["$CLICK_TEST"])
+    assert "pyproject.toml" in click.utils._expand_args(["*.toml"])
+    assert os.path.join("tests", "conftest.py") in click.utils._expand_args(
+        ["**/conftest.py"]
+    )
+    assert "*.not-found" in click.utils._expand_args(["*.not-found"])
+    # a bad glob pattern, such as a pytest identifier, should return itself
+    assert click.utils._expand_args(["test.py::test_bad"])[0] == "test.py::test_bad"

tests/test_utils/test__detect_program_name.py

@@ -0,0 +1,49 @@
+import click
+
+
+def test_prompts(runner):
+    @click.command()
+    def test():
+        if click.confirm("Foo"):
+            click.echo("yes!")
+        else:
+            click.echo("no :(")
+
+    result = runner.invoke(test, input="y\n")
+    assert not result.exception
+    assert result.output == "Foo [y/N]: y\nyes!\n"
+
+    result = runner.invoke(test, input="\n")
+    assert not result.exception
+    assert result.output == "Foo [y/N]: \nno :(\n"
+
+    result = runner.invoke(test, input="n\n")
+    assert not result.exception
+    assert result.output == "Foo [y/N]: n\nno :(\n"
+
+    @click.command()
+    def test_no():
+        if click.confirm("Foo", default=True):
+            click.echo("yes!")
+        else:
+            click.echo("no :(")
+
+    result = runner.invoke(test_no, input="y\n")
+    assert not result.exception
+    assert result.output == "Foo [Y/n]: y\nyes!\n"
+
+    result = runner.invoke(test_no, input="\n")
+    assert not result.exception
+    assert result.output == "Foo [Y/n]: \nyes!\n"
+
+    result = runner.invoke(test_no, input="n\n")
+    assert not result.exception
+    assert result.output == "Foo [Y/n]: n\nno :(\n"
+
+
+def test_confirm_repeat(runner):
+    cli = click.Command(
+        "cli", params=[click.Option(["--a/--no-a"], default=None, prompt=True)]
+    )
+    result = runner.invoke(cli, input="\ny\n")
+    assert result.output == "A [y/n]: \nError: invalid input\nA [y/n]: y\n"

tests/test_utils/test__expand_args.py

@@ -0,0 +1,176 @@
+import sys
+from io import BytesIO
+from io import StringIO
+
+import pytest
+
+import click._termui_impl
+import click.utils
+from click._compat import WIN
+
+
+def test_echo(runner):
+    with runner.isolation() as outstreams:
+        click.echo("\N{SNOWMAN}")
+        click.echo(b"\x44\x44")
+        click.echo(42, nl=False)
+        click.echo(b"a", nl=False)
+        click.echo("\x1b[31mx\x1b[39m", nl=False)
+        bytes = outstreams[0].getvalue().replace(b"\r\n", b"\n")
+        assert bytes == b"\xe2\x98\x83\nDD\n42ax"
+
+    # if wrapped, we expect bytes to survive.
+    @click.command()
+    def cli():
+        click.echo(b"\xf6")
+
+    result = runner.invoke(cli, [])
+    assert result.stdout_bytes == b"\xf6\n"
+
+    # Ensure we do not strip for bytes.
+    with runner.isolation() as outstreams:
+        click.echo(bytearray(b"\x1b[31mx\x1b[39m"), nl=False)
+        assert outstreams[0].getvalue() == b"\x1b[31mx\x1b[39m"
+
+
+def test_echo_custom_file():
+    f = StringIO()
+    click.echo("hello", file=f)
+    assert f.getvalue() == "hello\n"
+
+    b = BytesIO()
+    click.echo(b"", b)
+    assert b.getvalue() == b"\n"
+
+
+def test_echo_no_streams(monkeypatch, runner):
+    """echo should not fail when stdout and stderr are None with pythonw on Windows."""
+    with runner.isolation():
+        sys.stdout = None
+        sys.stderr = None
+        click.echo("test")
+        click.echo("test", err=True)
+
+
+def test_echo_with_capsys(capsys):
+    click.echo("Capture me.")
+    out, err = capsys.readouterr()
+    assert out == "Capture me.\n"
+
+
+def test_echo_color_flag(monkeypatch, capfd):
+    isatty = True
+    monkeypatch.setattr(click._compat, "isatty", lambda x: isatty)
+
+    text = "foo"
+    styled_text = click.style(text, fg="red")
+    assert styled_text == "\x1b[31mfoo\x1b[0m"
+
+    click.echo(styled_text, color=False)
+    out, err = capfd.readouterr()
+    assert out == f"{text}\n"
+
+    click.echo(styled_text, color=True)
+    out, err = capfd.readouterr()
+    assert out == f"{styled_text}\n"
+
+    isatty = True
+    click.echo(styled_text)
+    out, err = capfd.readouterr()
+    assert out == f"{styled_text}\n"
+
+    isatty = False
+    # Faking isatty() is not enough on Windows;
+    # the implementation caches the colorama wrapped stream
+    # so we have to use a new stream for each test
+    stream = StringIO()
+    click.echo(styled_text, file=stream)
+    assert stream.getvalue() == f"{text}\n"
+
+    stream = StringIO()
+    click.echo(styled_text, file=stream, color=True)
+    assert stream.getvalue() == f"{styled_text}\n"
+
+
+@pytest.mark.skipif(WIN, reason="Test too complex to make work windows.")
+def test_echo_writing_to_standard_error(capfd, monkeypatch):
+    def emulate_input(text):
+        """Emulate keyboard input."""
+        monkeypatch.setattr(sys, "stdin", StringIO(text))
+
+    click.echo("Echo to standard output")
+    out, err = capfd.readouterr()
+    assert out == "Echo to standard output\n"
+    assert err == ""
+
+    click.echo("Echo to standard error", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Echo to standard error\n"
+
+    emulate_input("asdlkj\n")
+    click.prompt("Prompt to stdin")
+    out, err = capfd.readouterr()
+    assert out == "Prompt to stdin: "
+    assert err == ""
+
+    emulate_input("asdlkj\n")
+    click.prompt("Prompt to stdin with no suffix", prompt_suffix="")
+    out, err = capfd.readouterr()
+    assert out == "Prompt to stdin with no suffix"
+    assert err == ""
+
+    # On non-Windows the full prompt goes through redirect_stdout so
+    # nothing leaks to stdout when err=True.
+    # https://github.com/pallets/click/issues/2968
+    emulate_input("asdlkj\n")
+    click.prompt("Prompt to stderr", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Prompt to stderr: "
+
+    # https://github.com/pallets/click/issues/3019
+    emulate_input("asdlkj\n")
+    click.prompt("Prompt to stderr with no suffix", prompt_suffix="", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Prompt to stderr with no suffix"
+
+    emulate_input("y\n")
+    click.confirm("Prompt to stdin")
+    out, err = capfd.readouterr()
+    assert out == "Prompt to stdin [y/N]: "
+    assert err == ""
+
+    emulate_input("y\n")
+    click.confirm("Prompt to stdin with no suffix", prompt_suffix="")
+    out, err = capfd.readouterr()
+    assert out == "Prompt to stdin with no suffix [y/N]"
+    assert err == ""
+
+    # https://github.com/pallets/click/issues/2968
+    emulate_input("y\n")
+    click.confirm("Prompt to stderr", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Prompt to stderr [y/N]: "
+
+    # https://github.com/pallets/click/issues/3019
+    emulate_input("y\n")
+    click.confirm("Prompt to stderr with no suffix", prompt_suffix="", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Prompt to stderr with no suffix [y/N]"
+
+    monkeypatch.setattr(click.termui, "isatty", lambda x: True)
+    monkeypatch.setattr(click.termui, "getchar", lambda: " ")
+
+    click.pause("Pause to stdout")
+    out, err = capfd.readouterr()
+    assert out == "Pause to stdout\n"
+    assert err == ""
+
+    click.pause("Pause to stderr", err=True)
+    out, err = capfd.readouterr()
+    assert out == ""
+    assert err == "Pause to stderr\n"