使用 Python Click 测试参数

Question

我有一个带有 Python-click 的命令行脚本，带有参数和选项：

# console.py
import click

@click.command()
@click.version_option()
@click.argument("filepath", type=click.Path(exists=True), default=".")
@click.option(
    "-m",
    "--max-size",
    type=int,
    help="Max size in megabytes.",
    default=20,
    show_default=True,
)
def main(filepath: str, max_size: int) -> None:
    max_size_bytes = max_size * 1024 * 1024  # convert to MB
    if filepath.endswith(".pdf"):
        print("success")
    else:
        print(max_size_bytes)

参数和选项都有默认值，并且在命令行上工作，并且使用 CLI 时它的行为符合预期。但是当我尝试按照 Click文档测试它并调试它时，它不会进入第一行：

# test_console.py
from unittest.mock import Mock

import click.testing
import pytest
from pytest_mock import MockFixture

from pdf_split_tool import console

@pytest.fixture
def runner() -> click.testing.CliRunner:
    """Fixture for invoking command-line interfaces."""
    return click.testing.CliRunner()

@pytest.fixture
def mock_pdf_splitter_pdfsplitter(mocker: MockFixture) -> Mock:
    """Fixture for mocking pdf_splitter.PdfSplitter."""
    return mocker.patch("pdf_split_tool.pdf_splitter.PdfSplitter", autospec=True)

def test_main_uses_specified_filepath(
    runner: click.testing.CliRunner,
    mock_pdf_splitter_pdfsplitter: Mock, 
) -> None:
    """It uses the specified filepath."""
    result = runner.invoke(console.main, ["test.pdf"])
    assert result.exit_code == 0

我不明白为什么它会给出，因为调试器没有进入函数 main() 的第一行。有什么想法可能是错误的吗？

Answer 1

失败的原因是以下错误。

(pdb)print result.output
"Usage: main [OPTIONS] [FILEPATH]\nTry 'main --help' for help.\n\nError: Invalid value for '[FILEPATH]': Path 'test.pdf' does not exist.\n"

这是由于 console.py 中的以下代码检查文件路径是否存在而发生的。 @click.argument("filepath", type=click.Path(exists=True), default=".")

测试创建临时文件的一种方法是使用 afterburner 的代码：

(pdb)print result.output
"Usage: main [OPTIONS] [FILEPATH]\nTry 'main --help' for help.\n\nError: Invalid value for '[FILEPATH]': Path 'test.pdf' does not exist.\n"

Answer 2

我已将您的测试方法更改为以下。然而，这更多的是对 apoorva kamath 答案的补充。

def test_main_uses_specified_filepath() -> None:
    runner = click.testing.CliRunner()
    with runner.isolated_filesystem():
        with open('test.pdf', 'w') as f:
            f.write('Hello World!')

        result = runner.invoke(main, ["test.pdf"])
    assert result.exit_code == 0

简而言之，它创建了一个隔离的文件系统，该系统在文本执行后会被清理。因此，在那里创建的任何文件都会随之被销毁。

有关更多信息，Click 的独立文件系统文档可能会派上用场。

或者，您可以删除exists=True文件路径的参数。