Lineage Reports API

class ds_capability.components.abstract_common_component.AbstractCommonComponent(property_manager: Any, intent_model: Any, default_save: bool | None = None, reset_templates: bool | None = None, template_path: str | None = None, template_module: str | None = None, template_source_handler: str | None = None, template_persist_handler: str | None = None, align_connectors: bool | None = None)

An abstract common component class that contains the methods shared across all capabilities. This allows all capability instances to share common behavior in initialization, connectivity management, reporting and running the component.

report_connectors(connector_filter: [<class 'str'>, <class 'list'>] = None, inc_pm: bool = None, inc_template: bool = None, stylise: bool = True)

generates a report on the source contract

Parameters:

• connector_filter – (optional) filters on the connector name.

• inc_pm – (optional) include the property manager connector

• inc_template – (optional) include the template connectors

• stylise – (optional) returns a stylised DataFrame with formatting

Returns:

pa.Table

report_environ(stylise: bool = True)

generates a report on all the intent

Parameters:

stylise – returns a stylised dataframe with formatting

Returns:

pa.Table

report_intent(levels: [<class 'str'>, <class 'int'>, <class 'list'>] = None, stylise: bool = True)

generates a report on all the intent

Parameters:

• levels – (optional) a filter on the levels. passing a single value will report a single parameterised view

• stylise – (optional) returns a stylised dataframe with formatting

Returns:

pa.Table

report_intent_description(action: [<class 'str'>, <class 'list'>] = None, stylise: bool = True)

generates a report on the intent action notes

Parameters:

• action – (optional) filters on specific action names.

• stylise – (optional) returns a stylised DataFrame with formatting

Returns:

pa.Table

report_notes(catalog: [<class 'str'>, <class 'list'>] = None, labels: [<class 'str'>, <class 'list'>] = None, regex: [<class 'str'>, <class 'list'>] = None, re_ignore_case: bool = False, stylise: bool = True, drop_dates: bool = False)

generates a report on the notes

Parameters:

• catalog – (optional) the catalog to filter on

• labels – (optional) s label or list of labels to filter on

• regex – (optional) a regular expression on the notes

• re_ignore_case – (optional) if the regular expression should be case-sensitive

• stylise – (optional) returns a stylised dataframe with formatting

• drop_dates – (optional) excludes the ‘date’ column from the report

Returns:

pa.Table

report_run_book(stylise: bool = True)

generates a report on all the intent

Parameters:

stylise – returns a stylised dataframe with formatting

Returns:

pa.Table

report_task(stylise: bool = True)

generates a report on the source contract

Parameters:

stylise – (optional) returns a stylised DataFrame with formatting

Returns:

pa.Table

class ds_capability.components.feature_select.FeatureSelect(property_manager: Any, intent_model: Any, default_save: bool | None = None, reset_templates: bool | None = None, template_path: str | None = None, template_module: str | None = None, template_source_handler: str | None = None, template_persist_handler: str | None = None, align_connectors: bool | None = None)

report_provenance(as_dict: bool | None = None, stylise: bool | None = None)

a report on the provenance set as part of the domain contract

Parameters:

• as_dict – (optional) if the result should be a dictionary. Default is False

• stylise – (optional) if as_dict is False, if the return dataFrame should be stylised

Returns: