libsa4py

イントロ

LibSA4Py 、MLベースのタイプ推論モデルをトレーニングするためのタイプのヒントと機能を抽出するPythonの静的分析ライブラリです。

• 要件
• クイックインストール
• 使用法
  • プロジェクトの処理
  • マージプロジェクト
• JSON出力

要件

• Python 3.7以降（Python 3.8をお勧めします）
• ウォッチマン（パイアを実行するため）[オプション]
• MacOSまたはLinuxシステム

クイックインストール

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

使用法

プロジェクトの処理

Pythonリポジトリの場合、次のコマンドを実行してソースコードファイルを処理し、JSON形式の出力を生成します。

 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 ：プロジェクトの処理のための労働者の数。 [オプション、デフォルト=いいえ。利用可能なCPUコアの]
• --l $LIMIT ：処理されるプロジェクトの数。 [オプション]
• --c ：処理されたプロジェクトを無視するかどうか。 [オプション、デフォルト= false]
• --no-nlp ：抽出された識別子に標準のNLP技術を適用するかどうか。 [オプション、デフォルト= true]
• --pyre ：特定のプロジェクトの変数の種類を推測するためにpyreを実行するかどうか。 [オプション、デフォルト= false]
• --tc ：プロジェクトでタイプの注釈を入力するかどうか。 [オプション、デフォルト= false]

マージプロジェクト

処理されたすべてのJSON形式のプロジェクトを単一のデータフレームに統合するには、次のコマンドを実行します。

 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形式のファイルが作成されます。これについては、ここで説明します。