Facebook的Pysa工具看起来很有用,在Pysa教程练习中,它们引用了pyre检查存储库中提供的文件,使用相对路径包括练习目录之外的路径。
https://github.com/facebook/pyre-check/blob/master/pysa_tutorial/exercise1/.pyre_configuration
{
"source_directories": ["."],
"taint_models_path": ["."],
"search_path": [
"../../stubs/"
],
"exclude": [
".*/integration_test/.*"
]
}
pyre check存储库中为Django提供了存根,如果我知道pyre check的安装路径,我可以在我的.pyre_configuration
中硬编码并使其正常工作,但另一个开发人员可能会以不同的方式安装pyre check。
有没有更好的方法来引用这些提供的存根,或者我应该将它们复制到我正在处理的存储库中?
许多项目都有一个标准的开发环境,允许在.pyre_configuration
文件中使用硬编码路径。这些通常指向venv
,或其他一些依赖关系的标准安装位置。
对于没有标准开发环境的项目,可以尝试将pyre init
合并到设置脚本中。pyre init
将设置一个新的.pyre_configuration
文件,该文件的路径与pyre
的当前安装相对应。对于要在生成的.pyre_configuration
文件上添加的其他配置(例如指向本地污染模型的指针(,您可以手动编写一个.pyre_configuration.local
,它将充当覆盖并覆盖/添加到.pyre_configuration
的内容。
Pyre检查在配置文件中typeshed
指令指定的目录中查找存根。
最简单的方法是将pyre check存储库中为Django提供的存根移动到pyre check目录中的typeshed
目录中。
例如,如果您已将pyre check安装到~/.local/lib
目录,请将django
目录从~/.local/lib/pyre_check/stubs
移动到~/.local/lib/pyre_check/typeshed/third_party/2and3/
,并确保您的.pyre_configuration文件如下所示:
{
"source_directories": ["~/myproject"],
"taint_models_path": "~/myproject/taint",
"typeshed": "~/.local/lib/pyre_check/typeshed"
}
在这种情况下,Django存根目录将是~/.local/lib/pyre_check/typeshed/third_parth/2and3/Django-
Pyre检查使用以下算法遍历typeshed
目录:
- 如果它包含
third_party
子目录,它将使用传统方法:只输入两个子目录:stdlib
和third_party
,并查找除名称以2
而非2and3
开头的子目录之外的任何子目录,并在这些子目录(如2and3
(中查找模块,例如在third_party/2and3/
中 - 否则,它进入子目录
stubs
和stdlib
,并在那里查找模块,例如在stubs/
中,但不在stubs/2and3/
中
这就是为什么指定多个路径可能会令人困惑和困惑,最简单的方法是将typeshed
目录设置为~/.local/lib/pyre_check/typeshed/
,并将django
移动到third_parth/2and3
,因此它将是~/.local/lib/pyre_check/typeshed/third_parth/2and3/django
。
另外,不要忘记将所需的.pysa
文件复制到taint_models_path
目录中。不要将其设置为Pyre检查的目录,创建自己的新目录,只复制那些与您相关的文件。