ColumnNamesSummary¶
- class ColumnNamesSummary(sum_op)[source]
Methods
Attributes
|
|
- static ColumnNamesSummary.dump_summary(filename, summary)¶
- ColumnNamesSummary.get_details_dict(column_summary)[source]¶
Return the summary dictionary extracted from a ColumnNameSummary.
- Parameters:
column_summary (ColumnNameSummary) – A column name summary for the data file.
- Returns:
dict - a dictionary with the summary information for column names.
- ColumnNamesSummary.get_individual(summary_details, separately=True)¶
- ColumnNamesSummary.get_summary(individual_summaries='separate')¶
Return a summary dictionary with the information.
- Parameters:
individual_summaries (str) – “separate”, “consolidated”, or “none”
- Returns:
dict - dictionary with “Dataset” and “Individual files” keys.
- Notes: The individual_summaries value is processed as follows
“separate” individual summaries are to be in separate files
“consolidated” means that the individual summaries are in same file as overall summary
“none” means that only the overall summary is produced.
- ColumnNamesSummary.get_summary_details(include_individual=True)¶
Return a dictionary with the details for individual files and the overall dataset.
- Parameters:
include_individual (bool) – If True, summaries for individual files are included.
- Returns:
dict - a dictionary with ‘Dataset’ and ‘Individual files’ keys.
Notes
The ‘Dataset’ value is either a string or a dictionary with the overall summary.
- The ‘Individual files’ value is dictionary whose keys are file names and values are
their corresponding summaries.
Users are expected to provide merge_all_info and get_details_dict to support this.
- ColumnNamesSummary.get_text_summary(individual_summaries='separate')¶
- ColumnNamesSummary.get_text_summary_details(include_individual=True)¶
- ColumnNamesSummary.merge_all_info()[source]¶
Create a ColumnNameSummary containing the overall dataset summary.
- Returns:
ColumnNameSummary - the overall summary object for column names.
- ColumnNamesSummary.save(save_dir, file_formats=['.txt'], individual_summaries='separate', task_name='')¶
- ColumnNamesSummary.update_summary(new_info)[source]¶
Update the summary for a given tabular input file.
- Parameters:
new_info (dict) – A dictionary with the parameters needed to update a summary.
Notes
The summary information is kept in separate ColumnNameSummary objects for each file.
The summary needs a “name” str and a “column_names” list.
The summary uses ColumnNameSummary as the summary object.
- ColumnNamesSummary.DISPLAY_INDENT = ' '¶
- ColumnNamesSummary.INDIVIDUAL_SUMMARIES_PATH = 'individual_summaries'¶