MadForHooks

随机杂项pre-commit钩子。

使用方法

将此内容放入您的.pre-commit-config.yaml文件的repos部分

-   repo: https://github.com/MarcoGorelli/madforhooks
    rev: 0.4.1
    hooks:
    -   id: conda-env-sorter
    -   id: no-print-statements
    -   id: check-execution-order
    -   id: check-test-naming

或者，从命令行运行

pip install madforhooks
python -m madforhooks.check_execution_order file1.ipynb file2.ipynb file3.ipynb

如何在测试目录上运行check-test-naming的示例

git ls-files | xargs python -m madforhooks.check_test_naming

可用的钩子

conda-env-sorter

对您的conda环境文件中的依赖项进行排序。

no-print-statements

如果找到打印语句，则引发错误（除非它们具有file=）。

check-execution-order

如果notebook单元执行顺序错误，则引发错误。使用--strict确保严格的单调性。

check-test-naming

检查测试名称是否以test开头。这对于找到本应在CI中运行的测试，但由于命名错误而没有运行的情况非常有用。

如果有任何误报，您可以通过在函数/类定义所在的行添加注释# not a test来防止此工具标记它们。