sv-query 0.3.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cli/__init__.py +5 -0
- cli/_common.py +408 -0
- cli/_entry.py +35 -0
- cli/_evidence_helpers.py +784 -0
- cli/_output.py +51 -0
- cli/_paths.py +36 -0
- cli/_registry.py +1575 -0
- cli/_session_adapter.py +84 -0
- cli/_session_runner.py +57 -0
- cli/core/__init__.py +12 -0
- cli/core/diagnose/__init__.py +11 -0
- cli/core/diagnose/dispatch.py +72 -0
- cli/core/diagnose/imports.py +301 -0
- cli/core/diagnose/report.py +174 -0
- cli/core/diagnose/timescale.py +157 -0
- cli/core/diagnose/widths.py +282 -0
- cli/core/locate/__init__.py +1 -0
- cli/core/locate/capabilities.py +125 -0
- cli/core/locate/filelist_cmd.py +94 -0
- cli/core/locate/graph.py +285 -0
- cli/core/locate/search.py +134 -0
- cli/core/locate/session_cmd.py +65 -0
- cli/core/semantic/__init__.py +4 -0
- cli/core/semantic/_bit_args.py +136 -0
- cli/core/semantic/_bit_hints.py +76 -0
- cli/core/semantic/_common.py +57 -0
- cli/core/semantic/audit.py +97 -0
- cli/core/semantic/classes.py +319 -0
- cli/core/semantic/condition_analysis.py +298 -0
- cli/core/semantic/constraints.py +286 -0
- cli/core/semantic/controlflow.py +289 -0
- cli/core/semantic/covergroups.py +319 -0
- cli/core/semantic/dataflow.py +300 -0
- cli/core/semantic/frontier.py +79 -0
- cli/core/semantic/instances.py +291 -0
- cli/core/semantic/params.py +59 -0
- cli/core/semantic/paths.py +196 -0
- cli/core/semantic/ports.py +63 -0
- cli/core/semantic/scope.py +223 -0
- cli/core/semantic/tb_join.py +112 -0
- cli/core/semantic/trace.py +1327 -0
- cli/core/semantic/trace_common.py +898 -0
- cli/core/semantic/trace_evidence.py +421 -0
- cli/core/semantic/trace_lookup.py +191 -0
- cli/core/semantic/trace_manifest.py +89 -0
- cli/core/semantic/trace_overview.py +320 -0
- cli/core/semantic/trace_profile.py +552 -0
- cli/core/semantic/verify.py +682 -0
- cli/core/state/__init__.py +1 -0
- cli/core/state/diff.py +153 -0
- cli/core/state/snapshot.py +400 -0
- cli/errors.py +128 -0
- cli/main.py +487 -0
- cli/view/__init__.py +1 -0
- cli/view/architecture.py +127 -0
- cli/view/review.py +272 -0
- sv_query/__init__.py +10 -0
- sv_query/errors.py +39 -0
- sv_query/session.py +211 -0
- sv_query/trace/__init__.py +57 -0
- sv_query/trace/_safe.py +215 -0
- sv_query/trace/core/__init__.py +65 -0
- sv_query/trace/core/analysis/__init__.py +13 -0
- sv_query/trace/core/analysis/audit.py +620 -0
- sv_query/trace/core/ast_utils.py +283 -0
- sv_query/trace/core/bit_select_handler.py +504 -0
- sv_query/trace/core/builder/__init__.py +0 -0
- sv_query/trace/core/builder/graph_pipeline.py +159 -0
- sv_query/trace/core/builder/subroutine_expander.py +926 -0
- sv_query/trace/core/cache/__init__.py +3 -0
- sv_query/trace/core/cache/ast_cache.py +547 -0
- sv_query/trace/core/class_graph_builder.py +1729 -0
- sv_query/trace/core/class_hierarchy.py +197 -0
- sv_query/trace/core/compiler.py +767 -0
- sv_query/trace/core/connection_extractor.py +763 -0
- sv_query/trace/core/coverage_models.py +250 -0
- sv_query/trace/core/covergroup_extractor.py +641 -0
- sv_query/trace/core/driver_extractor.py +1428 -0
- sv_query/trace/core/edge_factory.py +82 -0
- sv_query/trace/core/extractor_models.py +37 -0
- sv_query/trace/core/extractors/__init__.py +14 -0
- sv_query/trace/core/extractors/_common.py +962 -0
- sv_query/trace/core/extractors/alias_extractor.py +79 -0
- sv_query/trace/core/extractors/always_extractor.py +915 -0
- sv_query/trace/core/extractors/assign_extractor.py +779 -0
- sv_query/trace/core/extractors/expr_tree_builder.py +159 -0
- sv_query/trace/core/extractors/function_extractor.py +1228 -0
- sv_query/trace/core/extractors/net_decl_extractor.py +244 -0
- sv_query/trace/core/extractors/statement_flattener.py +244 -0
- sv_query/trace/core/extractors/wire_init_extractor.py +103 -0
- sv_query/trace/core/filelist.py +224 -0
- sv_query/trace/core/fsm_analyzer.py +199 -0
- sv_query/trace/core/graph/__init__.py +106 -0
- sv_query/trace/core/graph/analyzer/__init__.py +18 -0
- sv_query/trace/core/graph/analyzer/_dot_common.py +185 -0
- sv_query/trace/core/graph/analyzer/controlflow_analyzer.py +303 -0
- sv_query/trace/core/graph/analyzer/pipeline_viz.py +1210 -0
- sv_query/trace/core/graph/analyzer/signal_classifier.py +411 -0
- sv_query/trace/core/graph/call_graph_models.py +116 -0
- sv_query/trace/core/graph/contracts.py +178 -0
- sv_query/trace/core/graph/controlflow.py +201 -0
- sv_query/trace/core/graph/controlflow_models.py +301 -0
- sv_query/trace/core/graph/covergroup_models.py +93 -0
- sv_query/trace/core/graph/dataflow.py +1146 -0
- sv_query/trace/core/graph/diff.py +400 -0
- sv_query/trace/core/graph/models.py +884 -0
- sv_query/trace/core/graph/search_budget.py +85 -0
- sv_query/trace/core/graph/sva_models.py +125 -0
- sv_query/trace/core/graph/uvm_models.py +156 -0
- sv_query/trace/core/graph/viz/__init__.py +1 -0
- sv_query/trace/core/graph/viz/expression_tree.py +553 -0
- sv_query/trace/core/graph_builder.py +2298 -0
- sv_query/trace/core/module_extractor.py +511 -0
- sv_query/trace/core/module_instance_graph.py +549 -0
- sv_query/trace/core/native_adapter.py +354 -0
- sv_query/trace/core/pipeline.py +103 -0
- sv_query/trace/core/query/__init__.py +39 -0
- sv_query/trace/core/query/architecture.py +274 -0
- sv_query/trace/core/query/clock_domain.py +241 -0
- sv_query/trace/core/query/constraint.py +416 -0
- sv_query/trace/core/query/covergroup.py +267 -0
- sv_query/trace/core/query/frontier.py +181 -0
- sv_query/trace/core/query/load.py +133 -0
- sv_query/trace/core/query/module.py +186 -0
- sv_query/trace/core/query/signal.py +2013 -0
- sv_query/trace/core/query/structural.py +169 -0
- sv_query/trace/core/query/subgraph.py +300 -0
- sv_query/trace/core/query/uvm.py +130 -0
- sv_query/trace/core/semantic/__init__.py +22 -0
- sv_query/trace/core/semantic/_expr_helpers.py +432 -0
- sv_query/trace/core/semantic/_wrappers.py +118 -0
- sv_query/trace/core/semantic/classes.py +254 -0
- sv_query/trace/core/semantic/connections.py +302 -0
- sv_query/trace/core/semantic/exprs_drivers.py +1134 -0
- sv_query/trace/core/semantic/modules.py +604 -0
- sv_query/trace/core/semantic/ports_ifaces.py +442 -0
- sv_query/trace/core/semantic/source_core.py +189 -0
- sv_query/trace/core/semantic_adapter.py +127 -0
- sv_query/trace/core/snapshot_manager.py +325 -0
- sv_query/trace/core/source_assignment.py +176 -0
- sv_query/trace/core/sv_preprocessor.py +293 -0
- sv_query/trace/core/sva_extractor.py +972 -0
- sv_query/trace/core/top_prune.py +131 -0
- sv_query/trace/core/trace_evidence.py +845 -0
- sv_query/trace/py.typed +0 -0
- sv_query/trace/unified_tracer.py +1276 -0
- sv_query-0.3.0.dist-info/METADATA +344 -0
- sv_query-0.3.0.dist-info/RECORD +153 -0
- sv_query-0.3.0.dist-info/WHEEL +5 -0
- sv_query-0.3.0.dist-info/entry_points.txt +2 -0
- sv_query-0.3.0.dist-info/licenses/LICENSE +196 -0
- sv_query-0.3.0.dist-info/licenses/LICENSE_MIT +21 -0
- sv_query-0.3.0.dist-info/top_level.txt +2 -0
cli/__init__.py
ADDED
cli/_common.py
ADDED
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
"""
|
|
2
|
+
CLI 公共 helper
|
|
3
|
+
================
|
|
4
|
+
|
|
5
|
+
集中 tracer 构建 / 错误处理 / 通用参数解析, 供所有 CLI command 复用.
|
|
6
|
+
|
|
7
|
+
设计原则:
|
|
8
|
+
- 一个 _build_tracer() 函数处理 --file / --filelist 两种参数组合
|
|
9
|
+
- 一个 _tracer_from_kwargs() 简化命令内部调用
|
|
10
|
+
- 错误统一走 CompilationError catch, 暴露干净错误信息 (Issue 17/任务3)
|
|
11
|
+
|
|
12
|
+
[ADD 2026-06-11 Issue 18 / Req-9] 所有 --file 命令加 --filelist 支持
|
|
13
|
+
[ADD 2026-06-11 Issue 17] 所有命令 elaboration error 统一处理
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
from __future__ import annotations
|
|
17
|
+
|
|
18
|
+
import logging
|
|
19
|
+
import sys
|
|
20
|
+
from dataclasses import dataclass, field
|
|
21
|
+
from pathlib import Path
|
|
22
|
+
|
|
23
|
+
import typer
|
|
24
|
+
|
|
25
|
+
from sv_query.trace.core.compiler import CompilationError
|
|
26
|
+
from sv_query.trace.core.top_prune import prune_sources
|
|
27
|
+
from sv_query.trace.unified_tracer import UnifiedTracer
|
|
28
|
+
|
|
29
|
+
logger = logging.getLogger(__name__)
|
|
30
|
+
|
|
31
|
+
# ----------------------------------------------------------------------------
|
|
32
|
+
# 1. tracer 构建 (核心 helper, 所有 --file 命令复用)
|
|
33
|
+
# ----------------------------------------------------------------------------
|
|
34
|
+
|
|
35
|
+
def _build_tracer(
|
|
36
|
+
file: Path | None = None,
|
|
37
|
+
filelist: str | None = None,
|
|
38
|
+
log_level: str = "WARNING",
|
|
39
|
+
include_dirs: list | None = None,
|
|
40
|
+
preprocess_macros: bool = True,
|
|
41
|
+
) -> UnifiedTracer:
|
|
42
|
+
"""[ADD 2026-06-11 Req-9] 统一构建 UnifiedTracer, 支持 --file / --filelist
|
|
43
|
+
|
|
44
|
+
Args:
|
|
45
|
+
file: 单个 .sv 源文件路径 (--file / -f)
|
|
46
|
+
filelist: filelist 文件路径 (--filelist), 支持 .f / .fl / .filelist
|
|
47
|
+
log_level: 编译器日志级别, 默认 WARNING (可设 ERROR 静音)
|
|
48
|
+
include_dirs: include 搜索路径列表
|
|
49
|
+
preprocess_macros: True (默认) = 跨文件宏展开 (Req-20);
|
|
50
|
+
False = 信任 pyslang 内置 (退回旧行为)
|
|
51
|
+
|
|
52
|
+
Returns:
|
|
53
|
+
UnifiedTracer 实例 (未 build_graph, 调用方自己调)
|
|
54
|
+
|
|
55
|
+
Raises:
|
|
56
|
+
ValueError: --file 和 --filelist 都没给
|
|
57
|
+
FileNotFoundError: filelist / file 路径不存在
|
|
58
|
+
"""
|
|
59
|
+
# [Bug fix 2026-07-09 CLI-SIGTRAP] Auto-detect: if `file` ends in filelist
|
|
60
|
+
# extension (.f / .fl / .filelist), 用户用 -f flag 传 filelist 时 typer 会
|
|
61
|
+
# 把值塞进 `file` (--file) 而非 filelist, 然后 pyslang 解析 filelist 作为
|
|
62
|
+
# Verilog source 会崩溃 (SIGTRAP / exit 133).
|
|
63
|
+
# Fix: 检测 `file` 后缀, 若是 filelist, 转走 filelist 路径.
|
|
64
|
+
_FILELIST_EXTS = (".f", ".fl", ".filelist")
|
|
65
|
+
_resolved_filelist = filelist
|
|
66
|
+
_resolved_file = file
|
|
67
|
+
if _resolved_file is not None and str(_resolved_file).lower().endswith(_FILELIST_EXTS):
|
|
68
|
+
# promote file to filelist
|
|
69
|
+
_resolved_filelist = str(_resolved_file)
|
|
70
|
+
_resolved_file = None
|
|
71
|
+
|
|
72
|
+
if _resolved_filelist:
|
|
73
|
+
if not Path(_resolved_filelist).exists():
|
|
74
|
+
raise FileNotFoundError(f"Filelist not found: {_resolved_filelist}")
|
|
75
|
+
# [FIX 2026-06-11 Req-9] 手动读 filelist 转 sources, 避免 add_filelist
|
|
76
|
+
# 处理 relative path 失败的 bug. 用 cwd 作为 base_dir
|
|
77
|
+
# (filelist 里 relative path 相对项目根, 符合开发者心智模型)
|
|
78
|
+
# [Bug fix 2026-06-25] auto-detect base_dir from filelist content.
|
|
79
|
+
# CVA6 filelist 用相对路径 'core/include/ariane_pkg.sv', 应相对 cva6 项目根.
|
|
80
|
+
# Heuristic: 用 filelist 中第一个 relative path 的最长公共前缀作为 base_dir.
|
|
81
|
+
filelist_path = Path(_resolved_filelist).resolve()
|
|
82
|
+
base_dir = _detect_filelist_base_dir(filelist_path, fallback=Path.cwd())
|
|
83
|
+
sources, _fl_incdirs = _read_filelist_full(filelist_path, base_dir=base_dir)
|
|
84
|
+
# [iter_207 R4-3] 合并 filelist 的 +incdir+ (过去丢弃 → 同一 filelist 在
|
|
85
|
+
# graph/stats 失败而在 trace 正常)
|
|
86
|
+
_merged = list(include_dirs or [])
|
|
87
|
+
for _d in _fl_incdirs:
|
|
88
|
+
if _d not in _merged:
|
|
89
|
+
_merged.append(_d)
|
|
90
|
+
tracer = UnifiedTracer(
|
|
91
|
+
sources=sources,
|
|
92
|
+
log_level=log_level,
|
|
93
|
+
include_dirs=_merged,
|
|
94
|
+
|
|
95
|
+
preprocess_macros=preprocess_macros, # [Req-20 2026-06-12]
|
|
96
|
+
)
|
|
97
|
+
elif _resolved_file is not None:
|
|
98
|
+
if not _resolved_file.exists():
|
|
99
|
+
raise FileNotFoundError(f"Source file not found: {_resolved_file}")
|
|
100
|
+
with open(str(_resolved_file)) as f:
|
|
101
|
+
source = f.read()
|
|
102
|
+
tracer = UnifiedTracer(
|
|
103
|
+
sources={str(Path(_resolved_file).resolve()): source}, # [iter_206] 与 filelist 路径同形态
|
|
104
|
+
log_level=log_level,
|
|
105
|
+
include_dirs=include_dirs or [],
|
|
106
|
+
|
|
107
|
+
preprocess_macros=preprocess_macros, # [Req-20 2026-06-12]
|
|
108
|
+
)
|
|
109
|
+
else:
|
|
110
|
+
raise ValueError("Either --file or --filelist must be provided")
|
|
111
|
+
return tracer
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
def _build_pruned_tracer(
|
|
115
|
+
filelist: str,
|
|
116
|
+
top: str,
|
|
117
|
+
log_level: str = "ERROR",
|
|
118
|
+
preprocess_macros: bool = True,
|
|
119
|
+
use_cache: bool = True,
|
|
120
|
+
) -> UnifiedTracer:
|
|
121
|
+
"""Build from a pruned filelist; fall back to the full filelist on failure.
|
|
122
|
+
|
|
123
|
+
The first attempt uses top_prune's conservative subset. If elaboration
|
|
124
|
+
raises or reports errors, rebuild from the complete filelist and record the
|
|
125
|
+
fallback on ``tracer._svq_prune_info``. The fallback is never silent: CLI
|
|
126
|
+
output includes it.
|
|
127
|
+
"""
|
|
128
|
+
fl = Path(filelist)
|
|
129
|
+
if not fl.exists():
|
|
130
|
+
raise FileNotFoundError(f"Filelist not found: {filelist}")
|
|
131
|
+
if not top:
|
|
132
|
+
raise ValueError("--prune requires --top")
|
|
133
|
+
sources, incdirs = _read_filelist_full(str(fl), base_dir=fl.parent.resolve())
|
|
134
|
+
pruned = prune_sources(sources, top)
|
|
135
|
+
|
|
136
|
+
def make(selected: list[str]) -> UnifiedTracer:
|
|
137
|
+
return UnifiedTracer(
|
|
138
|
+
sources={p: sources[p] for p in selected},
|
|
139
|
+
log_level=log_level,
|
|
140
|
+
include_dirs=incdirs,
|
|
141
|
+
preprocess_macros=preprocess_macros,
|
|
142
|
+
top_modules=[top],
|
|
143
|
+
)
|
|
144
|
+
|
|
145
|
+
def info(fallback: bool, reason: str = "") -> dict:
|
|
146
|
+
return {
|
|
147
|
+
"enabled": True,
|
|
148
|
+
"top": top,
|
|
149
|
+
"selected_count": len(pruned.selected),
|
|
150
|
+
"total_files": pruned.total,
|
|
151
|
+
"reason": pruned.reason,
|
|
152
|
+
"fallback": fallback,
|
|
153
|
+
"fallback_reason": reason,
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
try:
|
|
157
|
+
tracer = make(pruned.selected)
|
|
158
|
+
tracer.build_graph(use_cache=use_cache)
|
|
159
|
+
errors = tracer.get_elaboration_errors()
|
|
160
|
+
if errors:
|
|
161
|
+
raise CompilationError(
|
|
162
|
+
f"pruned build has {len(errors)} elaboration error(s)"
|
|
163
|
+
)
|
|
164
|
+
tracer._svq_prune_info = info(False)
|
|
165
|
+
return tracer
|
|
166
|
+
except Exception as exc:
|
|
167
|
+
tracer = make(list(sources))
|
|
168
|
+
tracer.build_graph(use_cache=use_cache)
|
|
169
|
+
tracer._svq_prune_info = info(True, str(exc))
|
|
170
|
+
return tracer
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
def _detect_filelist_base_dir(filelist_path: Path, fallback: Path) -> Path:
|
|
174
|
+
"""[Bug fix 2026-06-25] auto-detect filelist 的 base_dir.
|
|
175
|
+
|
|
176
|
+
CVA6 的 filelist 用相对路径 'core/include/ariane_pkg.sv', 应相对 cva6 项目根.
|
|
177
|
+
Heuristic:
|
|
178
|
+
1. 读 filelist 所有 relative path
|
|
179
|
+
2. 找包含最多 files 的 dir (= 项目根)
|
|
180
|
+
3. 用 filelist.parent 当 base_dir (相对路径以 filelist 目录为基点)
|
|
181
|
+
|
|
182
|
+
Args:
|
|
183
|
+
filelist_path: filelist 的绝对路径
|
|
184
|
+
fallback: 如果 heuristic 失败, 用这个
|
|
185
|
+
|
|
186
|
+
Returns:
|
|
187
|
+
best guess base_dir (absolute Path)
|
|
188
|
+
"""
|
|
189
|
+
# [Simple fix 2026-06-25] 用 filelist.parent 当 base_dir.
|
|
190
|
+
# 常见用法: filelist 在 project root (e.g. /Users/me/project/project.f),
|
|
191
|
+
# relative paths 以 project root 为 base. macOS 上 /tmp 是 symlink,
|
|
192
|
+
# 需 resolve() 避免路径不一致.
|
|
193
|
+
return filelist_path.parent.resolve()
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
def _read_filelist_full(filelist_path: str, base_dir: Path) -> tuple[dict[str, str], list[str]]:
|
|
197
|
+
"""[iter_207 R4-3] 读 filelist → (sources, include_dirs)。
|
|
198
|
+
|
|
199
|
+
过去只返回 sources, **`+incdir+` 被丢弃** → `stats` / `visualize *` 走
|
|
200
|
+
`_build_tracer(sources=...)` 时 include 目录丢失: 依赖 `+incdir+` 的
|
|
201
|
+
`` `include `` 失败 → 头文件里的宏不展开 → `UndeclaredIdentifier` 级联;
|
|
202
|
+
而同一 filelist 用 `trace` (走 `SVCompiler.add_filelist`) 却正常 —— 两条路径
|
|
203
|
+
行为不一致。iter_193 的解析器本就有 `spec.include_dirs`, 这里把它交出去。
|
|
204
|
+
"""
|
|
205
|
+
from sv_query.trace.core.filelist import parse_filelist
|
|
206
|
+
|
|
207
|
+
base_dirs = [base_dir]
|
|
208
|
+
if Path.cwd() != Path(base_dir).resolve():
|
|
209
|
+
base_dirs.append(Path.cwd())
|
|
210
|
+
spec = parse_filelist(filelist_path, base_dirs=base_dirs)
|
|
211
|
+
sources: dict[str, str] = {}
|
|
212
|
+
for f in spec.files:
|
|
213
|
+
try:
|
|
214
|
+
sources[f] = Path(f).read_text(encoding="utf-8", errors="replace")
|
|
215
|
+
except OSError as e:
|
|
216
|
+
logger.warning("filelist 条目读取失败, 跳过: %s (%s)", f, e)
|
|
217
|
+
spec.warn_missing(filelist_path)
|
|
218
|
+
if not sources:
|
|
219
|
+
raise CompilationError(
|
|
220
|
+
f"filelist {filelist_path} 没有解析到任何源文件 "
|
|
221
|
+
f"({len(spec.missing)} 个条目缺失/不可解析) — 请检查路径与基准目录",
|
|
222
|
+
error_code="E_FILELIST_INCOMPLETE",
|
|
223
|
+
)
|
|
224
|
+
return sources, list(spec.include_dirs)
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
def _read_filelist(filelist_path: str, base_dir: Path) -> dict[str, str]:
|
|
228
|
+
"""读 filelist → sources dict (兼容 API; 需要 include dirs 用 `_read_filelist_full`)。"""
|
|
229
|
+
sources, _incdirs = _read_filelist_full(filelist_path, base_dir)
|
|
230
|
+
return sources
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
def display_path(file, sources, filelist) -> str:
|
|
234
|
+
"""[iter_206] 统一"被分析文件"的显示路径形态。
|
|
235
|
+
|
|
236
|
+
`--file` 与 `--filelist` 必须显示**同一个**文件路径字符串: filelist 模式用的是
|
|
237
|
+
`parse_filelist` 解析出的 key (已 resolve, macOS `/var` → `/private/var`),
|
|
238
|
+
而 `--file` 模式过去直接显示 CLI 原始参数 → 同一文件两种模式输出不同字符串
|
|
239
|
+
(parity 测试实测: `/var/...` vs `/private/var/...`, 9 个测试因此长期失败)。
|
|
240
|
+
|
|
241
|
+
5+ 处命令 (risk / cdc / sva / ...) 曾各自复制这段逻辑 → 收敛到这里。
|
|
242
|
+
"""
|
|
243
|
+
if file:
|
|
244
|
+
return str(Path(file).resolve())
|
|
245
|
+
if sources:
|
|
246
|
+
return list(sources.keys())[0]
|
|
247
|
+
return filelist or ""
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
def json_requested(argv: list[str] | None = None) -> bool:
|
|
251
|
+
"""命令行是否请求了结构化 JSON 输出 (`--json` / `-j`)。"""
|
|
252
|
+
import sys as _sys
|
|
253
|
+
args = argv if argv is not None else _sys.argv[1:]
|
|
254
|
+
return "--json" in args or "-j" in args
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
def emit_json_error(
|
|
258
|
+
command: str,
|
|
259
|
+
e: BaseException,
|
|
260
|
+
error_code: str | None = None,
|
|
261
|
+
) -> None:
|
|
262
|
+
"""[iter_201 F1] 把错误也变成**结构化 JSON** 打到 stdout (与成功信封对称)。
|
|
263
|
+
|
|
264
|
+
形状: `{"ok": false, "command": ..., "error": {"type", "message"},
|
|
265
|
+
"error_code": ...}` — stderr 仍保留原有的人读文本 (调用方照常输出), 不丢信息。
|
|
266
|
+
|
|
267
|
+
[P183.1/D2] `error_code` 复用 `cli.errors.code_for_exception` 的单一映射;
|
|
268
|
+
调用方仅在需要覆盖映射时显式传入。
|
|
269
|
+
"""
|
|
270
|
+
import json as _json
|
|
271
|
+
|
|
272
|
+
from cli.errors import code_for_exception
|
|
273
|
+
|
|
274
|
+
payload = {
|
|
275
|
+
"ok": False,
|
|
276
|
+
"command": command,
|
|
277
|
+
"error": {"type": type(e).__name__, "message": str(e)},
|
|
278
|
+
"error_code": error_code or code_for_exception(e).value,
|
|
279
|
+
}
|
|
280
|
+
print(_json.dumps(payload, ensure_ascii=False, indent=2))
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
def warn_flags_ignored_by_json(json_output: bool, flags: dict[str, object]) -> None:
|
|
284
|
+
"""[iter_201 F2/F3] `--json` 模式下被忽略的输出/模式 flag 必须**显式告警**。
|
|
285
|
+
|
|
286
|
+
过去静默丢弃 (实测 `--json --svg X` → SVG 未生成且无提示), 与项目
|
|
287
|
+
"不静默" 原则冲突。
|
|
288
|
+
"""
|
|
289
|
+
if not json_output:
|
|
290
|
+
return
|
|
291
|
+
ignored = [name for name, value in flags.items() if value not in (None, False, "", 0)]
|
|
292
|
+
if ignored:
|
|
293
|
+
print(
|
|
294
|
+
"⚠️ --json 已启用: 以下输出/模式选项被忽略 (不产出对应产物): "
|
|
295
|
+
+ ", ".join(ignored),
|
|
296
|
+
file=sys.stderr,
|
|
297
|
+
)
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
@dataclass
|
|
301
|
+
class ElaborationDiagnostics:
|
|
302
|
+
"""[iter_225] fix 类命令的编译诊断结果 (恒定严格下的显式契约).
|
|
303
|
+
|
|
304
|
+
Attributes:
|
|
305
|
+
tracer: 已构建的 UnifiedTracer (语法树仍可读)
|
|
306
|
+
errors: 结构化诊断列表 [{"file", "line", "column", "code", "message"}, ...]
|
|
307
|
+
compile_failed: 编译是否因 elaboration error 抛错
|
|
308
|
+
failure: 抛错时的异常文本 (供 compile_failed 且无诊断时上报)
|
|
309
|
+
"""
|
|
310
|
+
tracer: UnifiedTracer
|
|
311
|
+
errors: list[dict] = field(default_factory=list)
|
|
312
|
+
compile_failed: bool = False
|
|
313
|
+
failure: str = ""
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
def collect_elaboration_diagnostics(
|
|
317
|
+
file: Path | None = None,
|
|
318
|
+
filelist: str | None = None,
|
|
319
|
+
log_level: str = "ERROR",
|
|
320
|
+
) -> ElaborationDiagnostics:
|
|
321
|
+
"""[iter_225] fix 类命令专用: "编译失败" 是预期输入, 不是异常.
|
|
322
|
+
|
|
323
|
+
恒定严格 (iter_224) 下, 输入本身就带 elaboration 错的项目必然让
|
|
324
|
+
``build_graph()`` 抛 CompilationError —— 而 ``fix report`` / ``fix imports``
|
|
325
|
+
/ ``fix timescale`` / ``fix widths`` 的职责**正是**报告/修复这些错误。
|
|
326
|
+
|
|
327
|
+
因此这里显式声明契约 (不是 silent fallback):
|
|
328
|
+
- 只捕获 ``CompilationError`` (其它异常照常抛出)
|
|
329
|
+
- 编译失败后读取编译器已收集的**结构化诊断** (``get_elaboration_errors()``),
|
|
330
|
+
不解析报错文本, 也不把 partial AST 当作"成功"返回给上层
|
|
331
|
+
- 若一个诊断都拿不到 → 重新抛出 (拿不到失败原因 = 真异常, 不能吞)
|
|
332
|
+
|
|
333
|
+
Returns:
|
|
334
|
+
ElaborationDiagnostics
|
|
335
|
+
"""
|
|
336
|
+
tracer = _build_tracer(file=file, filelist=filelist, log_level=log_level)
|
|
337
|
+
try:
|
|
338
|
+
tracer.build_graph()
|
|
339
|
+
except CompilationError as e:
|
|
340
|
+
errors = tracer.get_elaboration_errors()
|
|
341
|
+
if not errors:
|
|
342
|
+
raise
|
|
343
|
+
logger.debug("%s: 编译失败 (预期: fix 命令就是来诊断它的): %s", __name__, e)
|
|
344
|
+
return ElaborationDiagnostics(
|
|
345
|
+
tracer=tracer, errors=errors, compile_failed=True, failure=str(e),
|
|
346
|
+
)
|
|
347
|
+
return ElaborationDiagnostics(tracer=tracer, errors=tracer.get_elaboration_errors())
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
def handle_compilation_error(e: CompilationError, ) -> None:
|
|
351
|
+
"""[ADD 2026-06-11 任务3] 统一处理 CompilationError, 不暴露 Python traceback
|
|
352
|
+
|
|
353
|
+
[ADD 2026-06-12 Req-15 后续] 加 hint: 提示用户先修 filelist (正解).
|
|
354
|
+
[iter_224] strict 已彻底移除 — 工具恒定严格, 不再有 bypass 逃生舱;
|
|
355
|
+
hint 只指向根因 (fixture / src / filelist)。
|
|
356
|
+
|
|
357
|
+
Args:
|
|
358
|
+
e: 抛出的 CompilationError
|
|
359
|
+
"""
|
|
360
|
+
msg = str(e)
|
|
361
|
+
# CompilationError 格式: "Elaboration errors:\n<report>"
|
|
362
|
+
# 提取前几行作为简短错误信息
|
|
363
|
+
lines = msg.split("\n")
|
|
364
|
+
header = lines[0] if lines else "Compilation failed"
|
|
365
|
+
print(f"Error: {header}", file=sys.stderr)
|
|
366
|
+
# 简洁输出前 10 行, 不暴露 Python stack
|
|
367
|
+
detail_lines = [line for line in lines[1:] if line.strip()][:10]
|
|
368
|
+
if detail_lines:
|
|
369
|
+
print("\n".join(detail_lines), file=sys.stderr)
|
|
370
|
+
if len(lines) > 11:
|
|
371
|
+
print(f" ... ({len(lines) - 11} more lines, see logs)", file=sys.stderr)
|
|
372
|
+
# [iter_209] 输入类型错误 (例如把 filelist 当源码传) 不该再建议 --no-strict:
|
|
373
|
+
# 那是"RTL 不完整"场景的提示, 对"传错文件类型"是误导 (实测用户看到
|
|
374
|
+
# "看起来是 filelist" 之后又被建议 --no-strict, 自相矛盾)。
|
|
375
|
+
_is_input_type_error = "请用 --filelist" in msg
|
|
376
|
+
if not _is_input_type_error:
|
|
377
|
+
# 推荐先检查 filelist (错误代码在上面的 [ERROR] 行里, user 可以自己看)
|
|
378
|
+
print(
|
|
379
|
+
"\nHint: First check your filelist is complete (missing modules? missing includes?).",
|
|
380
|
+
file=sys.stderr,
|
|
381
|
+
)
|
|
382
|
+
print(
|
|
383
|
+
" Fix the root cause (fixture / src / filelist) instead of bypassing the check.",
|
|
384
|
+
file=sys.stderr,
|
|
385
|
+
)
|
|
386
|
+
raise typer.Exit(code=1) from None
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
# ----------------------------------------------------------------------------
|
|
390
|
+
# 3. 通用 --filelist 参数 (typer.Option 复用)
|
|
391
|
+
# ----------------------------------------------------------------------------
|
|
392
|
+
|
|
393
|
+
# 给所有命令 import 这两个 typer.Option, 保持参数风格一致
|
|
394
|
+
FILE_OPTION = typer.Option(
|
|
395
|
+
None, "--file", "-f", help="SystemVerilog source file (单文件模式)"
|
|
396
|
+
)
|
|
397
|
+
FILELIST_OPTION = typer.Option(
|
|
398
|
+
None, "--filelist", help="Path to filelist (.f/.fl) for multi-file projects (项目模式)"
|
|
399
|
+
)
|
|
400
|
+
LOG_LEVEL_OPTION = typer.Option(
|
|
401
|
+
"WARNING", "--log-level", help="编译器日志级别 (DEBUG/INFO/WARNING/ERROR)"
|
|
402
|
+
)
|
|
403
|
+
PREPROCESS_OPTION = typer.Option(
|
|
404
|
+
True,
|
|
405
|
+
"--preprocess/--no-preprocess",
|
|
406
|
+
help="Preprocess macros (default): 跨文件 `MACRO 展开, 避免 TooFewArguments. "
|
|
407
|
+
"Use --no-preprocess 退回 pyslang 内置处理 (供不跨文件 define 的小项目用)",
|
|
408
|
+
)
|
cli/_entry.py
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ruff: noqa: E402
|
|
2
|
+
"""Console script entry point for the `sv_query` command (P165.2).
|
|
3
|
+
|
|
4
|
+
Packaging layout:
|
|
5
|
+
- `cli` is a top-level package (console entry `cli._entry:main`);
|
|
6
|
+
- the query engine is `sv_query.trace`;
|
|
7
|
+
- `src/` is still inserted on sys.path for legacy development imports
|
|
8
|
+
(`from src.cli...`) and for editable checkouts.
|
|
9
|
+
|
|
10
|
+
The old top-level `trace` package was removed because it collided with
|
|
11
|
+
Python's stdlib `trace` module.
|
|
12
|
+
"""
|
|
13
|
+
import sys
|
|
14
|
+
from pathlib import Path
|
|
15
|
+
|
|
16
|
+
# P165.2: keep src/ on sys.path for editable checkouts and legacy src.cli
|
|
17
|
+
# imports. The installed query engine itself is top-level sv_query.trace.
|
|
18
|
+
from cli._paths import SRC_DIR as _SRC_DIR # [iter_232] 路径锚点单一真相源
|
|
19
|
+
|
|
20
|
+
# 总是 insert (不 guard): 确保 editable checkout 的 src/ 优先解析.
|
|
21
|
+
sys.path.insert(0, str(_SRC_DIR))
|
|
22
|
+
|
|
23
|
+
from .main import app, run # noqa: F401 (run = 统一入口, app 供兼容导入)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def main():
|
|
27
|
+
"""Console entry point for `sv_query` script (after `pip install -e .`).
|
|
28
|
+
|
|
29
|
+
`sv_query --help` lists the current command surface; use
|
|
30
|
+
`sv_query capabilities --json` for the authoritative 39 core + 6 exp set.
|
|
31
|
+
|
|
32
|
+
[iter_191] 实际执行 `main.run()` — 统一把输入类错误格式化成一行提示 (rc=1),
|
|
33
|
+
不再向用户抛原始 traceback。
|
|
34
|
+
"""
|
|
35
|
+
run()
|