Order Column Profile

Index profile analysis for individual col within structured profiling.

class dataprofiler.profilers.order_column_profile.OrderColumn(name: Optional[str], options: Optional[dataprofiler.profilers.profiler_options.OrderOptions] = None)

Bases: dataprofiler.profilers.base_column_profilers.BaseColumnProfiler

Index column profile subclass of BaseColumnProfiler.

Represents a column in the dataset which is an index column.

Initialize column base properties and self.

Parameters

• name (String) – Name of the data

• options (OrderOptions) – Options for the Order column

type = 'order'

report(remove_disabled_flag: bool = False) → Dict

Private abstract method for returning report.

Parameters

remove_disabled_flag (boolean) – flag to determine if disabled options should be excluded in the report.

property profile: Dict

Property for profile. Returns the profile of the column.

Returns

diff(other_profile: dataprofiler.profilers.order_column_profile.OrderColumn, options: Optional[Dict] = None) → Dict

Generate the differences between the orders of two OrderColumns.

Returns

Dict containing the differences between orders in their

appropriate output formats :rtype: dict

update(df_series: pandas.core.series.Series) → dataprofiler.profilers.order_column_profile.OrderColumn

Update the column profile.

Parameters

df_series (pandas.core.series.Series) – df series

Returns

updated OrderColumn

Return type

OrderColumn

col_type = None

name: Optional[str]

sample_size: int

metadata: Dict

times: Dict

thread_safe: bool