footings.model.def_return

def_return(*, dtype: Optional[Any] = None, description: Optional[str] = None, init_value: Optional[Any] = None, **kwargs)

Define an intermediate attribute under the model.

A placeholder is a non-frozen attribute that is created by the model and returned when the model runs.

Parameters

• dtype (Optional[Any]) – The expected type of the attribute. If not None, value will be validated on instantiation.

• description (Optional[str]) – Optional description to add.

• init_value (Optional[Any]) – Optional initival value to assign.

• kwargs – Advanced options to pass through to attrs.attrib.

footings.model.def_intermediate footings.scenario_registry.def_attribute