ska_sdp_piper.extensions.common module

class ska_sdp_piper.extensions.common.ConfigTableRow(name, _type, default, description, nullable, allowed_values)[source]

Bases: object

A helper class to hold values of each row of the configuration table generated by piper's sphinx extensions. Each value corresponds to the columns as listed in "HEADERS" constant..

name: str

default: str

description: str

nullable: str

allowed_values: str

ska_sdp_piper.extensions.common.HEADER_ROW = ConfigTableRow(name='Name', _type='Type', default='Default', description='Description', nullable='Nullable', allowed_values='Allowed Values'): Defines the header row for the configuration table

ska_sdp_piper.extensions.common.dataclass_to_list(dclass_object)[source]

Return a list containing all the field's values of a dataclass object. The order is same as the order defined in dataclass.

Return type:: list