Compare commits

...

5 Commits

Author SHA1 Message Date
Jooris Hadeler
d534689675
Merge 02975df2ad into 824aafbd69 2024-07-11 09:16:05 -04:00
Antonin Décimo
824aafbd69 Fix typos README.md 2024-07-09 10:31:45 +02:00
Jooris Hadeler
02975df2ad Move -E, --show-elapsed flag to a more sensible position. 2023-11-20 19:40:04 +01:00
Jooris Hadeler
c83b4126ea Reset elapsed every time the progress bar is increased. 2023-11-20 19:39:31 +01:00
Jooris Hadeler
4e8cb3fec0 Add a --show-elapsed flag to optionally enable a the elapsed time counter. 2023-11-20 18:49:44 +01:00
6 changed files with 44 additions and 8 deletions

View File

@ -213,14 +213,14 @@ pacman -S hyperfine
### On Debian Linux
On Debian Linux, hyperfine can be installed [from the testing repositories](https://packages.debian.org/testing/main/hyperfine)
On Debian Linux, hyperfine can be installed [from the testing repositories](https://packages.debian.org/testing/main/hyperfine):
```
apt install hyperfine
```
### On Exherbo Linux
On Exherbo Linux, hyperfine can be installed [from the rust repositories]([https://packages.debian.org/testing/main/hyperfine](https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/sys-apps/hyperfine)
On Exherbo Linux, hyperfine can be installed [from the rust repositories](https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/sys-apps/hyperfine):
```
cave resolve -x repository/rust
cave resolve -x hyperfine

View File

@ -180,6 +180,7 @@ impl<'a> Executor for ShellExecutor<'a> {
COUNT,
"Measuring shell spawning time",
self.options.output_style,
self.options.show_elapsed,
))
} else {
None
@ -214,7 +215,8 @@ impl<'a> Executor for ShellExecutor<'a> {
}
if let Some(bar) = progress_bar.as_ref() {
bar.inc(1)
bar.inc(1);
bar.reset_elapsed();
}
}

View File

@ -182,6 +182,7 @@ impl<'a> Benchmark<'a> {
self.options.warmup_count,
"Performing warmup runs",
self.options.output_style,
self.options.show_elapsed,
))
} else {
None
@ -192,7 +193,8 @@ impl<'a> Benchmark<'a> {
let _ = self.executor.run_command_and_measure(self.command, None)?;
let _ = run_conclusion_command()?;
if let Some(bar) = progress_bar.as_ref() {
bar.inc(1)
bar.inc(1);
bar.reset_elapsed();
}
}
if let Some(bar) = progress_bar.as_ref() {
@ -206,6 +208,7 @@ impl<'a> Benchmark<'a> {
self.options.run_bounds.min,
"Initial time measurement",
self.options.output_style,
self.options.show_elapsed,
))
} else {
None
@ -256,7 +259,8 @@ impl<'a> Benchmark<'a> {
bar.set_length(count)
}
if let Some(bar) = progress_bar.as_ref() {
bar.inc(1)
bar.inc(1);
bar.reset_elapsed();
}
// Gather statistics (perform the actual benchmark)
@ -283,7 +287,8 @@ impl<'a> Benchmark<'a> {
all_succeeded = all_succeeded && success;
if let Some(bar) = progress_bar.as_ref() {
bar.inc(1)
bar.inc(1);
bar.reset_elapsed();
}
run_conclusion_command()?;

View File

@ -254,6 +254,17 @@ fn build_command() -> Command {
* 'mean-time': order benchmarks by mean runtime\n"
),
)
.arg(
Arg::new("show-elapsed")
.long("show-elapsed")
.short('E')
.action(ArgAction::SetTrue)
.help(
"Show time elapsed since the current run was started. \
This is useful for especially long benchmarks to see \
the progress the benchmark has made"
)
)
.arg(
Arg::new("time-unit")
.long("time-unit")

View File

@ -239,6 +239,9 @@ pub struct Options {
/// Which time unit to use when displaying results
pub time_unit: Option<Unit>,
/// Show elapsed time since current run start.
pub show_elapsed: bool,
}
impl Default for Options {
@ -260,6 +263,7 @@ impl Default for Options {
command_output_policy: CommandOutputPolicy::Null,
time_unit: None,
command_input_policy: CommandInputPolicy::Null,
show_elapsed: false,
}
}
}
@ -433,6 +437,10 @@ impl Options {
CommandInputPolicy::Null
};
if matches.get_flag("show-elapsed") {
options.show_elapsed = true;
}
Ok(options)
}

View File

@ -10,12 +10,22 @@ const TICK_SETTINGS: (&str, u64) = ("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ ", 80);
const TICK_SETTINGS: (&str, u64) = (r"+-x| ", 200);
/// Return a pre-configured progress bar
pub fn get_progress_bar(length: u64, msg: &str, option: OutputStyleOption) -> ProgressBar {
pub fn get_progress_bar(
length: u64,
msg: &str,
option: OutputStyleOption,
show_elapsed: bool,
) -> ProgressBar {
let template_str = match show_elapsed {
true => " {spinner} {msg:<30} {wide_bar} ET {elapsed_precise} ETA {eta_precise} ",
false => " {spinner} {msg:<30} {wide_bar} ETA {eta_precise} ",
};
let progressbar_style = match option {
OutputStyleOption::Basic | OutputStyleOption::Color => ProgressStyle::default_bar(),
_ => ProgressStyle::default_spinner()
.tick_chars(TICK_SETTINGS.0)
.template(" {spinner} {msg:<30} {wide_bar} ETA {eta_precise} ")
.template(template_str)
.expect("no template error"),
};