inspect4py: a knowledge extraction framework for Python code repositories

Rosa Filgueira; Daniel Garijo

doi:10.1145/3524842.3528497

inspect4py: a knowledge extraction framework for Python code repositories

Rosa Filgueira, Daniel Garijo

School of Computer Science

Research output: Chapter in Book/Report/Conference proceeding › Conference contribution

3 Citations (Scopus)

35 Downloads (Pure)

Abstract

This work presents inspect4py, a static code analysis framework designed to automatically extract the main features, metadata and documentation of Python code repositories. Given an input folder with code, inspect4py uses abstract syntax trees and state of the art tools to find all functions, classes, tests, documentation, call graphs, module dependencies and control flows within all code files in that repository. Using these findings, inspect4py infers different ways of invoking a software component. We have evaluated our framework on 95 annotated repositories, obtaining promising results for software type classification (over 95% F1-score). With inspect4py, we aim to ease the understandability and adoption of software repositories by other researchers and developers.

Original language	English
Title of host publication	Proceedings of the 19th International Conference on Mining Software Repositories (MSR 2022)
Editors	David Lo, Shane McIntosh, Nicole Novielli
Place of Publication	New York, NY
Publisher	ACM
Pages	232-236
Number of pages	5
ISBN (Electronic)	9781450393034
DOIs	https://doi.org/10.1145/3524842.3528497
Publication status	Published - 17 Oct 2022
Event	2022 Mining Software Repositories Conference (MSR 2022) - Virtual and In-Person, Pittsburgh, United States Duration: 23 May 2022 → 24 May 2022 Conference number: 5 https://conf.researchr.org/home/msr-2022

Conference

Conference	2022 Mining Software Repositories Conference (MSR 2022)
Abbreviated title	MSR 2022
Country/Territory	United States
City	Pittsburgh
Period	23/05/22 → 24/05/22
Internet address	https://conf.researchr.org/home/msr-2022

Keywords

Code mining
Software code
Software classification
Software documentation
Code understanding

Access to Document

10.1145/3524842.3528497

Code_inspector_4_pages_MSR_2022
Copyright © 2022 Association of Computing Machinery. This work has been made available online in accordance with publisher policies or with permission. Permission for further reuse of this content should be sought from the publisher or the rights holder. This is the author created accepted manuscript following peer review and may differ slightly from the final published version. The final published version of this work is available at https://dl.acm.org/.
Accepted author manuscript, 543 KB

Cite this

@inproceedings{27de83b5f2cb4db6aec705597b768267,

title = "inspect4py: a knowledge extraction framework for Python code repositories",

abstract = "This work presents inspect4py, a static code analysis framework designed to automatically extract the main features, metadata and documentation of Python code repositories. Given an input folder with code, inspect4py uses abstract syntax trees and state of the art tools to find all functions, classes, tests, documentation, call graphs, module dependencies and control flows within all code files in that repository. Using these findings, inspect4py infers different ways of invoking a software component. We have evaluated our framework on 95 annotated repositories, obtaining promising results for software type classification (over 95% F1-score). With inspect4py, we aim to ease the understandability and adoption of software repositories by other researchers and developers.",

keywords = "Code mining, Software code, Software classification, Software documentation, Code understanding",

author = "Rosa Filgueira and Daniel Garijo",

year = "2022",

month = oct,

day = "17",

doi = "10.1145/3524842.3528497",

language = "English",

pages = "232--236",

editor = "David Lo and Shane McIntosh and Nicole Novielli",

booktitle = "Proceedings of the 19th International Conference on Mining Software Repositories (MSR 2022)",

publisher = "ACM",

address = "United States",

note = "2022 Mining Software Repositories Conference (MSR 2022), MSR 2022 ; Conference date: 23-05-2022 Through 24-05-2022",

url = "https://conf.researchr.org/home/msr-2022",

}

Filgueira, R & Garijo, D 2022, inspect4py: a knowledge extraction framework for Python code repositories. in D Lo, S McIntosh & N Novielli (eds), Proceedings of the 19th International Conference on Mining Software Repositories (MSR 2022). ACM, New York, NY, pp. 232-236, 2022 Mining Software Repositories Conference (MSR 2022), Pittsburgh, Pennsylvania, United States, 23/05/22. https://doi.org/10.1145/3524842.3528497

inspect4py: a knowledge extraction framework for Python code repositories. / Filgueira, Rosa; Garijo, Daniel.
Proceedings of the 19th International Conference on Mining Software Repositories (MSR 2022). ed. / David Lo; Shane McIntosh; Nicole Novielli. New York, NY: ACM, 2022. p. 232-236.

Research output: Chapter in Book/Report/Conference proceeding › Conference contribution

TY - GEN

T1 - inspect4py

T2 - 2022 Mining Software Repositories Conference (MSR 2022)

AU - Filgueira, Rosa

AU - Garijo, Daniel

N1 - Conference code: 5

PY - 2022/10/17

Y1 - 2022/10/17

N2 - This work presents inspect4py, a static code analysis framework designed to automatically extract the main features, metadata and documentation of Python code repositories. Given an input folder with code, inspect4py uses abstract syntax trees and state of the art tools to find all functions, classes, tests, documentation, call graphs, module dependencies and control flows within all code files in that repository. Using these findings, inspect4py infers different ways of invoking a software component. We have evaluated our framework on 95 annotated repositories, obtaining promising results for software type classification (over 95% F1-score). With inspect4py, we aim to ease the understandability and adoption of software repositories by other researchers and developers.

AB - This work presents inspect4py, a static code analysis framework designed to automatically extract the main features, metadata and documentation of Python code repositories. Given an input folder with code, inspect4py uses abstract syntax trees and state of the art tools to find all functions, classes, tests, documentation, call graphs, module dependencies and control flows within all code files in that repository. Using these findings, inspect4py infers different ways of invoking a software component. We have evaluated our framework on 95 annotated repositories, obtaining promising results for software type classification (over 95% F1-score). With inspect4py, we aim to ease the understandability and adoption of software repositories by other researchers and developers.

KW - Code mining

KW - Software code

KW - Software classification

KW - Software documentation

KW - Code understanding

UR - https://doi.org/10.1145/3524842

UR - https://github.com/SoftwareUnderstanding/inspect4py

UR - https://doi.org/10.5281/zenodo.5907936

UR - https://conf.researchr.org/details/msr-2022/msr-2022-data-showcase/25/Inspect4py-A-Knowledge-Extraction-Framework-for-Python-Code-Repositories

U2 - 10.1145/3524842.3528497

DO - 10.1145/3524842.3528497

M3 - Conference contribution

SP - 232

EP - 236

BT - Proceedings of the 19th International Conference on Mining Software Repositories (MSR 2022)

A2 - Lo, David

A2 - McIntosh, Shane

A2 - Novielli, Nicole

PB - ACM

CY - New York, NY

Y2 - 23 May 2022 through 24 May 2022

ER -

inspect4py: a knowledge extraction framework for Python code repositories

Abstract

Conference

Keywords

Access to Document

Other files and links

Fingerprint

SoftwareUnderstanding/inspect4py: Inspect4py 0.0.1: First release

Cite this

inspect4py: a knowledge extraction framework for Python code repositories

Abstract

Conference

Keywords

Access to Document

Other files and links

Fingerprint

Datasets

SoftwareUnderstanding/inspect4py: Inspect4py 0.0.1: First release

Cite this