增加监控导出说明文档参数audit

tests/test_readme_flag_audit.py

@@ -0,0 +1,29 @@
+import sys
+import tempfile
+import unittest
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "tools"))
+
+from readme_flag_audit import build
+
+
+class ReadmeFlagAuditTest(unittest.TestCase):
+    def test_detects_missing_readme_flags(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            root = Path(tmpdir)
+            package = root / "mx_exporter"
+            package.mkdir()
+            (package / "__init__.py").write_text(
+                'parser.add_argument("-p", "--port")\nparser.add_argument("-i", "--interval")\n',
+                encoding="utf-8",
+            )
+            (root / "README.md").write_text("python3 -m mx_exporter -p 8000\n", encoding="utf-8")
+
+            report = build(root)
+
+        self.assertIn("--interval", report["flags_missing_from_readme"])
+
+
+if __name__ == "__main__":
+    unittest.main()

tools/readme_flag_audit.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+"""Compare CLI flags with README examples and parameter notes."""
+
+from __future__ import annotations
+
+import argparse
+import ast
+import json
+import re
+from pathlib import Path
+
+
+FLAG_RE = re.compile(r"-{1,2}[A-Za-z0-9-]+")
+
+
+def cli_flags(init_path: Path) -> set[str]:
+    module = ast.parse(init_path.read_text(encoding="utf-8"), filename=str(init_path))
+    flags = set()
+    for node in ast.walk(module):
+        if not isinstance(node, ast.Call):
+            continue
+        if not isinstance(node.func, ast.Attribute) or node.func.attr != "add_argument":
+            continue
+        for argument in node.args:
+            if isinstance(argument, ast.Constant) and isinstance(argument.value, str):
+                flags.add(argument.value)
+    return flags
+
+
+def readme_flags(readme_path: Path) -> set[str]:
+    return set(FLAG_RE.findall(readme_path.read_text(encoding="utf-8")))
+
+
+def build(repo_root: Path) -> dict[str, object]:
+    cli = cli_flags(repo_root / "mx_exporter" / "__init__.py")
+    readme = readme_flags(repo_root / "README.md")
+    return {
+        "cli_flag_count": len(cli),
+        "readme_flag_count": len(readme),
+        "flags_missing_from_readme": sorted(flag for flag in cli - readme if flag.startswith("-")),
+        "flags_only_in_readme": sorted(flag for flag in readme - cli if flag.startswith("-")),
+    }
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("--repo-root", type=Path, default=Path("."))
+    parser.add_argument("--output", type=Path)
+    args = parser.parse_args()
+
+    text = json.dumps(build(args.repo_root), indent=2, ensure_ascii=False)
+    if args.output:
+        args.output.write_text(text + "\n", encoding="utf-8")
+    else:
+        print(text)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())