EventsToSidecarSummary¶

class EventsToSidecarSummary(sum_op)[source]: Manager for events to sidecar generation.

Methods

`EventsToSidecarSummary.__init__`(sum_op)	Constructor for events to sidecar manager.
`EventsToSidecarSummary.dump_summary`(...)
`EventsToSidecarSummary.get_details_dict`(...)	Return the summary-specific information.
`EventsToSidecarSummary.get_individual`(...[, ...])	Return a dictionary of the individual file summaries.
`EventsToSidecarSummary.get_summary`([...])	Return a summary dictionary with the information.
`EventsToSidecarSummary.get_summary_details`([...])	Return a dictionary with the details for individual files and the overall dataset.
`EventsToSidecarSummary.get_text_summary`([...])	Return a complete text summary by assembling the individual pieces.
`EventsToSidecarSummary.get_text_summary_details`([...])	Return a text summary of the information represented by this summary.
`EventsToSidecarSummary.merge_all_info`()	Merge summary information from all the files.
`EventsToSidecarSummary.save`(save_dir[, ...])	Save the summaries using the format indicated.
`EventsToSidecarSummary.save_visualizations`(...)	Save summary visualizations, if any, using the format indicated.
`EventsToSidecarSummary.update_summary`(new_info)	Update the summary for a given tabular input file.
`EventsToSidecarSummary.validate_input_data`(...)

Attributes

`EventsToSidecarSummary.DISPLAY_INDENT`
`EventsToSidecarSummary.INDIVIDUAL_SUMMARIES_PATH`

EventsToSidecarSummary.__init__(sum_op)[source]¶

Constructor for events to sidecar manager.

Parameters:: sum_op (BaseOp) – Operation associated with this summary.

static EventsToSidecarSummary.dump_summary(filename, summary)¶

EventsToSidecarSummary.get_details_dict(summary_info)[source]¶

Return the summary-specific information.

Parameters:: summary_info (TabularSummary) – Summary to return info from.
Returns:: Standardized details dictionary extracted from the summary information.
Return type:: dict

Notes

Abstract method be implemented by each individual context summary.

EventsToSidecarSummary.get_individual(summary_details, separately=True)¶

Return a dictionary of the individual file summaries.

Parameters:

summary_details (dict) – Dictionary of the individual file summaries.
separately (bool) – If True (the default), each individual summary has a header for separate output.

EventsToSidecarSummary.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.

EventsToSidecarSummary.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 functions to support this.

EventsToSidecarSummary.get_text_summary(individual_summaries='separate')¶

Return a complete text summary by assembling the individual pieces.

Parameters:: individual_summaries (str) – One of the values “separate”, “consolidated”, or “none”.
Returns:: Complete text summary.
Return type:: str

Notes: The options are:

“none”: Just has “Dataset” key.
“consolidated” Has “Dataset” and “Individual files” keys with the values of each is a string.
“separate” Has “Dataset” and “Individual files” keys. The values of “Individual files” is a dict.

EventsToSidecarSummary.get_text_summary_details(include_individual=True)¶

Return a text summary of the information represented by this summary.

Parameters:: include_individual (bool) – If True (the default), individual summaries are in “Individual files”.

EventsToSidecarSummary.merge_all_info()[source]¶

Merge summary information from all the files.

Returns:: Consolidated summary of information.
Return type:: TabularSummary

EventsToSidecarSummary.save(save_dir, file_formats=['.txt'], individual_summaries='separate', task_name='')¶

Save the summaries using the format indicated.

Parameters:

save_dir (str) – Name of the directory to save the summaries in.
file_formats (list) – List of file formats to use for saving.
individual_summaries (str) – Save one file or multiple files based on setting.
task_name (str) – If this summary corresponds to files from a task, the task_name is used in filename.

EventsToSidecarSummary.save_visualizations(save_dir, file_formats=['.svg'], individual_summaries='separate', task_name='')¶

Save summary visualizations, if any, using the format indicated.

Parameters:

save_dir (str) – Name of the directory to save the summaries in.
file_formats (list) – List of file formats to use for saving.
individual_summaries (str) – Save one file or multiple files based on setting.
task_name (str) – If this summary corresponds to files from a task, the task_name is used in filename.

EventsToSidecarSummary.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 needs a “name” str and a “df”.

static EventsToSidecarSummary.validate_input_data(parameters)[source]¶

EventsToSidecarSummary.DISPLAY_INDENT = ' '¶

EventsToSidecarSummary.INDIVIDUAL_SUMMARIES_PATH = 'individual_summaries'¶