72353f3773
背景:现场读代码的人只读中文。此前代码里的 docstring 是英文、行内注释是中文,
一半英文一半中文反而更难看懂 —— 新手打开一个 .py 不知道这个模块为什么存在。
范围(本仓库自己的代码,厂商上游不动)
src/arm_application/** 37 个文件:servo_node / perception_node / handeye_* / dh_pgea /
yolo_detector / kalman_filter / goto_ee_plane / dual_gripper …
src/arm_interfaces/** 11 个文件:paths / manifest / loader / config_guard / errors …
src/arm_control/** 5 个文件
src/arm_bringup/** 3 个 launch
scripts/** 6 个 .py + 29 个 .sh(scripts/ 是"唯一操作入口",用户屏幕上
看到的就是这些提示,所以提示信息也一并中文化)
config/ handeye/ devices/ src/arm_*/config/ 17 个 .yaml/.xml/.xacro/.cfg
口径(写进 docs/FRAMEWORK_RULES.md 新增的 R6.5,作为长期约束)
注释、docstring、print/日志/异常里给人看的句子 = 中文;
标识符、API 名、话题名、参数名、字段名、命令名 = 保留英文原文(用 `` `` 包起来);
单位、十六进制、协议报文、CRC 值、命令示例 = 原样保留;
src/flexiv_*/ = 厂商上游代码,不许改也不许翻译(R4.4)。
翻译保原意与原有详细程度:那些"为什么不能用另一种做法""踩过什么坑"的说明
全部完整保留 —— 它们才是这份代码里最贵的部分。
新增 scripts/check_text_only.py:只改文字时的自证工具
人工 review 靠不住(115 个文件、3000 多行 diff)。这个脚本把改动前后的源码解析成
语法树,删掉 docstring、抹平字符串常量、把 f-string 只留"插值了几次 + 插值是什么",
再比对:完全相同 = 改动范围内没有逻辑变化。
留了一个口子:f-string 的插值按内容排序后再比 —— 因为中文语序常常要和英文反着来
(f"on {port} read {idx} failed" → f"在 {port} 上读 {idx} 失败"),只换显示顺序不该判失败;
但多插一个、少插一个、换掉被插入的表达式,立刻会报出来。
本次 66 个 .py 全部通过该闸门。
验收
改动的 66 个 .py:scripts/check_text_only.py 全部通过(零逻辑变化)
45 个非 .py 文件:去注释后与 HEAD 逐字节相同(零配置变化)
docstring 总数:没有一个文件减少(不存在"翻译时顺手删了说明")
单测:arm_application 233 / arm_driver_flexiv 69 / arm_interfaces 46 /
arm_kinematics 24 / arm_sim_gazebo 236 = 608 passed,与改动前一致
全部 .sh:bash -n 通过;并额外实际执行了 --help 验证(见下一个提交:
bash -n 对 CRLF 脚本会漏报,只有真跑才暴露)
Co-authored-by: Cursor <cursoragent@cursor.com>
144 lines
4.3 KiB
Python
Executable File
144 lines
4.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""Merge taught joint lines into handeye waypoints YAML.
|
|
|
|
Input (from handeye_teach / handeye_waypoints append file):
|
|
# pose 0
|
|
0.123456, -0.700000, ...
|
|
|
|
Target can be either:
|
|
- handeye/poses/<臂号>_<模式>.yaml (/** ros__parameters)
|
|
- handeye/calibrate.yaml (handeye_calibrate: ros__parameters)
|
|
|
|
Usage:
|
|
python3 scripts/merge_handeye_poses.py \\
|
|
~/ros2/handeye/tmp/89/taught_poses.txt \\
|
|
~/ros2/handeye/poses/89_eye_in_hand.yaml
|
|
|
|
# or via wrapper:
|
|
bash ~/ros2/scripts/run_handeye.sh merge
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
|
|
def parse_poses(path: Path) -> list[list[float]]:
|
|
lines = path.read_text(encoding="utf-8").splitlines()
|
|
poses: list[list[float]] = []
|
|
buf: list[float] = []
|
|
|
|
num_re = re.compile(r"[-+]?(?:\d+\.\d*|\.\d+|\d+)(?:[eE][-+]?\d+)?")
|
|
|
|
for raw in lines:
|
|
line = raw.split("#", 1)[0].strip()
|
|
if not line:
|
|
if buf:
|
|
if len(buf) != 7:
|
|
raise ValueError(f"Expected 7 joints, got {len(buf)}: {buf}")
|
|
poses.append(buf)
|
|
buf = []
|
|
continue
|
|
vals = [float(x) for x in num_re.findall(line)]
|
|
if not vals:
|
|
continue
|
|
if len(vals) == 7:
|
|
poses.append(vals)
|
|
elif len(vals) < 7:
|
|
buf.extend(vals)
|
|
if len(buf) > 7:
|
|
raise ValueError(f"Too many joint values in line: {line!r}")
|
|
else:
|
|
poses.append(vals[:7])
|
|
|
|
if buf:
|
|
if len(buf) != 7:
|
|
raise ValueError(f"Expected 7 joints at EOF, got {len(buf)}")
|
|
poses.append(buf)
|
|
|
|
return poses
|
|
|
|
|
|
def format_positions_block(poses: list[list[float]], indent: str = " ") -> str:
|
|
rows = [f"{indent}waypoint_positions: ["]
|
|
for i, q in enumerate(poses):
|
|
rows.append(f"{indent} # pose {i}")
|
|
s = ", ".join(f"{v:.6f}" for v in q) + ","
|
|
rows.append(f"{indent} {s}")
|
|
rows.append(f"{indent}]")
|
|
return "\n".join(rows)
|
|
|
|
|
|
def merge(yaml_path: Path, poses: list[list[float]]) -> None:
|
|
text = yaml_path.read_text(encoding="utf-8").replace("\r\n", "\n").replace("\r", "\n")
|
|
# 探测 waypoint_positions 的缩进(通常 2 空格或 4 空格)
|
|
m_ind = re.search(r"^([ \t]*)waypoint_positions:\s*\[", text, re.MULTILINE)
|
|
indent = m_ind.group(1) if m_ind else " "
|
|
block = format_positions_block(poses, indent=indent)
|
|
|
|
pattern = re.compile(
|
|
rf"{re.escape(indent)}waypoint_positions:\s*\[[\s\S]*?{re.escape(indent)}\]",
|
|
re.MULTILINE,
|
|
)
|
|
# 也要匹配"单行空列表"的写法:waypoint_positions: []
|
|
one_line = re.compile(
|
|
rf"{re.escape(indent)}waypoint_positions:\s*\[\s*\]",
|
|
re.MULTILINE,
|
|
)
|
|
if pattern.search(text):
|
|
new_text = pattern.sub(block, text, count=1)
|
|
elif one_line.search(text):
|
|
new_text = one_line.sub(block, text, count=1)
|
|
else:
|
|
raise RuntimeError("waypoint_positions block not found in YAML")
|
|
|
|
# 顺手把 num_poses 同步成实际点数(如果原本就有这个键)
|
|
n = len(poses)
|
|
if re.search(r"^\s*num_poses:\s*\d+", new_text, re.MULTILINE):
|
|
new_text = re.sub(
|
|
r"^(\s*num_poses:\s*)\d+",
|
|
rf"\g<1>{n}",
|
|
new_text,
|
|
count=1,
|
|
flags=re.MULTILINE,
|
|
)
|
|
else:
|
|
# 原本没有 num_poses,就插在 waypoint_positions 前面
|
|
new_text = new_text.replace(
|
|
block,
|
|
f"{indent}num_poses: {n}\n{block}",
|
|
1,
|
|
)
|
|
|
|
yaml_path.write_text(new_text, encoding="utf-8")
|
|
|
|
|
|
def main(argv: list[str]) -> int:
|
|
if len(argv) != 3:
|
|
print(
|
|
"Usage: merge_handeye_poses.py <taught_poses.txt> <waypoints.yaml>",
|
|
file=sys.stderr,
|
|
)
|
|
return 1
|
|
src = Path(argv[1]).expanduser()
|
|
dst = Path(argv[2]).expanduser()
|
|
if not src.is_file():
|
|
print(f"Not found: {src}", file=sys.stderr)
|
|
return 2
|
|
if not dst.is_file():
|
|
print(f"Not found: {dst}", file=sys.stderr)
|
|
return 3
|
|
poses = parse_poses(src)
|
|
if len(poses) < 5:
|
|
print(f"Need >=5 poses, got {len(poses)}", file=sys.stderr)
|
|
return 4
|
|
merge(dst, poses)
|
|
print(f"Merged {len(poses)} poses -> {dst}")
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
raise SystemExit(main(sys.argv))
|