wala/ML

Decorated functions specifying a PYTHONPATH don't show up in the call graph

Open

#198 opened on Jun 14, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (17 forks)auto 404
PYTHONPATHbugdecoratorshelp wanted

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

Description

Decorated functions that are part of a PYTHONPATH, i.e., it's name is qualified with a directory path, don't show up in the call graph.

For example, suppose we have the following:

https://github.com/ponder-lab/ML/blob/6974735c51fd827cdfef4d7a58fa7442a2a615c4/com.ibm.wala.cast.python.test/data/proj49/src/test_module10.py#L3-L9

Further suppose that the above file is under the src directory. The name of the about function is then Lscript src/test_module10.py/test_dummy. Somehow, when functions have names under directories like src, they are not getting captured in the closure provided by the decorator summary:

https://github.com/wala/ML/blob/b813bde5f9f9a5df87426192aecb8f0b64b1dcc5/com.ibm.wala.cast.python/data/pytest.xml#L6-L35

Contributor guide

Research direction
Investigate how decorated functions with qualified names (e.g., 'Lscript src/test module10.py/test dummy') are handled in the Python frontend of WALA, specifically in the closure generation for decorators. Trace the parsing logic for PYTHONPATH qualified function names and identify where they are dropped from the call graph.
Tech stack
javapython
Domain
backendtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
GitJavaPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25