libsa4py

简介

LibSA4Py是Python的静态分析库，它提取了基于训练ML的类型推理模型的类型提示和功能。

• 要求
• 快速安装
• 用法
  • 处理项目
  • 合并项目
• JSON输出

要求

• Python 3.7或更新（建议使用Python 3.8）
• 守望者（用于跑步的Pyre）[可选]
• MACOS或Linux系统

快速安装

 git clone https://github.com/saltudelft/libsa4py.git
cd libsa4py && pip install .

用法

处理项目

给定Python存储库，请运行以下命令来处理源代码文件并生成JSON-Formatted Outputs：

 libsa4py process --p $REPOS_PATH --o $OUTPUT_PATH --d $DUPLICATE_PATH --j $WORKERS_COUNT --l $LIMIT --c --no-nlp --pyre

描述：

• --p $REPOS_PATH ：Python语料库或数据集的路径。
• --o $OUTPUT_PATH ：存储已处理项目的路径。
• --d $DUPLICATE_PATH ：给定数据集的重复文件的路径（即CD4PY工具生成的JSONL.GZ文件）。 [选修的]
• --s ：通往CSV文件的路径，用于分解给定数据集。 [选修的]
• --j $WORKERS_COUNT ：处理项目的工人数量。 [可选，默认值= no。可用的CPU核心]
• --l $LIMIT ：要处理的项目数量。 [选修的]
• --c ：是否忽略处理的项目。 [可选，默认= false]
• --no-nlp ：是否将标准NLP技术应用于提取的标识符。 [可选，默认= true]
• --pyre ：是否要运行pyre来推断给定项目的变量类型。 [可选，默认= false]
• --tc ：是否要在项目中输入检查类型注释。 [可选，默认= false]

合并项目

要将所有处理过的JSON-Formatted项目合并到一个单个数据框架中，请运行以下命令：

 libsa4py merge --o $OUTPUT_PATH --l $LIMIT

描述：

• --o $OUTPUT_PATH ：在上一个处理步骤中使用的处理已处理项目的路径。
• --l $LIMIT ：要合并的项目数量。 [选修的]

应用类型

要将PYRE的推断类型应用于项目，请运行以下命令：

 libsa4py apply --p $REPOS_PATH --o $OUTPUT_PATH

描述：

• --p $REPOS_PATH ：Python语料库或数据集的路径。
• --o $OUTPUT_PATH ：在上一个处理步骤中使用的处理已处理项目的路径。

JSON输出

处理每个项目后，产生了一个json形式的文件，此处描述了。