pytest-flake8dir 2.6.1

flake8dir.make_py_files(**kwargs: str) -> None

为每个传入的关键字参数创建一个Python文件，文件名与关键字参数对应 + ‘.py’，内容根据参数的字符串值。该值将使用 textwrap.dedent() 进行处理，因此在测试文件中混合缩进不会成为问题。

例如，这将在临时目录中创建两个Python文件，分别命名为 example1.py 和 example2.py，每个文件包含一行赋值。

def test_sample(flake8dir):
    flake8dir.make_py_files(
        example1="""
            x = 1
        """,
        example2="""
            y = 1
        """,
    )

flake8dir.make_example_py(content: str) -> None

这是 make_py_files(example=content) 的快捷方式，当你反复使用单个文件时。这只会创建 example.py，通常这已经足够用于测试规则。

例如

def test_sample(flake8dir):
    flake8dir.make_example_py(
        """
        x = 1
    """
    )

flake8dir.make_setup_cfg(contents: str) -> str

在测试目录中创建名为 setup.cfg 的文件，其内容与传入的字符串相同。这同样经过 textwrap.dedent() 处理，因此缩进不会引起担忧。你可能希望将 [flake8] 节标题设置为配置flake8。

例如，这将使flake8忽略规则E101

def test_sample(flake8dir):
    flake8dir.make_setup_cfg(
        """
        [flake8]
        ignore = E101
    """
    )

flake8dir.make_file(filename: str, content: str) -> None

创建具有给定文件名的任意文件 - 此函数是 make_py_files 和 make_setup_cfg 的内部实现。 filename 可以包含目录，如 mydir/foo.py，并且将创建这些目录。 content 将接受与上述所述相同的 textwrap.dedent() 处理。

例如

def test_sample(flake8dir):
    flake8dir.make_file(
        "myfile/foo.py",
        """
        x = 1
    """,
    )

flake8dir.run_flake8(extra_args: list[str] | None = None) -> Flake8Result

运行flake8并返回一个表示结果的 Flake8Result。

extra_args 可以是传递给flake8的额外标志列表，例如，传递 ["--ignore", "E101"] 将会实现与上述 setup.cfg 示例相同的效果。注意，一些参数已经传递以确保flake8以隔离方式运行 - 请参阅源代码。

Flake8Result.out: str

flake8生成的完整输出字符串（stdout）。

Flake8Result.err: str

flake8生成的完整错误输出字符串（stderr）。

Flake8Result.exit_code: int

flake8运行退出的退出代码。

Flake8Result.out_lines: list[str]

输出行的列表，没有尾随换行符。这是进行断言最有用的工具。

例如，给定一个结果，你可以检查是否输出了特定行

result = flake8dir.run_flake8()
expected = "./example.py:1:2: E221 multiple spaces before operator"
assert expected in result.out_lines

Flake8Result.err_lines: list[str]

与 out_lines 类似，但用于错误输出。