footings.model.def_sensitivity

def_sensitivity(*, default: Any = NOTHING, dtype: Optional[Any] = None, description: Optional[str] = None, converter: Optional[callable] = None, validator: Optional[callable] = None, **kwargs)[source]

Define a sensitivity attribute under the model.

A sensitivity attribute is a frozen attribute with a default value that is passed on instantiation of the model.

Parameters

  • default (Any) – The default value of the sensitivity.

  • 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.

  • converter (Optional[callable]) – Optional callable that is used to convert value to desired format.

  • validator (Optional[callable]) – Optional callaable that is used to validate value.

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

footings.model.def_parameter footings.model.def_meta