inspect4py 다운로드 - inspect4py 소스 코드 다운로드

despect4py

심벌 마크

사용자가 소프트웨어 프로젝트 폴더 (예 : 디렉토리 및 하위 디렉토리)를 검사하고 클래스, 메소드 및 매개 변수 문서, 클래스 (및 메소드), 기능 등과 같은 가장 관련성있는 정보를 추출 할 수 있도록 라이브러리.

특징:

코드가있는 폴더가 주어지면 inspect4py 다음과 같습니다.

수입 된 모든 모듈과 각 모듈이 어떻게 가져 오는지 (즉, 내부이든 외부이든)를 추출합니다.
문서, 매개 변수, 허용 값 및 호출 목록을 포함하여 코드의 모든 기능을 추출합니다.
모든 방법과 각각의 문서와 함께 코드의 모든 클래스를 추출하십시오.
각 파일의 제어 흐름을 추출하십시오.
디렉토리 및 파일의 계층 구조를 추출하십시오.
소프트웨어 프로젝트에 사용 된 요구 사항을 추출하십시오.
테스트가 어떤 파일인지 분류하십시오
기본 유형의 소프트웨어 프로젝트 (스크립트, 패키지, 라이브러리 또는 서비스)를 분류하십시오. 하나의 유형 만 기본 유형으로 반환됩니다 (예 : 라이브러리가 서비스로 배포 할 옵션이있는 경우 inspect4py Library 기본 유형으로 반환합니다).
AA 소프트웨어 구성 요소를 실행할 수있는 다양한 방법의 순위를 반환합니다.

모든 메타 데이터는 JSON 파일로 추출됩니다.

inspect4py는 현재 Python 3 프로젝트에 대해서만 작동합니다.

배경:

inspect4py GraphCodebert : Github & Paper에서 영감을 얻은 각 기능에 대한 캡처 데이터 흐름 그래프의 기능을 추가했습니다. 그림은 다음과 같습니다.

소스 코드	출력을 나열하십시오	네트워크 이미지
def max (a, b) : x = 0 A> B : x = a 또 다른: x = b 반환 x	( 'a', 3, 'comesfrom', [], []))) ( 'b', 5, 'comesfrom', [], [])) ( 'x', 8, 'computedfrom', [ '0'], [10]) ( '0', 10, 'comesfrom', [], [])) ( 'a', 12, 'comesfrom', [ 'a'], [3]) ( 'b', 14, 'comesfrom', [ 'b'], [5]) ( 'x', 16, 'computedfrom', [ 'a'], [18]) ( 'A', 18, 'Comefrom', [ 'a'], [3])) ( 'x', 21, 'computedfrom', [ 'b'], [23]))) ( 'b', 23, 'comesfrom', [ 'b'], [5]) ( 'x', 25, 'comesfrom', [ 'x'], [16, 21]))

소스 코드

출력을 나열하십시오

네트워크 이미지

 def max (a, b) :
 x = 0
 A> B :
 x = a
 또 다른:
 x = b
 반환 x

 ( 'a', 3, 'comesfrom', [], [])))
 ( 'b', 5, 'comesfrom', [], []))
 ( 'x', 8, 'computedfrom', [ '0'], [10])
 ( '0', 10, 'comesfrom', [], []))
 ( 'a', 12, 'comesfrom', [ 'a'], [3])
 ( 'b', 14, 'comesfrom', [ 'b'], [5])
 ( 'x', 16, 'computedfrom', [ 'a'], [18])
 ( 'A', 18, 'Comefrom', [ 'a'], [3]))
 ( 'x', 21, 'computedfrom', [ 'b'], [23])))
 ( 'b', 23, 'comesfrom', [ 'b'], [5])
 ( 'x', 25, 'comesfrom', [ 'x'], [16, 21]))

inspect4py AST,보다 구체적으로 Python의 AST 모듈을 사용하여 클래스가 모두 ast.ast에서 상속하는 객체 트리 (파일 당)를 생성합니다.

inspect4py 각 입력 파일을 AST 트리로 구문 분석하여 관련 정보를 추출하고 JSON 파일로 저장합니다. 또한 다른 두 라이브러리를 사용하여 각 입력 파일의 제어 흐름을 캡처합니다.

STATICFG : STATICFG는 Python 3 프로그램을위한 제어 흐름 그래프 (CFG)를 생성하는 데 사용할 수있는 패키지입니다. 그것이 생성하는 CFG는 GraphViz로 쉽게 시각화하고 정적 분석에 사용할 수 있습니다. 코드 (FLAG_PNG)에는 이러한 유형의 제어 흐름 그래프를 생성할지 여부를 표시하는 플래그가 있습니다. 참고 :이 패키지의 원래 코드는 여기에서 찾을 수 있으며 저장소에서 수정되었습니다.

또한 REST, Google 및 NumpyDoc 스타일의 Docstrings를 지원하는 DocString_parser도 사용합니다. 이 라이브러리를 사용하여 수행 된 일부 (기본) 테스트는 여기에서 찾을 수 있습니다.

마지막으로, 우리는 주어진 저장소의 요구 사항을 자동으로 생성하기 위해 Pigar를 재사용합니다. 이것은 선택적 기능입니다. 인수 ( -r )를 활성화하려면 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 상환자가 필요합니다. 추가 정보 :

 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 3.7+에서 inspect4py 테스트했습니다. 권장 버전은 Python 3.9입니다 .

운영 체제

우리는 UNIX, MACOS 및 Windows 11 (22621.1265)에서 inspect4py 테스트했습니다.

PYPI에서 설치

PYPI에서는 inspect4py 사용할 수 있습니다! 일반 패키지처럼 설치하기 만하면됩니다.

 pip install inspect4py

당신은 끝났습니다!

그런 다음 Python-Dev 유틸리티를 업데이트하십시오 : sudo apt-get install python3.X-dev (여기서 X는 Python 버전).

코드에서 설치

가상 Python3 Enviroment를 준비하고, 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.