benchbuild.cli.run module

benchbuild’s run command.

This subcommand executes experiments on a set of user-controlled projects. See the output of benchbuild run –help for more information.

class benchbuild.cli.run.BenchBuildRun(executable)

Bases: plumbum.cli.application.Application

Frontend for running experiments in the benchbuild study framework.

experiment_names = []

group_names = None

main(*projects)

Main entry point of benchbuild run.

pretend

Sets an attribute

set_experiment_tag(description)

set_experiments(names)

set_group(groups)

static setup_progress(cfg, num_actions)

Setup a progress bar.

Parameters:

• cfg – Configuration dictionary.
• num_actions (int) – Number of actions in the plan.

Returns:

The configured progress bar.

show_progress

Sets an attribute

test_full

Sets an attribute

benchbuild.cli.run.execute_plan(plan)

“Execute the plan.

Parameters:plan (list of actions.Step) – The plan we want to execute. Returns:A list of failed actions. Return type:(list of actions.Step)

benchbuild.cli.run.print_summary(num_actions, failed, duration)

Print a small summary of the executed plan.

Parameters:

• num_actions (int) – Total size of the executed plan.
• failed (list of actions.Step) – List of failed actions.
• duration – Time we spent executing the plan.