在yapfignore中包含的文件上预提交yapf失败。

Question

在回购中设置的预提交挂钩之一是yapf (.pre-commit-config.yaml)：

repos:
# Note: the YAPF config is found in `.style.yapf` and `.yapfignore`
-   repo: https://github.com/pre-commit/mirrors-yapf
    rev: v0.29.0
    hooks:
    -   id: yapf

每当我对.yapfignore中包含的文件进行更改并运行预提交钩子时，钩子就会失败：

pre-commit run yapf                                                                                                                                                                                         
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to ****************
yapf.....................................................................Failed
- hook id: yapf
- exit code: 1

yapf: Input filenames did not match any python files

任何人都知道如何避免.yapfignore中包含的文件出现yapf失败。

Answer 1

好的，造成问题的原因是yapf将.yapfignore中的文件视为不存在的文件，因此您将得到一个：

yapf: Input filenames did not match any python files

如果对.yapfignore文件中的任何文件运行yapf，则出错。为了解决pre-commit中的这个问题，我添加了一个现有的python文件，而不是在.yapfignore中作为参数，所以yapf总是有一个文件可以运行。

Answer 2

在您的输出和您正在看到的行为中发生了一些事情，因此我将分别解释它们：

$ pre-commit run yapf                                                                                                                                                                                         
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to ****************

这里的输出表明，pre-commit采用了您未分阶段的更改，并放弃了它们，很可能没有显示您预期的结果。在演示发生了什么事情时，您可能想要pre-commit run yapf --all-files

关于实际的问题。

预提交不知道您使用的任何工具的实现细节(在某种程度上，yapf也不知道！)

当一个文件在.yapfignore中，并将它传递给yapf时，它的行为就好像它不存在一样(这很奇怪！)

$ tail -n999 hello_wat.py .yapfignore 
==> hello_wat.py <==
x =     5+  4

==> .yapfignore <==
hello*.py

$ yapf hello_wat.py 
yapf: Input filenames did not match any python files

您可能想要做的是利用pre-commit的exclude，使文件永远不会传递给yapf！以我的例子为例(您没有共享您的.yapfignore，也没有共享最小的情况)。

repos:
-   repo: https://github.com/pre-commit/mirrors-yapf
    rev: v0.29.0
    hooks:
    -   id: yapf
        exclude: ^hello\.*\.py$

现在yapf不会和hello*.py竞争了！

免责声明:我是预提交的创建者。