inspect4py下載 - inspect4py源代碼下載

Inspect4Py

庫允許用戶檢查軟件項目文件夾（即目錄及其子目錄），並提取所有最相關的信息，例如類，方法和參數文檔，類（及其方法），功能，等等。

特徵：

給定一個帶代碼的文件夾， inspect4py將：

提取所有導入的模塊以及如何將每個模塊導入為（即它們是內部還是外部）。
提取代碼中的所有功能，包括其文檔，參數，接受的值和呼叫列表。
提取代碼中的所有類，以及所有方法和各自的文檔
提取每個文件的控制流。
提取目錄和文件的層次結構。
提取軟件項目中使用的要求。
分類哪些文件是測試
對軟件項目的主要類型（腳本，軟件包，庫或服務）進行分類。僅將一種類型返回為主要類型（例如，如果庫可以將選項部署為服務，則inspect4py將返回Library作為其主要類型）
返回通過相關性訂購的AA軟件組件的不同方式的排名。

所有元數據都被提取為JSON文件。

Inspect4Py目前僅適用於Python 3項目。

背景：

inspect4py添加了受GraphCodebert啟發的每個功能的捕獲數據流圖的功能：GitHub＆Paper。給出了插圖：

原始碼	列表輸出	NetworkX圖像
DEF MAX（A，B）： x = 0 如果a> b： x = a 別的： x = b 返回x	（'a'，3，'cassfrom'，[]，[]）（'b'，5，'cassfrom'，[]，[]）（'x'，8，'computedfrom'，['0']，[10]）（'0'，10，'cosefrom'，[]，[]）（'a'，12，'cosefrom'，['a']，[3]）（'b'，14，'cassfrom'，['b']，[5]）（'x'，16，'computedfrom'，['a']，[18]）（'a'，18，'cassfrom'，['a']，[3]）（'x'，21，'computedfrom'，['b']，[23]）（'b'，23，'cassfrom'，['b']，[5]）（'x'，25，'cassfrom'，['x']，[16，21]）

原始碼

列表輸出

NetworkX圖像

DEF MAX（A，B）：
 x = 0
 如果a> b：
 x = a
別的：
 x = b
 返回x

 （'a'，3，'cassfrom'，[]，[]）
 （'b'，5，'cassfrom'，[]，[]）
 （'x'，8，'computedfrom'，['0']，[10]）
 （'0'，10，'cosefrom'，[]，[]）
 （'a'，12，'cosefrom'，['a']，[3]）
 （'b'，14，'cassfrom'，['b']，[5]）
 （'x'，16，'computedfrom'，['a']，[18]）
 （'a'，18，'cassfrom'，['a']，[3]）
 （'x'，21，'computedfrom'，['b']，[23]）
 （'b'，23，'cassfrom'，['b']，[5]）
 （'x'，25，'cassfrom'，['x']，[16，21]）

inspect4py使用AST，更具體地說是Python中的AST模塊，生成了一個對象樹（每個文件），其類別從AST.AST繼承。

inspect4py將每個輸入文件解析為AST樹，提取相關信息並將其存儲為JSON文件。此外，它還使用另外兩個庫捕獲每個輸入文件的控制流：

staticfg：staticfg是一個軟件包，可用於生成Python 3程序的控制流程圖（CFG）。它生成的CFG可以通過GraphViz輕鬆可視化並用於靜態分析。我們在代碼（flag_png）中有一個標誌，以指示是否要生成此類控制流程圖。注意：此軟件包的原始代碼可以在此處找到，該代碼已將其修復在我們的存儲庫中

我們還使用docstring_parser，該docstring_parser支持REST，Google和NumpyDoc-Style Docstrings。可以在此處找到一些使用此庫進行的（基本）測試。

最後，我們重用Pigar自動生成給定存儲庫的要求。這是一個可選的該概要。為了激活參數（ -r ），必須在運行Inspect4Py時指示。

引用Inspect4py

