Orcraft Result Fields

A result reports whatever measurements its component chose to declare, on top of the status and descriptions every result carries. This page covers the declared fields, the inherited ones, and the counters each level sums from the level below. How the status itself is set is covered in Orcraft Statuses.

Result fields

Result fields come from the OrcraftResultField namespace and are declared on a result class, exactly the way config fields are declared on a config class:

class MyTestResult(OrcraftTestResult):
	measured_value = OrcraftResultField.Numeric(default=0, label="Measured Value")
	within_limits = OrcraftResultField.Boolean(default=False, label="Within Limits")
	output_file = OrcraftResultField.Text(default="", label="Output File")
	log_orientation = OrcraftResultField.Format(
		default=OrcraftResultField.LogTableOrientation.VERTICAL
	)

Each accepts default, default_factory, label and formatter, with the same meanings they have for config fields. A field with a label appears in the logged result table and in the controller; one without stays internal.

A formatter changes how a value is displayed without changing what is stored, which is how a raw number becomes a percentage or a status becomes a colored word in the log.

Plain attributes

The same holds on the way out. A result can carry plain attributes alongside its declared fields, and the framework hands them to the caller without ever showing them:

class MyProduceStepResult(OrcraftTestStepResult):
	item_count = OrcraftResultField.Numeric(default=0, label="Item Count")

	# Plain attributes: for the calling flow, never a result column.
	calibration = None
	channel_map = ()


class MyProduceStep(OrcraftTestStep):
	def _run_step(self) -> OrcraftTestStepResult:
		self.result = MyProduceStepResult()
		self.result.item_count = len(items)
		self.result.calibration = {"gain": 0.98, "offset": -0.02}
		self.result.channel_map = (0, 2, 1, 3)
		return self.result

Declared fields are the step's visible surface: they appear in the logged result table and as result columns in the controller. Plain attributes are private to the flow that ran the step. They come back with the result - including from a remote endpoint, with their Python types intact - but they are deliberately excluded from the result columns, because they are often exactly the kind of thing nobody wants as a column: a whole state grid, a buffer, megabytes of structure that the next step needs and a table would render as noise.

Anything on the result that is not an Orcraft field, not underscored and not a method counts as a plain attribute - whether it was declared on the class or assigned in the body.

Inherited fields

Result classes inherit a set of fields they never declare. Overridden by user marks the ones your code may assign - none of them has to be, since every result is complete without them. Reserved marks the ones the framework writes as the run progresses, and its icon says how strictly: is a field the framework sets on your behalf - through a checkpoint, an exception - that you may still set directly; is fully reserved: the framework refuses a class that redeclares it and an assignment from your code, with an error naming the field. See the per-component pages for the counters each level adds on top.

Aggregated counters

Each level above a case counts what happened beneath it, so a summary is available without any code keeping score:

Because case counts carry all the way to the top, a suite result answers both questions at once: how many of its groups came back clean, and how many individual cases were actually executed to get there.