up
This commit is contained in:
1 parent
aba07ea7a6
commit
3be2bd37a9
14 files changed
+4986
-47
No files matched your search
@@ -4,3 +4,5 @@ Report/unused/workflow/builds/
|
||||
Report/unused/workflow/uv-cache/
|
||||
Report/*.base.pdf
|
||||
Report/*.pdf.pending
|
||||
Report/python_script/__pycache__/
|
||||
Report/python_script/uv-cache/
|
||||
@@ -0,0 +1,15 @@
|
||||
@echo off
|
||||
setlocal EnableExtensions
|
||||
pushd "%~dp0" || exit /b 1
|
||||
where uv >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo ERROR: uv was not found on PATH.
|
||||
popd
|
||||
exit /b 1
|
||||
)
|
||||
set "UV_CACHE_DIR=%CD%\Report\python_script\uv-cache"
|
||||
set "PYTHONDONTWRITEBYTECODE=1"
|
||||
uv run --script "Report\python_script\report_editor.py"
|
||||
set "EDITOR_EXIT_CODE=%ERRORLEVEL%"
|
||||
popd
|
||||
endlocal & exit /b %EDITOR_EXIT_CODE%
|
||||
@@ -14,5 +14,17 @@ Run `Build_Characterization_Report.bat` from the repository root to create:
|
||||
Report/Linear_Stage_Characterization_Working_Draft.pdf
|
||||
```
|
||||
|
||||
For a table editor, run `Edit_Characterization_Report.bat`. The PyQt5 editor
|
||||
shows the manifest fields, document fields, and workbook inputs. Checklist
|
||||
responses are shown as read-only rows. Select another row to edit it. Search
|
||||
finds text in any column. Yellow marks identify cells edited
|
||||
in the current session. `Save changes` checks evidence paths and workbook
|
||||
structure before it saves. Document fields are stored in
|
||||
`Report/python_script/Report_Settings.json`; workbook inputs remain in
|
||||
`FAT_Checklist.xlsx`. Enter a PDF filename and select `Create working draft PDF`
|
||||
to save the data and build a draft in `Report/`. Review the PDF before issue.
|
||||
The first launch uses `uv` to install the editor and report dependencies in its
|
||||
local cache.
|
||||
|
||||
Read `Report/AGENTS.md` for the detailed evidence and report instructions. The
|
||||
`Transfer` folder contains a clean starter package for a new project.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,7 +1,35 @@
|
||||
{
|
||||
"schema_version": 1,
|
||||
"ecmc": {
|
||||
"field_sources": {"travel": ["ECMC/ED7062_CSP/cfg/axis.yaml"], "positioning_speed": ["ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"], "positioning_acceleration": ["ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"], "positioning_measured_positions": ["ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"], "positioning_pid_settings": ["ECMC/ED7062_CSP/cfg/axis.yaml"], "straightness_speed": ["ECMC/ED7062_CSP/cfg/straightnessTest.plc"], "straightness_acceleration": ["ECMC/ED7062_CSP/cfg/straightnessTest.plc"], "straightness_measured_positions": ["ECMC/ED7062_CSP/cfg/straightnessTest.plc"], "straightness_pid_settings": ["ECMC/ED7062_CSP/cfg/axis.yaml"]},
|
||||
"field_sources": {
|
||||
"travel": [
|
||||
"ECMC/ED7062_CSP/cfg/axis.yaml"
|
||||
],
|
||||
"positioning_speed": [
|
||||
"ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"
|
||||
],
|
||||
"positioning_acceleration": [
|
||||
"ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"
|
||||
],
|
||||
"positioning_measured_positions": [
|
||||
"ECMC/ED7062_CSP/cfg/stopBeforePosition.plc"
|
||||
],
|
||||
"positioning_pid_settings": [
|
||||
"ECMC/ED7062_CSP/cfg/axis.yaml"
|
||||
],
|
||||
"straightness_speed": [
|
||||
"ECMC/ED7062_CSP/cfg/straightnessTest.plc"
|
||||
],
|
||||
"straightness_acceleration": [
|
||||
"ECMC/ED7062_CSP/cfg/straightnessTest.plc"
|
||||
],
|
||||
"straightness_measured_positions": [
|
||||
"ECMC/ED7062_CSP/cfg/straightnessTest.plc"
|
||||
],
|
||||
"straightness_pid_settings": [
|
||||
"ECMC/ED7062_CSP/cfg/axis.yaml"
|
||||
]
|
||||
},
|
||||
"travel": "96 mm configured software-limit span (−1 mm to 95 mm)",
|
||||
"positioning_speed": "2 mm/s",
|
||||
"positioning_acceleration": "3 mm/s²; deceleration 3 mm/s²",
|
||||
@@ -13,7 +41,23 @@
|
||||
"straightness_pid_settings": "Kp = 0.06; Ki = 0.04; Kd = 0.01; Kff = 1"
|
||||
},
|
||||
"encoder": {
|
||||
"field_sources": {"manufacturer": ["Encoder/OWIS_TR-ENCODER.xlsx"], "model": ["Encoder/OWIS_TR-ENCODER.xlsx"], "communication_protocol": ["Encoder/OWIS_TR-ENCODER.xlsx"], "resolution": ["Encoder/OWIS_TR-ENCODER.xlsx"], "number_of_bits": ["Encoder/OWIS_TR-ENCODER.xlsx"]},
|
||||
"field_sources": {
|
||||
"manufacturer": [
|
||||
"Encoder/OWIS_TR-ENCODER.xlsx"
|
||||
],
|
||||
"model": [
|
||||
"Encoder/OWIS_TR-ENCODER.xlsx"
|
||||
],
|
||||
"communication_protocol": [
|
||||
"Encoder/OWIS_TR-ENCODER.xlsx"
|
||||
],
|
||||
"resolution": [
|
||||
"Encoder/OWIS_TR-ENCODER.xlsx"
|
||||
],
|
||||
"number_of_bits": [
|
||||
"Encoder/OWIS_TR-ENCODER.xlsx"
|
||||
]
|
||||
},
|
||||
"manufacturer": "TR-Electronic GmbH",
|
||||
"model": "LT140-S",
|
||||
"communication_protocol": "SSI/24-bit binary",
|
||||
@@ -21,23 +65,86 @@
|
||||
"number_of_bits": "24 bits"
|
||||
},
|
||||
"motor": {
|
||||
"field_sources": {"manufacturer": ["Motor/HM-7471E.pdf"], "model": ["Motor/Motor.xlsx"], "motor_type": ["Motor/HM-7471E.pdf"], "step_count": ["Motor/Motor.xlsx"], "resistance": ["Motor/Motor.xlsx"]},
|
||||
"manufacturer": "Oriental Motor Co., Ltd.",
|
||||
"field_sources": {
|
||||
"manufacturer": [
|
||||
"Motor/HM-7471E.pdf"
|
||||
],
|
||||
"model": [
|
||||
"Motor/Motor.xlsx"
|
||||
],
|
||||
"motor_type": [
|
||||
"Motor/HM-7471E.pdf"
|
||||
],
|
||||
"step_count": [
|
||||
"Motor/Motor.xlsx"
|
||||
],
|
||||
"resistance": [
|
||||
"Motor/Motor.xlsx"
|
||||
]
|
||||
},
|
||||
"manufacturer": "Oriental Motor Co.",
|
||||
"model": "PK245M-02B-C2",
|
||||
"motor_type": "2-phase/5-phase stepping motor",
|
||||
"step_count": "400 steps/rev",
|
||||
"resistance": "7.5 Ω"
|
||||
},
|
||||
"drive": {
|
||||
"field_sources": {"model": ["ECMC/README.md"]},
|
||||
"field_sources": {
|
||||
"model": [
|
||||
"ECMC/README.md"
|
||||
]
|
||||
},
|
||||
"model": "ED7062 CSP; ED7062 CSV; EL7041"
|
||||
},
|
||||
"test_dates": {
|
||||
"field_sources": {"dates": ["Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_ED7062_CSP_EL5042_DC_ClosedLoop_SCurve_gap.pdf", "Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_ED7062_CSV_EL5042_DC_ClosedLoop_SCurve_gap.pdf", "Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_EL7041_EL5042.pdf", "Measurements/OWIS_stageTR_Electronics_FAT_Straightness_Horizontal_XZ.pdf", "Measurements/OWIS_stageTR_Electronics_FAT_Straightness_Vertical_YZ.pdf"]},
|
||||
"field_sources": {
|
||||
"dates": [
|
||||
"Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_ED7062_CSP_EL5042_DC_ClosedLoop_SCurve_gap.pdf",
|
||||
"Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_ED7062_CSV_EL5042_DC_ClosedLoop_SCurve_gap.pdf",
|
||||
"Measurements/OWIS_stageTR_Electronics_FAT_ISO230_Stepper_EL7041_EL5042.pdf",
|
||||
"Measurements/OWIS_stageTR_Electronics_FAT_Straightness_Horizontal_XZ.pdf",
|
||||
"Measurements/OWIS_stageTR_Electronics_FAT_Straightness_Vertical_YZ.pdf"
|
||||
]
|
||||
},
|
||||
"dates": "2026-08-27; 2026-09-07; 2026-09-08"
|
||||
},
|
||||
"measurement_system": {
|
||||
"field_sources": {"manufacturer": ["Measurement_System/5530 Laser Calibration System Components.pdf"], "system_model": ["Measurement_System/5530 Laser Calibration System Components.pdf"], "laser_head_model": ["Measurement_System/5530 Laser Calibration System Components.pdf"], "laser_type": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "vacuum_wavelength": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "wavelength_accuracy": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "wavelength_stability": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "linear_measurement_range": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "straightness_range_resolution": ["Measurement_System/5530 Laser Calibration System Components.pdf", "Measurement_System/5530 Dynamic Calibrator.pdf"], "environmental_compensation": ["Measurement_System/5530 Dynamic Calibrator.pdf"], "air_sensor_accuracy": ["Measurement_System/5530 Dynamic Calibrator.pdf"]},
|
||||
"field_sources": {
|
||||
"manufacturer": [
|
||||
"Measurement_System/5530 Laser Calibration System Components.pdf"
|
||||
],
|
||||
"system_model": [
|
||||
"Measurement_System/5530 Laser Calibration System Components.pdf"
|
||||
],
|
||||
"laser_head_model": [
|
||||
"Measurement_System/5530 Laser Calibration System Components.pdf"
|
||||
],
|
||||
"laser_type": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"vacuum_wavelength": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"wavelength_accuracy": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"wavelength_stability": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"linear_measurement_range": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"straightness_range_resolution": [
|
||||
"Measurement_System/5530 Laser Calibration System Components.pdf",
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"environmental_compensation": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
],
|
||||
"air_sensor_accuracy": [
|
||||
"Measurement_System/5530 Dynamic Calibrator.pdf"
|
||||
]
|
||||
},
|
||||
"manufacturer": "Keysight Technologies",
|
||||
"system_model": "5530 Laser Calibration System",
|
||||
"laser_head_model": "5519A/B HeNe laser system",
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"project_name": "",
|
||||
"report_version": "0.1",
|
||||
"report_date": "",
|
||||
"measurement_procedure": "",
|
||||
"stage_reference": "",
|
||||
"component_references": "",
|
||||
"calibration_references": ""
|
||||
}
|
||||
@@ -131,6 +131,10 @@ CONTROLLED_REPORT_DATA = {
|
||||
"applicable_standards": "ISO 230-2:2014; ISO 230-2:1997",
|
||||
}
|
||||
GENERATED_REPORT_KEYS = {"document_number"}
|
||||
USER_REPORT_KEYS = {
|
||||
"project_name", "report_version", "report_date", "measurement_procedure",
|
||||
"stage_reference", "component_references", "calibration_references",
|
||||
}
|
||||
|
||||
CHECKLIST_SECTIONS = (
|
||||
("Pre-Test Safety", ("Risk assessment conducted", "Safety barriers in place", "E-stop functional", "Equipment grounded", "Personnel briefed", "Cable routing safe", "Environmental conditions OK")),
|
||||
@@ -242,6 +246,19 @@ def read_json_object(path: Path, label: str) -> dict[str, object]:
|
||||
return value
|
||||
|
||||
|
||||
def read_report_settings(path: Path) -> dict[str, str]:
|
||||
"""Read user-entered document fields outside the evidence data contract."""
|
||||
if not path.exists():
|
||||
return {}
|
||||
settings = read_json_object(path, "Report settings")
|
||||
unexpected = set(settings) - USER_REPORT_KEYS
|
||||
if unexpected:
|
||||
raise ValueError("Unknown report setting(s): " + ", ".join(sorted(unexpected)))
|
||||
if any(not isinstance(value, str) for value in settings.values()):
|
||||
raise ValueError("Report settings must contain text values.")
|
||||
return settings
|
||||
|
||||
|
||||
def manifest_path_matches(path: str, pattern: str) -> bool:
|
||||
"""Match manifest paths where ** means zero or more directory levels."""
|
||||
path_parts = tuple(Path(path).as_posix().split("/"))
|
||||
@@ -575,6 +592,7 @@ def main() -> int:
|
||||
parser.add_argument("--workbook", type=Path, default=Path("FAT_Checklist.xlsx"), help="Authoritative checklist workbook")
|
||||
parser.add_argument("--agent-data", type=Path, default=Path("Report/python_script/Agent_Report_Data.json"), help="Source-bound agent report data")
|
||||
parser.add_argument("--manifest", type=Path, default=Path("Report/python_script/Report_Input_Manifest.json"), help="Input-source manifest")
|
||||
parser.add_argument("--settings", type=Path, default=Path("Report/python_script/Report_Settings.json"), help="User-entered document fields")
|
||||
args = parser.parse_args()
|
||||
# The script is stored at Report/python_script; the repository is three
|
||||
# directory levels above it. Keep this relative to the script, not the
|
||||
@@ -586,8 +604,10 @@ def main() -> int:
|
||||
workbook_path = args.workbook if args.workbook.is_absolute() else (repo_root / args.workbook)
|
||||
agent_data_path = args.agent_data if args.agent_data.is_absolute() else (repo_root / args.agent_data)
|
||||
manifest_path = args.manifest if args.manifest.is_absolute() else (repo_root / args.manifest)
|
||||
settings_path = args.settings if args.settings.is_absolute() else (repo_root / args.settings)
|
||||
workbook_inputs = read_workbook(workbook_path.resolve())
|
||||
REPORT_DATA.update(read_agent_data(agent_data_path.resolve(), manifest_path.resolve()))
|
||||
REPORT_DATA.update({key: value for key, value in read_report_settings(settings_path.resolve()).items() if value or key != "report_date"})
|
||||
REPORT_DATA.update(CONTROLLED_REPORT_DATA)
|
||||
REPORT_DATA["document_number"] = output.name
|
||||
REPORT_DATA["stage_identifier"] = workbook_inputs.stage_identifier
|
||||
|
||||
@@ -0,0 +1,436 @@
|
||||
#!/usr/bin/env python3
|
||||
# /// script
|
||||
# requires-python = ">=3.11"
|
||||
# dependencies = [
|
||||
# "PyQt5>=5.15,<6",
|
||||
# "openpyxl>=3.1,<4",
|
||||
# "pypdf>=6.0,<7",
|
||||
# "reportlab>=4.4,<5",
|
||||
# ]
|
||||
# ///
|
||||
"""Edit source-bound report data and start a Characterization draft build."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
sys.dont_write_bytecode = True
|
||||
|
||||
from PyQt5.QtCore import QProcess, QProcessEnvironment
|
||||
from PyQt5.QtGui import QColor
|
||||
from openpyxl import load_workbook
|
||||
from PyQt5.QtWidgets import (
|
||||
QApplication, QFormLayout, QHBoxLayout, QHeaderView, QLineEdit,
|
||||
QMainWindow, QMessageBox, QPlainTextEdit, QPushButton, QSplitter,
|
||||
QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget, QLabel,
|
||||
)
|
||||
|
||||
from build_characterization_report import USER_REPORT_KEYS, read_agent_data, read_json_object, read_report_settings, read_workbook, text_or_blank
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[2]
|
||||
SCRIPT_DIR = Path(__file__).resolve().parent
|
||||
DATA_PATH = SCRIPT_DIR / "Agent_Report_Data.json"
|
||||
MANIFEST_PATH = SCRIPT_DIR / "Report_Input_Manifest.json"
|
||||
SETTINGS_PATH = SCRIPT_DIR / "Report_Settings.json"
|
||||
WORKBOOK_PATH = ROOT / "FAT_Checklist.xlsx"
|
||||
GENERATOR_PATH = SCRIPT_DIR / "build_characterization_report.py"
|
||||
DEFAULT_PDF = "Linear_Stage_Characterization_Working_Draft.pdf"
|
||||
INVALID_FILENAME = re.compile(r'[<>:"/\\|?*\x00-\x1f]')
|
||||
|
||||
|
||||
def checked_pdf_name(name: str) -> str:
|
||||
if (
|
||||
not name or name != name.strip() or name.endswith((".", " "))
|
||||
or INVALID_FILENAME.search(name) or Path(name).suffix.lower() != ".pdf"
|
||||
or name.split(".", 1)[0].upper() in {"CON", "PRN", "AUX", "NUL", *(f"COM{i}" for i in range(1, 10)), *(f"LPT{i}" for i in range(1, 10))}
|
||||
):
|
||||
raise ValueError("Enter a PDF filename with no folder or invalid Windows characters.")
|
||||
return name
|
||||
|
||||
|
||||
def save_validated_data(data: dict) -> None:
|
||||
"""Validate through the generator's contract, then replace the JSON file."""
|
||||
temporary_name = None
|
||||
try:
|
||||
with tempfile.NamedTemporaryFile(
|
||||
mode="w", encoding="utf-8", suffix=".json", prefix=".agent-data-",
|
||||
dir=SCRIPT_DIR, delete=False,
|
||||
) as stream:
|
||||
temporary_name = stream.name
|
||||
json.dump(data, stream, ensure_ascii=False, indent=2)
|
||||
stream.write("\n")
|
||||
read_agent_data(Path(temporary_name), MANIFEST_PATH)
|
||||
os.replace(temporary_name, DATA_PATH)
|
||||
finally:
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
def save_settings(settings: dict[str, str]) -> None:
|
||||
if set(settings) != USER_REPORT_KEYS or any(not isinstance(value, str) for value in settings.values()):
|
||||
raise ValueError("Report settings are incomplete or invalid.")
|
||||
temporary_name = None
|
||||
try:
|
||||
with tempfile.NamedTemporaryFile(
|
||||
mode="w", encoding="utf-8", suffix=".json", prefix=".report-settings-",
|
||||
dir=SCRIPT_DIR, delete=False,
|
||||
) as stream:
|
||||
temporary_name = stream.name
|
||||
json.dump(settings, stream, ensure_ascii=False, indent=2)
|
||||
stream.write("\n")
|
||||
os.replace(temporary_name, SETTINGS_PATH)
|
||||
finally:
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
def save_workbook_values(changes: dict[tuple[str, str], str]) -> None:
|
||||
if not changes:
|
||||
return
|
||||
workbook = load_workbook(WORKBOOK_PATH)
|
||||
temporary_name = None
|
||||
try:
|
||||
for (sheet, address), value in changes.items():
|
||||
workbook[sheet][address] = value or None
|
||||
with tempfile.NamedTemporaryFile(suffix=".xlsx", prefix=".checklist-", dir=ROOT, delete=False) as stream:
|
||||
temporary_name = stream.name
|
||||
workbook.save(temporary_name)
|
||||
read_workbook(Path(temporary_name))
|
||||
os.replace(temporary_name, WORKBOOK_PATH)
|
||||
finally:
|
||||
workbook.close()
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
class ReportEditor(QMainWindow):
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.manifest = read_json_object(MANIFEST_PATH, "Report input manifest")
|
||||
self.data = read_json_object(DATA_PATH, "Agent report data")
|
||||
for domain, definition in self.manifest["domains"].items():
|
||||
record = self.data.setdefault(domain, {})
|
||||
sources = record.setdefault("field_sources", {})
|
||||
for field in definition["fields"]:
|
||||
record.setdefault(field, "")
|
||||
sources.setdefault(field, [])
|
||||
self.settings = read_report_settings(SETTINGS_PATH)
|
||||
for key in USER_REPORT_KEYS:
|
||||
self.settings.setdefault(key, "")
|
||||
read_workbook(WORKBOOK_PATH)
|
||||
self.workbook = load_workbook(WORKBOOK_PATH, read_only=True, data_only=False)
|
||||
self.workbook_cells: dict[str, tuple[str, str]] = {}
|
||||
for address, label in (
|
||||
("C7", "Stage identifier"), ("C8", "Stage name"),
|
||||
("C9", "Repository"), ("C10", "Main Facility"), ("C11", "Author"),
|
||||
):
|
||||
self.workbook_cells[label] = ("Read Me", address)
|
||||
for row in range(14, 20):
|
||||
label = text_or_blank(self.workbook["Read Me"].cell(row, 2).value)
|
||||
self.workbook_cells[f"Coordinate: {label}"] = ("Read Me", f"D{row}")
|
||||
checklist = self.workbook["Checklist"]
|
||||
for row in range(1, checklist.max_row + 1):
|
||||
item = text_or_blank(checklist.cell(row, 2).value)
|
||||
if item and text_or_blank(checklist.cell(row, 1).value) not in {"", "Item"}:
|
||||
for column, suffix in (("C", "Yes"), ("D", "No"), ("E", "Remarks")):
|
||||
self.workbook_cells[f"{item} — {suffix} ({row})"] = ("Checklist", f"{column}{row}")
|
||||
self.workbook_changes: dict[tuple[str, str], str] = {}
|
||||
self.fields = [
|
||||
(domain, field)
|
||||
for domain, definition in self.manifest["domains"].items()
|
||||
for field in definition["fields"]
|
||||
]
|
||||
self.fields += [("document", field) for field in (
|
||||
"project_name", "report_version", "report_date", "measurement_procedure",
|
||||
"stage_reference", "component_references", "calibration_references",
|
||||
)]
|
||||
self.fields += [("workbook", field) for field in self.workbook_cells]
|
||||
self.selected_row = -1
|
||||
self.dirty = False
|
||||
self.process: QProcess | None = None
|
||||
self.setWindowTitle("Characterization report data")
|
||||
self.resize(1400, 860)
|
||||
|
||||
body = QWidget()
|
||||
layout = QVBoxLayout(body)
|
||||
top_line = QHBoxLayout()
|
||||
top_line.addWidget(QLabel("Review each value and its evidence. Blank values are permitted."))
|
||||
top_line.addStretch()
|
||||
top_line.addWidget(QLabel("Search"))
|
||||
self.search_edit = QLineEdit()
|
||||
self.search_edit.setPlaceholderText("Domain, field, value, or evidence file")
|
||||
self.search_edit.setMinimumWidth(320)
|
||||
self.search_edit.textChanged.connect(self.filter_rows)
|
||||
top_line.addWidget(self.search_edit)
|
||||
layout.addLayout(top_line)
|
||||
self.table = QTableWidget(len(self.fields), 4)
|
||||
self.table.setHorizontalHeaderLabels(["Domain", "Field", "Value", "Evidence files"])
|
||||
self.table.setEditTriggers(QTableWidget.NoEditTriggers)
|
||||
self.table.setSelectionBehavior(QTableWidget.SelectRows)
|
||||
self.table.setSelectionMode(QTableWidget.SingleSelection)
|
||||
header = self.table.horizontalHeader()
|
||||
for column, width in enumerate((125, 210, 350, 450)):
|
||||
header.setSectionResizeMode(column, QHeaderView.Interactive)
|
||||
self.table.setColumnWidth(column, width)
|
||||
self.table.currentCellChanged.connect(self.select_row)
|
||||
|
||||
edit_panel = QWidget()
|
||||
form = QFormLayout(edit_panel)
|
||||
self.field_label = QLabel("Select a row")
|
||||
self.rule_label = QLabel("")
|
||||
self.rule_label.setWordWrap(True)
|
||||
self.value_edit = QPlainTextEdit()
|
||||
self.value_edit.setPlaceholderText("Report value")
|
||||
self.sources_edit = QPlainTextEdit()
|
||||
self.sources_edit.setPlaceholderText("One repository-relative evidence path per line")
|
||||
self.value_edit.textChanged.connect(self.update_row)
|
||||
self.sources_edit.textChanged.connect(self.update_row)
|
||||
form.addRow("Field", self.field_label)
|
||||
form.addRow("Allowed sources", self.rule_label)
|
||||
form.addRow("Value", self.value_edit)
|
||||
form.addRow("Evidence files", self.sources_edit)
|
||||
|
||||
split = QSplitter()
|
||||
split.addWidget(self.table)
|
||||
split.addWidget(edit_panel)
|
||||
split.setStretchFactor(0, 3)
|
||||
split.setStretchFactor(1, 2)
|
||||
split.setSizes([950, 400])
|
||||
layout.addWidget(split)
|
||||
name_line = QHBoxLayout()
|
||||
name_line.addWidget(QLabel("PDF filename"))
|
||||
self.filename_edit = QLineEdit(DEFAULT_PDF)
|
||||
name_line.addWidget(self.filename_edit)
|
||||
layout.addLayout(name_line)
|
||||
button_line = QHBoxLayout()
|
||||
self.save_button = QPushButton("Save changes")
|
||||
self.build_button = QPushButton("Create working draft PDF")
|
||||
self.save_button.clicked.connect(self.save)
|
||||
self.build_button.clicked.connect(self.build)
|
||||
button_line.addWidget(self.save_button)
|
||||
button_line.addWidget(self.build_button)
|
||||
button_line.addStretch()
|
||||
layout.addLayout(button_line)
|
||||
self.log = QPlainTextEdit()
|
||||
self.log.setReadOnly(True)
|
||||
self.log.setFixedHeight(72)
|
||||
layout.addWidget(self.log)
|
||||
self.setCentralWidget(body)
|
||||
self.refresh_table()
|
||||
if self.fields:
|
||||
self.table.setCurrentCell(0, 0)
|
||||
|
||||
def refresh_table(self) -> None:
|
||||
for row, (domain, field) in enumerate(self.fields):
|
||||
if domain == "document":
|
||||
value, source_text = self.settings[field], "User entry"
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
value = text_or_blank(self.workbook[sheet][address].value)
|
||||
source_text = f"FAT_Checklist.xlsx: {sheet}!{address}"
|
||||
else:
|
||||
record = self.data.get(domain, {})
|
||||
value = record.get(field, "")
|
||||
source_text = "\n".join(record.get("field_sources", {}).get(field, []))
|
||||
for column, value in enumerate((domain, field, value, source_text)):
|
||||
item = QTableWidgetItem(str(value))
|
||||
item.setToolTip(str(value))
|
||||
self.table.setItem(row, column, item)
|
||||
|
||||
def filter_rows(self, query: str) -> None:
|
||||
query = query.casefold().strip()
|
||||
for row in range(self.table.rowCount()):
|
||||
match = any(query in self.table.item(row, column).text().casefold() for column in range(4))
|
||||
self.table.setRowHidden(row, not match)
|
||||
|
||||
def select_row(self, row: int, _column: int, _old_row: int, _old_column: int) -> None:
|
||||
self.selected_row = -1
|
||||
if row < 0:
|
||||
return
|
||||
domain, field = self.fields[row]
|
||||
self.field_label.setText(f"{domain}.{field}")
|
||||
if domain == "document":
|
||||
self.rule_label.setText("User-entered document field. Review factual references before issue.")
|
||||
self.value_edit.setPlainText(self.settings[field])
|
||||
self.sources_edit.setPlainText("")
|
||||
self.sources_edit.setEnabled(False)
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
self.rule_label.setText(f"FAT_Checklist.xlsx: {sheet}!{address}" + (". Checklist is read only here." if sheet == "Checklist" else ""))
|
||||
self.value_edit.setPlainText(self.workbook_changes.get((sheet, address), text_or_blank(self.workbook[sheet][address].value)))
|
||||
self.value_edit.setReadOnly(sheet == "Checklist")
|
||||
self.sources_edit.setPlainText("")
|
||||
self.sources_edit.setEnabled(False)
|
||||
else:
|
||||
definition = self.manifest["domains"][domain]
|
||||
self.rule_label.setText(", ".join(definition.get("source_patterns", {}).get(field, [definition["source_root"] + "/**"])))
|
||||
record = self.data[domain]
|
||||
self.value_edit.setPlainText(record[field])
|
||||
self.sources_edit.setPlainText("\n".join(record["field_sources"][field]))
|
||||
self.sources_edit.setEnabled(True)
|
||||
if domain != "workbook":
|
||||
self.value_edit.setReadOnly(False)
|
||||
elif sheet != "Checklist":
|
||||
self.value_edit.setReadOnly(False)
|
||||
self.selected_row = row
|
||||
|
||||
def update_row(self) -> None:
|
||||
if self.selected_row < 0:
|
||||
return
|
||||
domain, field = self.fields[self.selected_row]
|
||||
value = self.value_edit.toPlainText()
|
||||
if domain == "document":
|
||||
self.settings[field] = value
|
||||
sources = ["User entry"]
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
if sheet == "Checklist":
|
||||
return
|
||||
self.workbook_changes[(sheet, address)] = value
|
||||
sources = [f"FAT_Checklist.xlsx: {sheet}!{address}"]
|
||||
else:
|
||||
sources = [line.strip() for line in self.sources_edit.toPlainText().splitlines() if line.strip()]
|
||||
self.data[domain][field] = value
|
||||
self.data[domain]["field_sources"][field] = sources
|
||||
self.dirty = True
|
||||
for column, text in ((2, value), (3, "\n".join(sources))):
|
||||
item = self.table.item(self.selected_row, column)
|
||||
item.setText(text)
|
||||
item.setToolTip(text)
|
||||
item.setBackground(QColor("#fff2a8"))
|
||||
self.filter_rows(self.search_edit.text())
|
||||
|
||||
def save(self) -> bool:
|
||||
try:
|
||||
save_workbook_values(self.workbook_changes)
|
||||
save_validated_data(self.data)
|
||||
save_settings(self.settings)
|
||||
except (OSError, ValueError, TypeError) as error:
|
||||
QMessageBox.warning(self, "Data not saved", str(error))
|
||||
return False
|
||||
if self.workbook_changes:
|
||||
self.workbook.close()
|
||||
self.workbook = load_workbook(WORKBOOK_PATH, read_only=True, data_only=False)
|
||||
self.workbook_changes.clear()
|
||||
self.log.appendPlainText("Saved workbook, evidence data, and document fields.")
|
||||
self.dirty = False
|
||||
return True
|
||||
|
||||
def build(self) -> None:
|
||||
try:
|
||||
name = checked_pdf_name(self.filename_edit.text())
|
||||
except ValueError as error:
|
||||
QMessageBox.warning(self, "Invalid PDF filename", str(error))
|
||||
return
|
||||
output = ROOT / "Report" / name
|
||||
if output.exists() and QMessageBox.question(
|
||||
self, "Replace existing PDF", f"Replace {name}?",
|
||||
QMessageBox.Yes | QMessageBox.No, QMessageBox.No,
|
||||
) != QMessageBox.Yes:
|
||||
return
|
||||
if not self.save():
|
||||
return
|
||||
self.log.appendPlainText(f"Building {name} ...")
|
||||
self.build_button.setEnabled(False)
|
||||
self.save_button.setEnabled(False)
|
||||
self.table.setEnabled(False)
|
||||
self.value_edit.setEnabled(False)
|
||||
self.sources_edit.setEnabled(False)
|
||||
self.filename_edit.setEnabled(False)
|
||||
self.search_edit.setEnabled(False)
|
||||
self.process = QProcess(self)
|
||||
self.process.setWorkingDirectory(str(ROOT))
|
||||
environment = QProcessEnvironment.systemEnvironment()
|
||||
environment.insert("UV_CACHE_DIR", str(SCRIPT_DIR / "uv-cache"))
|
||||
self.process.setProcessEnvironment(environment)
|
||||
self.process.setProcessChannelMode(QProcess.MergedChannels)
|
||||
self.process.readyReadStandardOutput.connect(self.read_output)
|
||||
self.process.finished.connect(self.build_finished)
|
||||
self.process.errorOccurred.connect(self.build_error)
|
||||
self.process.start("uv", ["run", "--script", str(GENERATOR_PATH), "--output", str(output)])
|
||||
|
||||
def read_output(self) -> None:
|
||||
if self.process:
|
||||
self.log.appendPlainText(bytes(self.process.readAllStandardOutput()).decode("utf-8", errors="replace").rstrip())
|
||||
|
||||
def build_finished(self, exit_code: int, status: QProcess.ExitStatus) -> None:
|
||||
self.read_output()
|
||||
self.enable_editing()
|
||||
self.log.appendPlainText("Build finished. Review the PDF before issue." if exit_code == 0 and status == QProcess.NormalExit else f"Build failed (exit code {exit_code}).")
|
||||
|
||||
def build_error(self, _error: QProcess.ProcessError) -> None:
|
||||
if self.process:
|
||||
self.log.appendPlainText(self.process.errorString())
|
||||
self.enable_editing()
|
||||
|
||||
def enable_editing(self) -> None:
|
||||
self.build_button.setEnabled(True)
|
||||
self.save_button.setEnabled(True)
|
||||
self.table.setEnabled(True)
|
||||
self.value_edit.setEnabled(True)
|
||||
self.sources_edit.setEnabled(self.selected_row >= 0 and self.fields[self.selected_row][0] not in {"document", "workbook"})
|
||||
self.filename_edit.setEnabled(True)
|
||||
self.search_edit.setEnabled(True)
|
||||
|
||||
def closeEvent(self, event) -> None:
|
||||
if self.process and self.process.state() != QProcess.NotRunning:
|
||||
QMessageBox.information(self, "Build in progress", "Wait for the PDF build to finish.")
|
||||
event.ignore()
|
||||
elif self.dirty and QMessageBox.question(
|
||||
self, "Unsaved changes", "Close without saving changes?",
|
||||
QMessageBox.Yes | QMessageBox.No, QMessageBox.No,
|
||||
) != QMessageBox.Yes:
|
||||
event.ignore()
|
||||
else:
|
||||
event.accept()
|
||||
|
||||
|
||||
def main() -> int:
|
||||
app = QApplication(sys.argv)
|
||||
try:
|
||||
window = ReportEditor()
|
||||
except (OSError, ValueError, TypeError, KeyError) as error:
|
||||
if "--check" in sys.argv:
|
||||
print(f"Editor check failed: {error}", file=sys.stderr)
|
||||
return 1
|
||||
QMessageBox.critical(None, "Cannot open report data", str(error))
|
||||
return 1
|
||||
if "--check" in sys.argv:
|
||||
assert window.table.rowCount() == len(window.fields)
|
||||
assert window.fields
|
||||
project_row = window.fields.index(("document", "project_name"))
|
||||
window.search_edit.setText("project_name")
|
||||
assert not window.table.isRowHidden(project_row)
|
||||
assert sum(not window.table.isRowHidden(row) for row in range(window.table.rowCount())) == 1
|
||||
window.table.setCurrentCell(project_row, 0)
|
||||
original = window.settings["project_name"]
|
||||
window.value_edit.setPlainText("UI check")
|
||||
assert window.settings["project_name"] == "UI check"
|
||||
assert window.table.item(project_row, 2).background().color() == QColor("#fff2a8")
|
||||
window.settings["project_name"] = original
|
||||
assert checked_pdf_name(DEFAULT_PDF) == DEFAULT_PDF
|
||||
for invalid in ("../other.pdf", "CON.pdf", "report.txt"):
|
||||
try:
|
||||
checked_pdf_name(invalid)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
raise AssertionError(f"Accepted invalid filename: {invalid}")
|
||||
checklist_row = next(row for row, (domain, field) in enumerate(window.fields) if domain == "workbook" and window.workbook_cells[field][0] == "Checklist")
|
||||
window.search_edit.clear()
|
||||
window.table.setCurrentCell(checklist_row, 0)
|
||||
assert window.value_edit.isReadOnly()
|
||||
print(f"Editor loaded {len(window.fields)} rows; search, change mark, and checklist lock passed.")
|
||||
return 0
|
||||
window.show()
|
||||
return app.exec_()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
@@ -1,38 +0,0 @@
|
||||
@echo off
|
||||
setlocal EnableExtensions
|
||||
|
||||
rem Build the evidence-bounded Characterization working draft without LaTeX.
|
||||
rem This file must remain in the repository root.
|
||||
pushd "%~dp0" || (
|
||||
echo ERROR: Cannot open the report repository folder.
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
where uv >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo ERROR: uv was not found on PATH.
|
||||
echo Install uv from https://docs.astral.sh/uv/ and open a new Command Prompt.
|
||||
popd
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
rem Keep uv's cache within the authorized report-workflow folder.
|
||||
set "UV_CACHE_DIR=%CD%\Report\python_script\uv-cache"
|
||||
|
||||
echo Building the Characterization working draft with uv...
|
||||
uv run --script "Report\python_script\build_characterization_report.py" --workbook "FAT_Checklist.xlsx" --agent-data "Report\python_script\Agent_Report_Data.json" --manifest "Report\python_script\Report_Input_Manifest.json" --output "Report\Linear_Stage_Characterization_Working_Draft.pdf"
|
||||
if errorlevel 1 (
|
||||
echo.
|
||||
echo ERROR: Report build failed. Read the message above; do not use a partial PDF.
|
||||
set "BUILD_EXIT_CODE=1"
|
||||
) else (
|
||||
echo.
|
||||
echo PDF created: Report\Linear_Stage_Characterization_Working_Draft.pdf
|
||||
set "BUILD_EXIT_CODE=0"
|
||||
)
|
||||
|
||||
echo.
|
||||
echo This window will remain open. Close it when you have finished reviewing the output.
|
||||
popd
|
||||
cmd /k
|
||||
endlocal & exit /b %BUILD_EXIT_CODE%
|
||||
@@ -0,0 +1,15 @@
|
||||
@echo off
|
||||
setlocal EnableExtensions
|
||||
pushd "%~dp0" || exit /b 1
|
||||
where uv >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo ERROR: uv was not found on PATH.
|
||||
popd
|
||||
exit /b 1
|
||||
)
|
||||
set "UV_CACHE_DIR=%CD%\Report\python_script\uv-cache"
|
||||
set "PYTHONDONTWRITEBYTECODE=1"
|
||||
uv run --script "Report\python_script\report_editor.py"
|
||||
set "EDITOR_EXIT_CODE=%ERRORLEVEL%"
|
||||
popd
|
||||
endlocal & exit /b %EDITOR_EXIT_CODE%
|
||||
+5
-2
@@ -18,8 +18,11 @@ cache.
|
||||
A legible, unambiguous photograph in `Media` is valid evidence for the
|
||||
directly visible component or instrument information permitted by that
|
||||
manifest; cite the exact image path.
|
||||
5. Ensure `uv` is installed and on PATH, then run
|
||||
`Build_Characterization_Report.bat` from the project root.
|
||||
5. Ensure `uv` is installed and on PATH. Run `Edit_Characterization_Report.bat`
|
||||
to review and edit report, workbook, and document values in a table. The
|
||||
checklist rows are read only in the app. Select
|
||||
`Save changes`, then `Create working draft PDF`. The original batch launcher
|
||||
remains available.
|
||||
|
||||
The generator expects images named `I1` through `I6` in `Media` and appends
|
||||
every top-level PDF in `Measurements` in filename order.
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"project_name": "",
|
||||
"report_version": "0.1",
|
||||
"report_date": "",
|
||||
"measurement_procedure": "",
|
||||
"stage_reference": "",
|
||||
"component_references": "",
|
||||
"calibration_references": ""
|
||||
}
|
||||
@@ -131,6 +131,10 @@ CONTROLLED_REPORT_DATA = {
|
||||
"applicable_standards": "ISO 230-2:2014; ISO 230-2:1997",
|
||||
}
|
||||
GENERATED_REPORT_KEYS = {"document_number"}
|
||||
USER_REPORT_KEYS = {
|
||||
"project_name", "report_version", "report_date", "measurement_procedure",
|
||||
"stage_reference", "component_references", "calibration_references",
|
||||
}
|
||||
|
||||
CHECKLIST_SECTIONS = (
|
||||
("Pre-Test Safety", ("Risk assessment conducted", "Safety barriers in place", "E-stop functional", "Equipment grounded", "Personnel briefed", "Cable routing safe", "Environmental conditions OK")),
|
||||
@@ -242,6 +246,19 @@ def read_json_object(path: Path, label: str) -> dict[str, object]:
|
||||
return value
|
||||
|
||||
|
||||
def read_report_settings(path: Path) -> dict[str, str]:
|
||||
"""Read user-entered document fields outside the evidence data contract."""
|
||||
if not path.exists():
|
||||
return {}
|
||||
settings = read_json_object(path, "Report settings")
|
||||
unexpected = set(settings) - USER_REPORT_KEYS
|
||||
if unexpected:
|
||||
raise ValueError("Unknown report setting(s): " + ", ".join(sorted(unexpected)))
|
||||
if any(not isinstance(value, str) for value in settings.values()):
|
||||
raise ValueError("Report settings must contain text values.")
|
||||
return settings
|
||||
|
||||
|
||||
def manifest_path_matches(path: str, pattern: str) -> bool:
|
||||
"""Match manifest paths where ** means zero or more directory levels."""
|
||||
path_parts = tuple(Path(path).as_posix().split("/"))
|
||||
@@ -560,6 +577,7 @@ def main() -> int:
|
||||
parser.add_argument("--workbook", type=Path, default=Path("FAT_Checklist.xlsx"), help="Authoritative checklist workbook")
|
||||
parser.add_argument("--agent-data", type=Path, default=Path("Report/python_script/Agent_Report_Data.json"), help="Source-bound agent report data")
|
||||
parser.add_argument("--manifest", type=Path, default=Path("Report/python_script/Report_Input_Manifest.json"), help="Input-source manifest")
|
||||
parser.add_argument("--settings", type=Path, default=Path("Report/python_script/Report_Settings.json"), help="User-entered document fields")
|
||||
args = parser.parse_args()
|
||||
# The script is stored at Report/python_script; the repository is three
|
||||
# directory levels above it. Keep this relative to the script, not the
|
||||
@@ -571,8 +589,10 @@ def main() -> int:
|
||||
workbook_path = args.workbook if args.workbook.is_absolute() else (repo_root / args.workbook)
|
||||
agent_data_path = args.agent_data if args.agent_data.is_absolute() else (repo_root / args.agent_data)
|
||||
manifest_path = args.manifest if args.manifest.is_absolute() else (repo_root / args.manifest)
|
||||
settings_path = args.settings if args.settings.is_absolute() else (repo_root / args.settings)
|
||||
workbook_inputs = read_workbook(workbook_path.resolve())
|
||||
REPORT_DATA.update(read_agent_data(agent_data_path.resolve(), manifest_path.resolve()))
|
||||
REPORT_DATA.update({key: value for key, value in read_report_settings(settings_path.resolve()).items() if value or key != "report_date"})
|
||||
REPORT_DATA.update(CONTROLLED_REPORT_DATA)
|
||||
REPORT_DATA["document_number"] = output.name
|
||||
REPORT_DATA["stage_identifier"] = workbook_inputs.stage_identifier
|
||||
|
||||
@@ -0,0 +1,436 @@
|
||||
#!/usr/bin/env python3
|
||||
# /// script
|
||||
# requires-python = ">=3.11"
|
||||
# dependencies = [
|
||||
# "PyQt5>=5.15,<6",
|
||||
# "openpyxl>=3.1,<4",
|
||||
# "pypdf>=6.0,<7",
|
||||
# "reportlab>=4.4,<5",
|
||||
# ]
|
||||
# ///
|
||||
"""Edit source-bound report data and start a Characterization draft build."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
sys.dont_write_bytecode = True
|
||||
|
||||
from PyQt5.QtCore import QProcess, QProcessEnvironment
|
||||
from PyQt5.QtGui import QColor
|
||||
from openpyxl import load_workbook
|
||||
from PyQt5.QtWidgets import (
|
||||
QApplication, QFormLayout, QHBoxLayout, QHeaderView, QLineEdit,
|
||||
QMainWindow, QMessageBox, QPlainTextEdit, QPushButton, QSplitter,
|
||||
QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget, QLabel,
|
||||
)
|
||||
|
||||
from build_characterization_report import USER_REPORT_KEYS, read_agent_data, read_json_object, read_report_settings, read_workbook, text_or_blank
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[2]
|
||||
SCRIPT_DIR = Path(__file__).resolve().parent
|
||||
DATA_PATH = SCRIPT_DIR / "Agent_Report_Data.json"
|
||||
MANIFEST_PATH = SCRIPT_DIR / "Report_Input_Manifest.json"
|
||||
SETTINGS_PATH = SCRIPT_DIR / "Report_Settings.json"
|
||||
WORKBOOK_PATH = ROOT / "FAT_Checklist.xlsx"
|
||||
GENERATOR_PATH = SCRIPT_DIR / "build_characterization_report.py"
|
||||
DEFAULT_PDF = "Linear_Stage_Characterization_Working_Draft.pdf"
|
||||
INVALID_FILENAME = re.compile(r'[<>:"/\\|?*\x00-\x1f]')
|
||||
|
||||
|
||||
def checked_pdf_name(name: str) -> str:
|
||||
if (
|
||||
not name or name != name.strip() or name.endswith((".", " "))
|
||||
or INVALID_FILENAME.search(name) or Path(name).suffix.lower() != ".pdf"
|
||||
or name.split(".", 1)[0].upper() in {"CON", "PRN", "AUX", "NUL", *(f"COM{i}" for i in range(1, 10)), *(f"LPT{i}" for i in range(1, 10))}
|
||||
):
|
||||
raise ValueError("Enter a PDF filename with no folder or invalid Windows characters.")
|
||||
return name
|
||||
|
||||
|
||||
def save_validated_data(data: dict) -> None:
|
||||
"""Validate through the generator's contract, then replace the JSON file."""
|
||||
temporary_name = None
|
||||
try:
|
||||
with tempfile.NamedTemporaryFile(
|
||||
mode="w", encoding="utf-8", suffix=".json", prefix=".agent-data-",
|
||||
dir=SCRIPT_DIR, delete=False,
|
||||
) as stream:
|
||||
temporary_name = stream.name
|
||||
json.dump(data, stream, ensure_ascii=False, indent=2)
|
||||
stream.write("\n")
|
||||
read_agent_data(Path(temporary_name), MANIFEST_PATH)
|
||||
os.replace(temporary_name, DATA_PATH)
|
||||
finally:
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
def save_settings(settings: dict[str, str]) -> None:
|
||||
if set(settings) != USER_REPORT_KEYS or any(not isinstance(value, str) for value in settings.values()):
|
||||
raise ValueError("Report settings are incomplete or invalid.")
|
||||
temporary_name = None
|
||||
try:
|
||||
with tempfile.NamedTemporaryFile(
|
||||
mode="w", encoding="utf-8", suffix=".json", prefix=".report-settings-",
|
||||
dir=SCRIPT_DIR, delete=False,
|
||||
) as stream:
|
||||
temporary_name = stream.name
|
||||
json.dump(settings, stream, ensure_ascii=False, indent=2)
|
||||
stream.write("\n")
|
||||
os.replace(temporary_name, SETTINGS_PATH)
|
||||
finally:
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
def save_workbook_values(changes: dict[tuple[str, str], str]) -> None:
|
||||
if not changes:
|
||||
return
|
||||
workbook = load_workbook(WORKBOOK_PATH)
|
||||
temporary_name = None
|
||||
try:
|
||||
for (sheet, address), value in changes.items():
|
||||
workbook[sheet][address] = value or None
|
||||
with tempfile.NamedTemporaryFile(suffix=".xlsx", prefix=".checklist-", dir=ROOT, delete=False) as stream:
|
||||
temporary_name = stream.name
|
||||
workbook.save(temporary_name)
|
||||
read_workbook(Path(temporary_name))
|
||||
os.replace(temporary_name, WORKBOOK_PATH)
|
||||
finally:
|
||||
workbook.close()
|
||||
if temporary_name and Path(temporary_name).exists():
|
||||
Path(temporary_name).unlink()
|
||||
|
||||
|
||||
class ReportEditor(QMainWindow):
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.manifest = read_json_object(MANIFEST_PATH, "Report input manifest")
|
||||
self.data = read_json_object(DATA_PATH, "Agent report data")
|
||||
for domain, definition in self.manifest["domains"].items():
|
||||
record = self.data.setdefault(domain, {})
|
||||
sources = record.setdefault("field_sources", {})
|
||||
for field in definition["fields"]:
|
||||
record.setdefault(field, "")
|
||||
sources.setdefault(field, [])
|
||||
self.settings = read_report_settings(SETTINGS_PATH)
|
||||
for key in USER_REPORT_KEYS:
|
||||
self.settings.setdefault(key, "")
|
||||
read_workbook(WORKBOOK_PATH)
|
||||
self.workbook = load_workbook(WORKBOOK_PATH, read_only=True, data_only=False)
|
||||
self.workbook_cells: dict[str, tuple[str, str]] = {}
|
||||
for address, label in (
|
||||
("C7", "Stage identifier"), ("C8", "Stage name"),
|
||||
("C9", "Repository"), ("C10", "Main Facility"), ("C11", "Author"),
|
||||
):
|
||||
self.workbook_cells[label] = ("Read Me", address)
|
||||
for row in range(14, 20):
|
||||
label = text_or_blank(self.workbook["Read Me"].cell(row, 2).value)
|
||||
self.workbook_cells[f"Coordinate: {label}"] = ("Read Me", f"D{row}")
|
||||
checklist = self.workbook["Checklist"]
|
||||
for row in range(1, checklist.max_row + 1):
|
||||
item = text_or_blank(checklist.cell(row, 2).value)
|
||||
if item and text_or_blank(checklist.cell(row, 1).value) not in {"", "Item"}:
|
||||
for column, suffix in (("C", "Yes"), ("D", "No"), ("E", "Remarks")):
|
||||
self.workbook_cells[f"{item} — {suffix} ({row})"] = ("Checklist", f"{column}{row}")
|
||||
self.workbook_changes: dict[tuple[str, str], str] = {}
|
||||
self.fields = [
|
||||
(domain, field)
|
||||
for domain, definition in self.manifest["domains"].items()
|
||||
for field in definition["fields"]
|
||||
]
|
||||
self.fields += [("document", field) for field in (
|
||||
"project_name", "report_version", "report_date", "measurement_procedure",
|
||||
"stage_reference", "component_references", "calibration_references",
|
||||
)]
|
||||
self.fields += [("workbook", field) for field in self.workbook_cells]
|
||||
self.selected_row = -1
|
||||
self.dirty = False
|
||||
self.process: QProcess | None = None
|
||||
self.setWindowTitle("Characterization report data")
|
||||
self.resize(1400, 860)
|
||||
|
||||
body = QWidget()
|
||||
layout = QVBoxLayout(body)
|
||||
top_line = QHBoxLayout()
|
||||
top_line.addWidget(QLabel("Review each value and its evidence. Blank values are permitted."))
|
||||
top_line.addStretch()
|
||||
top_line.addWidget(QLabel("Search"))
|
||||
self.search_edit = QLineEdit()
|
||||
self.search_edit.setPlaceholderText("Domain, field, value, or evidence file")
|
||||
self.search_edit.setMinimumWidth(320)
|
||||
self.search_edit.textChanged.connect(self.filter_rows)
|
||||
top_line.addWidget(self.search_edit)
|
||||
layout.addLayout(top_line)
|
||||
self.table = QTableWidget(len(self.fields), 4)
|
||||
self.table.setHorizontalHeaderLabels(["Domain", "Field", "Value", "Evidence files"])
|
||||
self.table.setEditTriggers(QTableWidget.NoEditTriggers)
|
||||
self.table.setSelectionBehavior(QTableWidget.SelectRows)
|
||||
self.table.setSelectionMode(QTableWidget.SingleSelection)
|
||||
header = self.table.horizontalHeader()
|
||||
for column, width in enumerate((125, 210, 350, 450)):
|
||||
header.setSectionResizeMode(column, QHeaderView.Interactive)
|
||||
self.table.setColumnWidth(column, width)
|
||||
self.table.currentCellChanged.connect(self.select_row)
|
||||
|
||||
edit_panel = QWidget()
|
||||
form = QFormLayout(edit_panel)
|
||||
self.field_label = QLabel("Select a row")
|
||||
self.rule_label = QLabel("")
|
||||
self.rule_label.setWordWrap(True)
|
||||
self.value_edit = QPlainTextEdit()
|
||||
self.value_edit.setPlaceholderText("Report value")
|
||||
self.sources_edit = QPlainTextEdit()
|
||||
self.sources_edit.setPlaceholderText("One repository-relative evidence path per line")
|
||||
self.value_edit.textChanged.connect(self.update_row)
|
||||
self.sources_edit.textChanged.connect(self.update_row)
|
||||
form.addRow("Field", self.field_label)
|
||||
form.addRow("Allowed sources", self.rule_label)
|
||||
form.addRow("Value", self.value_edit)
|
||||
form.addRow("Evidence files", self.sources_edit)
|
||||
|
||||
split = QSplitter()
|
||||
split.addWidget(self.table)
|
||||
split.addWidget(edit_panel)
|
||||
split.setStretchFactor(0, 3)
|
||||
split.setStretchFactor(1, 2)
|
||||
split.setSizes([950, 400])
|
||||
layout.addWidget(split)
|
||||
name_line = QHBoxLayout()
|
||||
name_line.addWidget(QLabel("PDF filename"))
|
||||
self.filename_edit = QLineEdit(DEFAULT_PDF)
|
||||
name_line.addWidget(self.filename_edit)
|
||||
layout.addLayout(name_line)
|
||||
button_line = QHBoxLayout()
|
||||
self.save_button = QPushButton("Save changes")
|
||||
self.build_button = QPushButton("Create working draft PDF")
|
||||
self.save_button.clicked.connect(self.save)
|
||||
self.build_button.clicked.connect(self.build)
|
||||
button_line.addWidget(self.save_button)
|
||||
button_line.addWidget(self.build_button)
|
||||
button_line.addStretch()
|
||||
layout.addLayout(button_line)
|
||||
self.log = QPlainTextEdit()
|
||||
self.log.setReadOnly(True)
|
||||
self.log.setFixedHeight(72)
|
||||
layout.addWidget(self.log)
|
||||
self.setCentralWidget(body)
|
||||
self.refresh_table()
|
||||
if self.fields:
|
||||
self.table.setCurrentCell(0, 0)
|
||||
|
||||
def refresh_table(self) -> None:
|
||||
for row, (domain, field) in enumerate(self.fields):
|
||||
if domain == "document":
|
||||
value, source_text = self.settings[field], "User entry"
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
value = text_or_blank(self.workbook[sheet][address].value)
|
||||
source_text = f"FAT_Checklist.xlsx: {sheet}!{address}"
|
||||
else:
|
||||
record = self.data.get(domain, {})
|
||||
value = record.get(field, "")
|
||||
source_text = "\n".join(record.get("field_sources", {}).get(field, []))
|
||||
for column, value in enumerate((domain, field, value, source_text)):
|
||||
item = QTableWidgetItem(str(value))
|
||||
item.setToolTip(str(value))
|
||||
self.table.setItem(row, column, item)
|
||||
|
||||
def filter_rows(self, query: str) -> None:
|
||||
query = query.casefold().strip()
|
||||
for row in range(self.table.rowCount()):
|
||||
match = any(query in self.table.item(row, column).text().casefold() for column in range(4))
|
||||
self.table.setRowHidden(row, not match)
|
||||
|
||||
def select_row(self, row: int, _column: int, _old_row: int, _old_column: int) -> None:
|
||||
self.selected_row = -1
|
||||
if row < 0:
|
||||
return
|
||||
domain, field = self.fields[row]
|
||||
self.field_label.setText(f"{domain}.{field}")
|
||||
if domain == "document":
|
||||
self.rule_label.setText("User-entered document field. Review factual references before issue.")
|
||||
self.value_edit.setPlainText(self.settings[field])
|
||||
self.sources_edit.setPlainText("")
|
||||
self.sources_edit.setEnabled(False)
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
self.rule_label.setText(f"FAT_Checklist.xlsx: {sheet}!{address}" + (". Checklist is read only here." if sheet == "Checklist" else ""))
|
||||
self.value_edit.setPlainText(self.workbook_changes.get((sheet, address), text_or_blank(self.workbook[sheet][address].value)))
|
||||
self.value_edit.setReadOnly(sheet == "Checklist")
|
||||
self.sources_edit.setPlainText("")
|
||||
self.sources_edit.setEnabled(False)
|
||||
else:
|
||||
definition = self.manifest["domains"][domain]
|
||||
self.rule_label.setText(", ".join(definition.get("source_patterns", {}).get(field, [definition["source_root"] + "/**"])))
|
||||
record = self.data[domain]
|
||||
self.value_edit.setPlainText(record[field])
|
||||
self.sources_edit.setPlainText("\n".join(record["field_sources"][field]))
|
||||
self.sources_edit.setEnabled(True)
|
||||
if domain != "workbook":
|
||||
self.value_edit.setReadOnly(False)
|
||||
elif sheet != "Checklist":
|
||||
self.value_edit.setReadOnly(False)
|
||||
self.selected_row = row
|
||||
|
||||
def update_row(self) -> None:
|
||||
if self.selected_row < 0:
|
||||
return
|
||||
domain, field = self.fields[self.selected_row]
|
||||
value = self.value_edit.toPlainText()
|
||||
if domain == "document":
|
||||
self.settings[field] = value
|
||||
sources = ["User entry"]
|
||||
elif domain == "workbook":
|
||||
sheet, address = self.workbook_cells[field]
|
||||
if sheet == "Checklist":
|
||||
return
|
||||
self.workbook_changes[(sheet, address)] = value
|
||||
sources = [f"FAT_Checklist.xlsx: {sheet}!{address}"]
|
||||
else:
|
||||
sources = [line.strip() for line in self.sources_edit.toPlainText().splitlines() if line.strip()]
|
||||
self.data[domain][field] = value
|
||||
self.data[domain]["field_sources"][field] = sources
|
||||
self.dirty = True
|
||||
for column, text in ((2, value), (3, "\n".join(sources))):
|
||||
item = self.table.item(self.selected_row, column)
|
||||
item.setText(text)
|
||||
item.setToolTip(text)
|
||||
item.setBackground(QColor("#fff2a8"))
|
||||
self.filter_rows(self.search_edit.text())
|
||||
|
||||
def save(self) -> bool:
|
||||
try:
|
||||
save_workbook_values(self.workbook_changes)
|
||||
save_validated_data(self.data)
|
||||
save_settings(self.settings)
|
||||
except (OSError, ValueError, TypeError) as error:
|
||||
QMessageBox.warning(self, "Data not saved", str(error))
|
||||
return False
|
||||
if self.workbook_changes:
|
||||
self.workbook.close()
|
||||
self.workbook = load_workbook(WORKBOOK_PATH, read_only=True, data_only=False)
|
||||
self.workbook_changes.clear()
|
||||
self.log.appendPlainText("Saved workbook, evidence data, and document fields.")
|
||||
self.dirty = False
|
||||
return True
|
||||
|
||||
def build(self) -> None:
|
||||
try:
|
||||
name = checked_pdf_name(self.filename_edit.text())
|
||||
except ValueError as error:
|
||||
QMessageBox.warning(self, "Invalid PDF filename", str(error))
|
||||
return
|
||||
output = ROOT / "Report" / name
|
||||
if output.exists() and QMessageBox.question(
|
||||
self, "Replace existing PDF", f"Replace {name}?",
|
||||
QMessageBox.Yes | QMessageBox.No, QMessageBox.No,
|
||||
) != QMessageBox.Yes:
|
||||
return
|
||||
if not self.save():
|
||||
return
|
||||
self.log.appendPlainText(f"Building {name} ...")
|
||||
self.build_button.setEnabled(False)
|
||||
self.save_button.setEnabled(False)
|
||||
self.table.setEnabled(False)
|
||||
self.value_edit.setEnabled(False)
|
||||
self.sources_edit.setEnabled(False)
|
||||
self.filename_edit.setEnabled(False)
|
||||
self.search_edit.setEnabled(False)
|
||||
self.process = QProcess(self)
|
||||
self.process.setWorkingDirectory(str(ROOT))
|
||||
environment = QProcessEnvironment.systemEnvironment()
|
||||
environment.insert("UV_CACHE_DIR", str(SCRIPT_DIR / "uv-cache"))
|
||||
self.process.setProcessEnvironment(environment)
|
||||
self.process.setProcessChannelMode(QProcess.MergedChannels)
|
||||
self.process.readyReadStandardOutput.connect(self.read_output)
|
||||
self.process.finished.connect(self.build_finished)
|
||||
self.process.errorOccurred.connect(self.build_error)
|
||||
self.process.start("uv", ["run", "--script", str(GENERATOR_PATH), "--output", str(output)])
|
||||
|
||||
def read_output(self) -> None:
|
||||
if self.process:
|
||||
self.log.appendPlainText(bytes(self.process.readAllStandardOutput()).decode("utf-8", errors="replace").rstrip())
|
||||
|
||||
def build_finished(self, exit_code: int, status: QProcess.ExitStatus) -> None:
|
||||
self.read_output()
|
||||
self.enable_editing()
|
||||
self.log.appendPlainText("Build finished. Review the PDF before issue." if exit_code == 0 and status == QProcess.NormalExit else f"Build failed (exit code {exit_code}).")
|
||||
|
||||
def build_error(self, _error: QProcess.ProcessError) -> None:
|
||||
if self.process:
|
||||
self.log.appendPlainText(self.process.errorString())
|
||||
self.enable_editing()
|
||||
|
||||
def enable_editing(self) -> None:
|
||||
self.build_button.setEnabled(True)
|
||||
self.save_button.setEnabled(True)
|
||||
self.table.setEnabled(True)
|
||||
self.value_edit.setEnabled(True)
|
||||
self.sources_edit.setEnabled(self.selected_row >= 0 and self.fields[self.selected_row][0] not in {"document", "workbook"})
|
||||
self.filename_edit.setEnabled(True)
|
||||
self.search_edit.setEnabled(True)
|
||||
|
||||
def closeEvent(self, event) -> None:
|
||||
if self.process and self.process.state() != QProcess.NotRunning:
|
||||
QMessageBox.information(self, "Build in progress", "Wait for the PDF build to finish.")
|
||||
event.ignore()
|
||||
elif self.dirty and QMessageBox.question(
|
||||
self, "Unsaved changes", "Close without saving changes?",
|
||||
QMessageBox.Yes | QMessageBox.No, QMessageBox.No,
|
||||
) != QMessageBox.Yes:
|
||||
event.ignore()
|
||||
else:
|
||||
event.accept()
|
||||
|
||||
|
||||
def main() -> int:
|
||||
app = QApplication(sys.argv)
|
||||
try:
|
||||
window = ReportEditor()
|
||||
except (OSError, ValueError, TypeError, KeyError) as error:
|
||||
if "--check" in sys.argv:
|
||||
print(f"Editor check failed: {error}", file=sys.stderr)
|
||||
return 1
|
||||
QMessageBox.critical(None, "Cannot open report data", str(error))
|
||||
return 1
|
||||
if "--check" in sys.argv:
|
||||
assert window.table.rowCount() == len(window.fields)
|
||||
assert window.fields
|
||||
project_row = window.fields.index(("document", "project_name"))
|
||||
window.search_edit.setText("project_name")
|
||||
assert not window.table.isRowHidden(project_row)
|
||||
assert sum(not window.table.isRowHidden(row) for row in range(window.table.rowCount())) == 1
|
||||
window.table.setCurrentCell(project_row, 0)
|
||||
original = window.settings["project_name"]
|
||||
window.value_edit.setPlainText("UI check")
|
||||
assert window.settings["project_name"] == "UI check"
|
||||
assert window.table.item(project_row, 2).background().color() == QColor("#fff2a8")
|
||||
window.settings["project_name"] = original
|
||||
assert checked_pdf_name(DEFAULT_PDF) == DEFAULT_PDF
|
||||
for invalid in ("../other.pdf", "CON.pdf", "report.txt"):
|
||||
try:
|
||||
checked_pdf_name(invalid)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
raise AssertionError(f"Accepted invalid filename: {invalid}")
|
||||
checklist_row = next(row for row, (domain, field) in enumerate(window.fields) if domain == "workbook" and window.workbook_cells[field][0] == "Checklist")
|
||||
window.search_edit.clear()
|
||||
window.table.setCurrentCell(checklist_row, 0)
|
||||
assert window.value_edit.isReadOnly()
|
||||
print(f"Editor loaded {len(window.fields)} rows; search, change mark, and checklist lock passed.")
|
||||
return 0
|
||||
window.show()
|
||||
return app.exec_()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
Reference in new issue
Block a user