請引用我們的MSR 2022演示紙：

 @inproceedings{FilgueiraG22,
  author    = {Rosa Filgueira and
               Daniel Garijo},
  title     = {Inspect4py: {A} Knowledge Extraction Framework for Python Code Repositories},
  booktitle = {{IEEE/ACM} 19th International Conference on Mining Software Repositories,
               {MSR} 2022, Pittsburgh, PA, USA, May 23-24, 2022},
  pages     = {232--236},
  publisher = {{IEEE}},
  year      = {2022},
  url       = {https://dgarijo.com/papers/inspect4py_MSR2022.pdf},
  doi       = {10.1145/3524842.3528497}
}

安裝

預賽

確保已安裝了樹劑，需要C符合C，更多信息：

 pip install tree-sitter

請注意，如果“ .so”文件無法正常工作，建議運行以下操作以生成OS的SO文件：

 git clone https://github.com/tree-sitter/tree-sitter-python

python inspect4py/build.py

確保已安裝了GraphViz：

 sudo apt-get install graphviz

Python版本

我們已經在python 3.7+中測試了inspect4py 。我們推薦的版本是Python 3.9 。

手術系統

我們已經在UNIX，MACOS和Windows 11（22621.1265）中測試了inspect4py 。

來自PYPI的安裝

inspect4py在PYPI中可用！只需像常規軟件包一樣安裝它：

 pip install inspect4py

你完成了！

然後嘗試更新Python-Dev實用程序： sudo apt-get install python3.X-dev （其中x是您的python版本）

從代碼安裝

準備虛擬Python3環境，CD中的cd到inspect4py文件夾中，並按照以下方式安裝包裹：

 git clone https://github.com/SoftwareUnderstanding/inspect4py
cd inspect4py
pip install -e .

你完成了！

軟件包依賴項：

 docstring_parser==0.7
astor
graphviz
click
pigar
setuptools==54.2.0
json2html
configparser
bigcode_astgen
GitPython
tree-sitter

如果您想運行評估，請不要忘記將pandas添加到上一組中。

通過Docker安裝

您需要安裝Docker。

接下來，克隆inspect4py存儲庫：

 git clone https://github.com/SoftwareUnderstanding/inspect4py/

生成inspect4py的Docker圖像：

 docker build --tag inspect4py:1.0 .

運行inspect4py圖像：

 docker run -it --rm inspect4py:1.0 /bin/bash

現在您可以運行inspect4py ：

 root@e04792563e6a:/# inspect4py --help

有關inspect4py執行選項的更多信息，請參見下面的部分（執行）。

請注意，與Docker一起運行inspect4py時，您需要為目標存儲庫提供一條路徑進行分析。您可以通過：

克隆目標存儲庫。例如：

 docker run -it --rm inspect4py:1.0 /bin/bash
# Docker image starts
root@e04792563e6a:/# git clone https://github.com/repo/id
root@e04792563e6a:/# inspect4py -i id

創建一個音量。例如，用於安裝$ PWD文件夾：

 docker run -it -v -v $PWD:/out --rm inspect4py:1.0 /bin/bash
# Docker image starts
root@e04792563e6a:/# inspect4py -i /out/path/to/repo

使用Docker時的其他有用命令：

 docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-
docker image rm -f inspect4py:1.0

執行

可以執行該工具以檢查文件或給定目錄的所有文件（及其子目錄）。例如，它可用於檢查給定的GitHub存儲庫的所有Python文件（以前已在本地克隆）。

默認情況下，該工具將結果存儲在OutputDir目錄中，但是用戶可以使用-o或--output標誌指定自己的目錄名稱。

 inspect4py --input_path <FILE.py | DIRECTORY> [--output_dir "OutputDir", --ignore_dir_pattern "__", ignore_file_pattern "__" --requirements --html_output]

為了清楚起見，我們添加了一個help命令來解釋每個輸入參數：

 inspect4py --help


Usage: inspect4py [OPTIONS]

Options:
  --version                       Show the version and exit.
  -i, --input_path TEXT           input path of the file or directory to
                                  inspect.  [required]
  -o, --output_dir TEXT           output directory path to store results. If
                                  the directory does not exist, the tool will
                                  create it.
  -ignore_dir, --ignore_dir_pattern TEXT
                                  ignore directories starting with a certain
                                  pattern. This parameter can be provided
                                  multiple times to ignore multiple directory
                                  patterns.
  -ignore_file, --ignore_file_pattern TEXT
                                  ignore files starting with a certain
                                  pattern. This parameter can be provided
                                  multiple times to ignore multiple file
                                  patterns.
  -r, --requirements              find the requirements of the repository.
  -html, --html_output            generates an html file of the DirJson in the
                                  output directory.
  -cl, --call_list                generates the call list in a separate html
                                  file.
  -cf, --control_flow             generates the call graph for each file in a
                                  different directory.
  -dt, --directory_tree           captures the file directory tree from the
                                  root path of the target repository.
  -si, --software_invocation      generates which are the software
                                  invocation commands to run and test the
                                  target repository.
  -ast, -—abstract_syntax_tree    generates abstract syntax tree in json format.
  -sc, --source_code              generates source code of each ast node.
  -ld, --license_detection        detects the license of the target repository.
  -rm, --readme                   extract all readme files in the target repository.
  -md, --metadata                 extract metadata of the target repository using
                                  Github API.
  -df, --data_flow                extract data flow graph for every function, BOOL
  -st, --symbol_table             symbol table file location. STR
  --help                          Show this message and exit.