pysa用户是否需要复制配置文件？

问题描述

Facebook的Pysa工具看起来很有用，在Pysa教程练习中，他们引用在pyre-check存储库中提供的文件，并使用相对路径包括练习目录之外的路径。

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-check 在配置文件中的 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-check 使用以下算法遍历 typeshed 目录：

如果它包含 third_party 子目录，则使用旧方法：只输入两个子目录：stdlib 和 third_party，然后查找除名称以 { 开头的子目录之外的任何子目录{1}} 但不是 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 目录。不要把它设置到 Pyre-check 的目录，创建你自己的新目录并只复制那些与你相关的文件。

static-analysis taint