Reference

API Reference

Complete reference for every public class and method in instrumation-report 0.0.1.

On this page

Measurement ReportHeader TestTable Section Report Condition types

Measurement

Dataclass. A single measured value with optional pass/fail evaluation.

Field	Type	Default	Description
name	str	required	Label for the measurement row.
value	float	required	Measured numeric value.
unit	str	""	Unit string, e.g. `"V"`, `"Hz"`, `"dB"`.
condition	tuple \| callable \| float \| None	None	Pass/fail rule. See Condition types.
test_number	str	""	Procedure reference, e.g. `"1.1.3"`.
expected	str	""	Human-readable expected value, e.g. `"3.2–3.4 V"`.
notes	str	""	Short annotation shown in the Notes column.
description	str	""	Longer description (not shown in table by default).

Properties

.evaluate() → bool | None Evaluates the condition. Returns True, False, or None (no condition).

.status → str Returns "PASS", "FAIL", or "N/A" based on evaluate().

ReportHeader

Dataclass. UUT metadata shown in the report header block.

Field	Type	Default	Description
title	str	required	Main report title.
subtitle	str	""	Secondary line shown below the title.
engineer	str	""	Engineer / tester name.
uut_name	str	""	Name of the unit under test.
uut_serial	str	""	Serial number of the UUT.
revision	str	""	Hardware or firmware revision.
date	str	today (ISO)	Test date. Defaults to `datetime.date.today().isoformat()`.
extra_fields	dict	{}	Arbitrary key/value pairs added to the header grid.

TestTable

Dataclass. A numbered table of measurements inside a Section.

Field	Type	Default	Description
title	str	required	Table heading.
sub_number	str	required	Sub-section identifier, e.g. `"1.1"`.
measurements	list[Measurement]	[]	Populated via `add()`.

.add(measurement: Measurement) Append a measurement to this table.

Section

Dataclass. A top-level section containing one or more TestTables.

Field	Type	Default	Description
number	str	required	Section number, e.g. `"1"`, `"2"`.
title	str	required	Section heading.
subtitle	str	""	Optional sub-heading shown below the section title.
tables	list[TestTable]	[]	Populated via `add_table()`.

.add_table(table: TestTable) Append a TestTable to this section.

Report

Main class. Holds the header, sections, and flat measurements. Drives output generation.

Constructor — Report(header: ReportHeader = None)

If header is omitted, a default header with title "Measurement Report" and today's date is used.

.add_section(section: Section) Add a structured section to the report.

.add(measurement: Measurement) Flat backwards-compatible API. Measurements appear after all sections.

.generate_html(path: str) Write a self-contained HTML report. Dependencies: jinja2.

.generate_excel(path: str) Write a structured .xlsx report with coloured rows. Dependencies: openpyxl.

.generate_pdf(path: str) Write an A4 PDF via weasyprint. Requires pip install "instrumation-report[pdf]" and system Pango libraries. Raises ImportError if weasyprint is not installed.

Condition types

The condition argument on Measurement accepts four forms:

Type	Example	Passes when	Notes
Range tuple	`(3.2, 3.4)`	`lo <= value <= hi`	Inclusive on both ends
Lambda	`lambda v: v > 1000`	Callable returns truthy	Any callable `float → bool`
Threshold float	`15.0`	`value >= threshold`	Useful for minimum specs
None	omit argument	N/A — no evaluation	Good for informational rows

Passing an unsupported type (e.g. a string) to condition raises TypeError at evaluation time.