dispel.docutils module#

Utility functions for measure definition documentation.

dispel.docutils.convert_measure_value_definition_to_dict(step, definition)[source]#

Convert a measure value definition into a dictionary representation.

Parameters:

step (ProcessingStep) – The processing step that produced the definition.
definition (ValueDefinition) – The definition to be converted

Returns:

A dictionary representation of the definition. Note that if the validator is a range validator it will populate the values_min and values_max attributes based on the lower and upper bound, respectively. All other attributes of the object are mapped one-to-one.

Return type:

Dict[str, Optional[str]]

dispel.docutils.get_measure_value_definitions_data_frame()[source]#

Get a data frame of all available measures in the library.

Returns:: A data frame containing all measure value definitions. See also measure_value_definitions_to_data_frame().
Return type:: pandas.DataFrame

dispel.docutils.measure_value_definitions_to_data_frame(definitions)[source]#

Convert a list of measure value definitions into a data frame.

Parameters:: definitions (Iterable[Tuple[MeasureDefinitionMixin, ValueDefinition]]) – A list of tuples of processing steps and the produced measure value definitions to be converted into a data frame representation.
Returns:: The definitions as data frame. See also convert_measure_value_definition_to_dict() on the specific columns provided.
Return type:: pandas.DataFrame