Compare commits

..
Author SHA1 Message Date
David Peter 34aed32655 Dependency and MSRV update 2026-10-02 11:01:17 +02:00
9 changed files with 45 additions and 125 deletions

No files matched your search

-1
View File
@@ -79,7 +79,6 @@ jobs:
matrix: matrix:
job: job:
- { target: aarch64-unknown-linux-gnu , os: ubuntu-24.04, use-cross: true } - { target: aarch64-unknown-linux-gnu , os: ubuntu-24.04, use-cross: true }
- { target: aarch64-unknown-linux-musl , os: ubuntu-24.04, use-cross: true }
- { target: arm-unknown-linux-gnueabihf , os: ubuntu-24.04, use-cross: true } - { target: arm-unknown-linux-gnueabihf , os: ubuntu-24.04, use-cross: true }
- { target: arm-unknown-linux-musleabihf, os: ubuntu-24.04, use-cross: true } - { target: arm-unknown-linux-musleabihf, os: ubuntu-24.04, use-cross: true }
- { target: i686-pc-windows-msvc , os: windows-2022 } - { target: i686-pc-windows-msvc , os: windows-2022 }
+15 -6
View File
@@ -4,14 +4,23 @@ This folder contains scripts that can be used in combination with hyperfines `--
```bash ```bash
hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json
uv run plot_whisker.py sleep.json ./plot_whisker.py sleep.json
``` ```
### Pre-requisites ### Pre-requisites
Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and run the To make these scripts work, you will need `numpy`, `matplotlib` and `scipy`.
commands above from this directory.
The scripts declare their dependencies using [PEP 723](https://peps.python.org/pep-0723/) If you have a Python package manager that understands [PEP-723](https://peps.python.org/pep-0723/)
inline script metadata. `uv run` automatically installs these dependencies in an inline script requirements like [`uv`](https://github.com/astral-sh/uv) or [`pipx`](https://github.com/pypa/pipx),
isolated environment before running the script. you can directly run the scripts using
```bash
uv run plot_whisker.py sleep.json
```
Otherwise, install the dependencies via your system package manager or using `pip`:
```bash
pip install numpy matplotlib scipy # pip3, if you are using python3
```
+11 -19
View File
@@ -5,7 +5,6 @@ pub mod scheduler;
pub mod timing_result; pub mod timing_result;
use std::cmp; use std::cmp;
use std::io::{self, Write};
use crate::benchmark::executor::BenchmarkIteration; use crate::benchmark::executor::BenchmarkIteration;
use crate::command::Command; use crate::command::Command;
@@ -13,7 +12,6 @@ use crate::options::{
CmdFailureAction, CommandOutputPolicy, ExecutorKind, Options, OutputStyleOption, CmdFailureAction, CommandOutputPolicy, ExecutorKind, Options, OutputStyleOption,
}; };
use crate::outlier_detection::{modified_zscores, OUTLIER_THRESHOLD}; use crate::outlier_detection::{modified_zscores, OUTLIER_THRESHOLD};
use crate::output::console_writeln;
use crate::output::format::{format_duration, format_duration_unit}; use crate::output::format::{format_duration, format_duration_unit};
use crate::output::progress_bar::get_progress_bar; use crate::output::progress_bar::get_progress_bar;
use crate::output::warnings::{OutlierWarningOptions, Warnings}; use crate::output::warnings::{OutlierWarningOptions, Warnings};
@@ -142,13 +140,12 @@ impl<'a> Benchmark<'a> {
/// Run the benchmark for a single command /// Run the benchmark for a single command
pub fn run(&self) -> Result<BenchmarkResult> { pub fn run(&self) -> Result<BenchmarkResult> {
if self.options.output_style != OutputStyleOption::Disabled { if self.options.output_style != OutputStyleOption::Disabled {
console_writeln!( println!(
io::stdout(),
"{}{}: {}", "{}{}: {}",
"Benchmark ".bold(), "Benchmark ".bold(),
(self.number + 1).to_string().bold(), (self.number + 1).to_string().bold(),
self.command.get_name_with_unused_parameters(), self.command.get_name_with_unused_parameters(),
)?; );
} }
let mut times_real: Vec<Second> = vec![]; let mut times_real: Vec<Second> = vec![];
@@ -361,22 +358,19 @@ impl<'a> Benchmark<'a> {
let system_str = format_duration(system_mean, Some(time_unit)); let system_str = format_duration(system_mean, Some(time_unit));
if self.options.output_style != OutputStyleOption::Disabled { if self.options.output_style != OutputStyleOption::Disabled {
let mut stdout = io::stdout().lock();
if times_real.len() == 1 { if times_real.len() == 1 {
console_writeln!( println!(
stdout,
" Time ({} ≡): {:>8} {:>8} [User: {}, System: {}]", " Time ({} ≡): {:>8} {:>8} [User: {}, System: {}]",
"abs".green().bold(), "abs".green().bold(),
mean_str.green().bold(), mean_str.green().bold(),
" ", // alignment " ", // alignment
user_str.blue(), user_str.blue(),
system_str.blue() system_str.blue()
)?; );
} else { } else {
let stddev_str = format_duration(t_stddev.unwrap(), Some(time_unit)); let stddev_str = format_duration(t_stddev.unwrap(), Some(time_unit));
console_writeln!( println!(
stdout,
" Time ({} ± {}): {:>8} ± {:>8} [User: {}, System: {}]", " Time ({} ± {}): {:>8} ± {:>8} [User: {}, System: {}]",
"mean".green().bold(), "mean".green().bold(),
"σ".green(), "σ".green(),
@@ -384,17 +378,16 @@ impl<'a> Benchmark<'a> {
stddev_str.green(), stddev_str.green(),
user_str.blue(), user_str.blue(),
system_str.blue() system_str.blue()
)?; );
console_writeln!( println!(
stdout,
" Range ({} … {}): {:>8} … {:>8} {}", " Range ({} … {}): {:>8} … {:>8} {}",
"min".cyan(), "min".cyan(),
"max".purple(), "max".purple(),
min_str.cyan(), min_str.cyan(),
max_str.purple(), max_str.purple(),
num_str.dimmed() num_str.dimmed()
)?; );
} }
} }
@@ -437,16 +430,15 @@ impl<'a> Benchmark<'a> {
} }
if !warnings.is_empty() { if !warnings.is_empty() {
let mut stderr = io::stderr().lock(); eprintln!(" ");
console_writeln!(stderr, " ")?;
for warning in &warnings { for warning in &warnings {
console_writeln!(stderr, " {}: {}", "Warning".yellow(), warning)?; eprintln!(" {}: {}", "Warning".yellow(), warning);
} }
} }
if self.options.output_style != OutputStyleOption::Disabled { if self.options.output_style != OutputStyleOption::Disabled {
console_writeln!(io::stdout(), " ")?; println!(" ");
} }
self.run_cleanup_command(self.command.get_parameters().iter().cloned(), output_policy)?; self.run_cleanup_command(self.command.get_parameters().iter().cloned(), output_policy)?;
+13 -22
View File
@@ -3,12 +3,10 @@ use super::executor::{Executor, MockExecutor, RawExecutor, ShellExecutor};
use super::{relative_speed, Benchmark}; use super::{relative_speed, Benchmark};
use colored::*; use colored::*;
use std::cmp::Ordering; use std::cmp::Ordering;
use std::io::{self, Write};
use crate::command::{Command, Commands}; use crate::command::{Command, Commands};
use crate::export::ExportManager; use crate::export::ExportManager;
use crate::options::{ExecutorKind, Options, OutputStyleOption, SortOrder}; use crate::options::{ExecutorKind, Options, OutputStyleOption, SortOrder};
use crate::output::console_writeln;
use anyhow::Result; use anyhow::Result;
@@ -60,13 +58,13 @@ impl<'a> Scheduler<'a> {
Ok(()) Ok(())
} }
pub fn print_relative_speed_comparison(&self) -> Result<()> { pub fn print_relative_speed_comparison(&self) {
if self.options.output_style == OutputStyleOption::Disabled { if self.options.output_style == OutputStyleOption::Disabled {
return Ok(()); return;
} }
if self.results.len() < 2 { if self.results.len() < 2 {
return Ok(()); return;
} }
let reference = self let reference = self
@@ -81,19 +79,17 @@ impl<'a> Scheduler<'a> {
reference, reference,
self.options.sort_order_speed_comparison, self.options.sort_order_speed_comparison,
) { ) {
let mut stdout = io::stdout().lock();
match self.options.sort_order_speed_comparison { match self.options.sort_order_speed_comparison {
SortOrder::MeanTime => { SortOrder::MeanTime => {
console_writeln!(stdout, "{}", "Summary".bold())?; println!("{}", "Summary".bold());
let reference = annotated_results.iter().find(|r| r.is_reference).unwrap(); let reference = annotated_results.iter().find(|r| r.is_reference).unwrap();
let others = annotated_results.iter().filter(|r| !r.is_reference); let others = annotated_results.iter().filter(|r| !r.is_reference);
console_writeln!( println!(
stdout,
" {} ran", " {} ran",
reference.result.command_with_unused_parameters.cyan() reference.result.command_with_unused_parameters.cyan()
)?; );
for item in others { for item in others {
let stddev = if let Some(stddev) = item.relative_speed_stddev { let stddev = if let Some(stddev) = item.relative_speed_stddev {
@@ -118,20 +114,18 @@ impl<'a> Scheduler<'a> {
stddev stddev
), ),
}; };
console_writeln!( println!(
stdout,
"{} {}", "{} {}",
comparator, comparator,
item.result.command_with_unused_parameters.magenta() item.result.command_with_unused_parameters.magenta()
)?; );
} }
} }
SortOrder::Command => { SortOrder::Command => {
console_writeln!(stdout, "{}", "Relative speed comparison".bold())?; println!("{}", "Relative speed comparison".bold());
for item in annotated_results { for item in annotated_results {
console_writeln!( println!(
stdout,
" {}{} {}", " {}{} {}",
format!("{:10.2}", item.relative_speed).bold().green(), format!("{:10.2}", item.relative_speed).bold().green(),
if item.is_reference { if item.is_reference {
@@ -142,13 +136,12 @@ impl<'a> Scheduler<'a> {
" ".into() " ".into()
}, },
item.result.command_with_unused_parameters, item.result.command_with_unused_parameters,
)?; );
} }
} }
} }
} else { } else {
console_writeln!( eprintln!(
io::stderr(),
"{}: The benchmark comparison could not be computed as some benchmark times are zero. \ "{}: The benchmark comparison could not be computed as some benchmark times are zero. \
This could be caused by background interference during the initial calibration phase \ This could be caused by background interference during the initial calibration phase \
of hyperfine, in combination with very fast commands (faster than a few milliseconds). \ of hyperfine, in combination with very fast commands (faster than a few milliseconds). \
@@ -156,10 +149,8 @@ impl<'a> Scheduler<'a> {
--shell=none/-N option. If it does not help either, you command is most likely too fast \ --shell=none/-N option. If it does not help either, you command is most likely too fast \
to be accurately benchmarked by hyperfine.", to be accurately benchmarked by hyperfine.",
"Note".bold().red() "Note".bold().red()
)?; );
} }
Ok(())
} }
pub fn final_export(&self) -> Result<()> { pub fn final_export(&self) -> Result<()> {
-4
View File
@@ -3,10 +3,6 @@ use std::num::{self, ParseFloatError, ParseIntError};
use rust_decimal::Error as DecimalError; use rust_decimal::Error as DecimalError;
use thiserror::Error; use thiserror::Error;
#[derive(Debug, Error)]
#[error(transparent)]
pub struct ConsoleOutputError(pub std::io::Error);
#[derive(Debug, Error)] #[derive(Debug, Error)]
pub enum ParameterScanError { pub enum ParameterScanError {
#[error("Error while parsing parameter scan arguments ({0})")] #[error("Error while parsing parameter scan arguments ({0})")]
+3 -5
View File
@@ -1,5 +1,5 @@
use std::fs::{File, OpenOptions}; use std::fs::{File, OpenOptions};
use std::io::{self, Write}; use std::io::Write;
mod asciidoc; mod asciidoc;
mod csv; mod csv;
@@ -18,7 +18,6 @@ use self::orgmode::OrgmodeExporter;
use crate::benchmark::benchmark_result::BenchmarkResult; use crate::benchmark::benchmark_result::BenchmarkResult;
use crate::options::SortOrder; use crate::options::SortOrder;
use crate::output::console_writeln;
use crate::util::units::Unit; use crate::util::units::Unit;
use anyhow::{Context, Result}; use anyhow::{Context, Result};
@@ -145,9 +144,8 @@ impl ExportManager {
} }
ExportTarget::Stdout => { ExportTarget::Stdout => {
if !intermediate { if !intermediate {
let mut stdout = io::stdout().lock(); println!();
console_writeln!(stdout)?; println!("{}", String::from_utf8(content()?).unwrap());
console_writeln!(stdout, "{}", String::from_utf8(content()?).unwrap())?;
} }
} }
} }
+2 -16
View File
@@ -4,12 +4,10 @@
)] )]
use std::env; use std::env;
use std::io::{self, Write};
use benchmark::scheduler::Scheduler; use benchmark::scheduler::Scheduler;
use cli::get_cli_arguments; use cli::get_cli_arguments;
use command::Commands; use command::Commands;
use error::ConsoleOutputError;
use export::ExportManager; use export::ExportManager;
use options::Options; use options::Options;
@@ -46,29 +44,17 @@ fn run() -> Result<()> {
let mut scheduler = Scheduler::new(&commands, &options, &export_manager); let mut scheduler = Scheduler::new(&commands, &options, &export_manager);
scheduler.run_benchmarks()?; scheduler.run_benchmarks()?;
scheduler.print_relative_speed_comparison()?; scheduler.print_relative_speed_comparison();
scheduler.final_export()?; scheduler.final_export()?;
Ok(()) Ok(())
} }
fn caused_by_broken_console_pipe(error: &anyhow::Error) -> bool {
error
.downcast_ref::<ConsoleOutputError>()
.is_some_and(|e| e.0.kind() == io::ErrorKind::BrokenPipe)
}
fn main() { fn main() {
match run() { match run() {
Ok(_) => {} Ok(_) => {}
Err(e) => { Err(e) => {
// Exit quietly when a reader stops consuming console output early. eprintln!("{} {:#}", "Error:".red(), e);
if caused_by_broken_console_pipe(&e) {
std::process::exit(0);
}
// The write to stderr can itself fail if stderr is closed; the
// error message cannot be shown in that case anyway.
let _ = writeln!(io::stderr(), "{} {:#}", "Error:".red(), e);
std::process::exit(1); std::process::exit(1);
} }
} }
-10
View File
@@ -1,13 +1,3 @@
pub mod format; pub mod format;
pub mod progress_bar; pub mod progress_bar;
pub mod warnings; pub mod warnings;
/// Mark console write errors so broken pipes can be handled separately from file errors.
macro_rules! console_writeln {
($writer:expr $(, $($args:tt)*)?) => {
writeln!($writer $(, $($args)*)?)
.map_err($crate::error::ConsoleOutputError)
};
}
pub(crate) use console_writeln;
+1 -42
View File
@@ -1,5 +1,5 @@
mod common; mod common;
use common::{hyperfine, hyperfine_raw_command}; use common::hyperfine;
use predicates::prelude::*; use predicates::prelude::*;
@@ -33,47 +33,6 @@ fn one_run_is_supported() {
.success(); .success();
} }
/// Regression test: hyperfine must not panic when writing to a closed
/// stdout pipe (e.g. `hyperfine ... | head -n 1` or a downstream process
/// that terminates early). A `BrokenPipe` error should result in a quiet
/// exit with code 0 instead of a `println!` panic.
#[test]
fn exits_quietly_when_stdout_is_closed() {
use std::process::Stdio;
for args in [
vec!["--runs=1", "echo dummy benchmark"],
vec!["--runs=1", "--export-json=-", "echo dummy benchmark"],
vec!["--runs=1", "echo dummy benchmark", "echo second benchmark"],
] {
// A pipe whose read end has been closed before hyperfine is even
// started: every write to it will fail with `BrokenPipe`.
let (reader, writer) = std::io::pipe().expect("failed to create pipe");
drop(reader);
let output = hyperfine_raw_command()
.args(&args)
.stdout(writer)
.stderr(Stdio::piped())
.spawn()
.expect("failed to spawn hyperfine")
.wait_with_output()
.expect("failed to wait for hyperfine");
let stderr = String::from_utf8_lossy(&output.stderr);
assert!(
!stderr.contains("panicked"),
"hyperfine panicked while writing to a closed pipe:\n{}",
stderr
);
assert!(
output.status.success(),
"hyperfine did not exit cleanly; stderr:\n{}",
stderr
);
}
}
#[test] #[test]
fn can_run_commands_without_a_shell() { fn can_run_commands_without_a_shell() {
hyperfine() hyperfine()