forked from CodeGraphContext/CodeGraphContext
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvisualizer.py
More file actions
189 lines (159 loc) · 5.34 KB
/
Copy pathvisualizer.py
File metadata and controls
189 lines (159 loc) · 5.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# src/codegraphcontext/cli/visualizer.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Optional
from .cli_helpers import visualize_helper
def resolve_visual_flag(ctx: Any, visual: bool) -> bool:
"""True when local or global --visual / -V was requested."""
if visual:
return True
obj = getattr(ctx, "obj", None) if ctx is not None else None
return bool(isinstance(obj, dict) and obj.get("visual"))
def check_visual_flag(ctx: Any, visual: bool) -> bool:
"""Return whether visualization was requested (does not launch UI)."""
return resolve_visual_flag(ctx, visual)
ALLOWED_GRAPH_LABELS = frozenset({
"Class", "DbTable", "Directory", "Enum", "EnumMember", "ExternalClass",
"ExternalFunction", "Extension", "File", "Function", "Interface", "Macro",
"Mixin", "Module", "Object", "Parameter", "Repository", "Struct", "Trait",
"Union", "Variable",
})
def _escape_cypher_string(value: str) -> str:
return value.replace("\\", "\\\\").replace("'", "\\'")
def _validate_graph_label(label: str) -> str:
normalized = label.strip()
if not normalized or not normalized.replace("_", "").isalnum():
raise ValueError(f"Invalid node label: {label!r}")
for allowed in ALLOWED_GRAPH_LABELS:
if allowed.lower() == normalized.lower():
return allowed
raise ValueError(
f"Unsupported node label {label!r}. "
f"Allowed labels: {', '.join(sorted(ALLOWED_GRAPH_LABELS))}"
)
def _file_props(name: str, file: Optional[str]) -> str:
fn = _escape_cypher_string(name)
if file:
path = _escape_cypher_string(str(Path(file).resolve()))
return f"{{name: '{fn}', path: '{path}'}}"
return f"{{name: '{fn}'}}"
def _launch_visualizer(
cypher_query: str,
*,
repo_path: Optional[str] = None,
context: Optional[str] = None,
) -> None:
visualize_helper(
repo_path=repo_path,
port=8000,
context=context,
cypher_query=cypher_query,
)
def visualize_search_results(
_results: Any,
name: str,
search_type: str = "name",
**_: Any,
) -> None:
term = _escape_cypher_string(name)
if search_type == "pattern":
query = (
f"MATCH (n) WHERE n.name CONTAINS '{term}' "
f"RETURN n AS n, null AS rel, null AS m LIMIT 80"
)
elif search_type == "type":
try:
label = _validate_graph_label(name)
except ValueError as exc:
raise ValueError(str(exc)) from exc
query = (
f"MATCH (n:{label}) "
f"RETURN n AS n, null AS rel, null AS m LIMIT 80"
)
else:
query = (
f"MATCH (n) WHERE n.name = '{term}' "
f"RETURN n AS n, null AS rel, null AS m LIMIT 80"
)
_launch_visualizer(query)
def visualize_call_graph(
_results: Any,
function: str,
direction: str = "outgoing",
file: Optional[str] = None,
**_: Any,
) -> None:
props = _file_props(function, file)
if direction == "incoming":
query = (
f"MATCH (caller)-[rel:CALLS]->(target:Function {props}) "
f"RETURN caller AS n, rel AS rel, target AS m LIMIT 120"
)
else:
query = (
f"MATCH (caller:Function {props})-[rel:CALLS]->(called) "
f"RETURN caller AS n, rel AS rel, called AS m LIMIT 120"
)
_launch_visualizer(query)
def visualize_call_chain(
_results: Any,
from_func: str,
to_func: str,
max_depth: int = 5,
from_file: Optional[str] = None,
to_file: Optional[str] = None,
**_: Any,
) -> None:
start = _file_props(from_func, from_file)
end = _file_props(to_func, to_file)
depth = max(1, min(int(max_depth), 15))
query = (
f"MATCH (start:Function {start}), (end:Function {end}) "
f"MATCH p = (start)-[:CALLS*1..{depth}]->(end) "
f"WITH nodes(p) AS ns, relationships(p) AS rs "
f"UNWIND range(0, size(rs) - 1) AS i "
f"RETURN ns[i] AS n, rs[i] AS rel, ns[i + 1] AS m "
f"LIMIT 200"
)
_launch_visualizer(query)
def visualize_dependencies(
_results: Any,
target: str,
**_: Any,
) -> None:
term = _escape_cypher_string(target)
query = (
f"MATCH (f:File)-[rel:IMPORTS]->(m:Module) "
f"WHERE m.name CONTAINS '{term}' OR m.full_import_name CONTAINS '{term}' "
f"RETURN f AS n, rel AS rel, m AS m LIMIT 120"
)
_launch_visualizer(query)
def visualize_inheritance_tree(
_results: Any,
class_name: str,
file: Optional[str] = None,
**_: Any,
) -> None:
props = _file_props(class_name, file)
query = (
f"MATCH (c:Class {props})-[rel:INHERITS]->(parent:Class) "
f"RETURN c AS n, rel AS rel, parent AS m "
f"UNION "
f"MATCH (child:Class)-[rel:INHERITS]->(c:Class {props}) "
f"RETURN child AS n, rel AS rel, c AS m "
f"LIMIT 120"
)
_launch_visualizer(query)
def visualize_overrides(
_results: Any,
function_name: str,
**_: Any,
) -> None:
fn = _escape_cypher_string(function_name)
query = (
f"MATCH (class:Class)-[rel:CONTAINS]->(func:Function {{name: '{fn}'}}) "
f"RETURN class AS n, rel AS rel, func AS m LIMIT 120"
)
_launch_visualizer(query)
def visualize_cypher_results(cypher_query: str, **_: Any) -> None:
_launch_visualizer(cypher_query)