performance_report.utils module

class performance_report.utils.DatasetConfig(name: str = 'default_dataset', theme: ~performance_report.utils.ThemeConfig = <performance_report.utils.ThemeConfig object>, experiments: [<class 'performance_report.utils.ExperimentConfig'>] = [<performance_report.utils.ExperimentConfig object>], headers: [(<class 'str'>, <class 'dict'>)] = ['default_experiment', {}], dataframe: pandas.DataFrame = pandas.DataFrame)

Bases: object

class performance_report.utils.ExperimentConfig(com_mean: str = 'rclcpp-single-threaded-executor', process_configuration: str = 'INTRA_PROCESS', execution_strategy: str = 'INTER_THREAD', sample_transport: str = 'BY_COPY', msg: str = 'Array1k', pubs: int = 1, subs: int = 1, rate: int = 100, reliability: RELIABILITY = RELIABILITY.RELIABLE, durability: DURABILITY = DURABILITY.VOLATILE, history: HISTORY = HISTORY.KEEP_LAST, history_depth: int = 16, rt_prio: int = 0, rt_cpus: int = 0, prevent_cpu_idle: bool = False, max_runtime: int = 30, ignore_seconds: int = 5)

Bases: object

as_dataframe() → pandas.DataFrame

cli_args(output_dir) → list

cli_commands(perf_test_exe_cmd, output_dir) → list

get_members() → list

log_file_name() → str

log_file_name_intra() → str

log_file_name_pub() → str

log_file_name_sub() → str

write_log_file_name(com_mean_suffix: str) → str

class performance_report.utils.FileContents(header: dict, dataframe: pandas.DataFrame)

Bases: object

class performance_report.utils.LineConfig(style: str = 'solid', width: int = 2, alpha: float = 1.0)

Bases: object

class performance_report.utils.MarkerConfig(shape: str = 'dot', size: int = 25, alpha: float = 1.0)

Bases: object

class performance_report.utils.PerfArgParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

Bases: ArgumentParser

error(message: string)

Prints a usage message incorporating the message to stderr and exits.

If you override this in a subclass, it should not return – it should either exit or raise an exception.

exit(status=0, message=None)

init_args()

class performance_report.utils.ThemeConfig(color: str = '#0000ff', marker: ~performance_report.utils.MarkerConfig = <performance_report.utils.MarkerConfig object>, line: ~performance_report.utils.LineConfig = <performance_report.utils.LineConfig object>)

Bases: object

class performance_report.utils.cliColors

Bases: object

ENDCOLOR = '\x1b[0m'

ERROR = '\x1b[91m'

ESCAPE = '\x1b'

GREEN = '\x1b[92m'

WARN = '\x1b[93m'

performance_report.utils.colorPrint(raw_string, color_type)

performance_report.utils.colorString(raw_string, color_type) → str

performance_report.utils.create_dir(dir_path) → bool