Compare commits

...
Author SHA1 Message Date
David Peter 8cf4e010e9 Truncate export files before rewriting results 2026-10-05 12:48:52 +02:00
David Peter 30a2b61d4c Merge pull request #807 from willcl-ark/expose-run-var
expose HYPERFINE_ITERATION to intermediate commands
2026-10-05 12:45:29 +02:00
David Peter 05de077d8e Merge pull request #968 from sharkdp/codex/parameter-metadata
Store parameter usage metadata in benchmark results
2026-10-05 12:40:06 +02:00
David Peter 8c40de45f8 Store parameter usage metadata in benchmark results 2026-10-05 12:35:24 +02:00
4 changed files with 55 additions and 9 deletions

No files matched your search

+10 -1
View File
@@ -2,6 +2,15 @@ use std::collections::BTreeMap;
use serde::Serialize;
/// Parameter value and whether it was used in the command line template
#[derive(Debug, Default, Clone, Serialize, PartialEq)]
#[serde(transparent)]
pub struct Parameter {
pub value: String,
#[serde(skip)]
pub is_unused: bool,
}
/// Set of values that will be exported.
// NOTE: `serde` is used for JSON serialization, but not for CSV serialization due to the
// `parameters` map. Update `src/hyperfine/export/csv.rs` with new fields, as appropriate.
@@ -49,5 +58,5 @@ pub struct BenchmarkResult {
/// Parameter values for this benchmark
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub parameters: BTreeMap<String, String>,
pub parameters: BTreeMap<String, Parameter>,
}
+10 -2
View File
@@ -19,7 +19,7 @@ use crate::output::warnings::{OutlierWarningOptions, Warnings};
use crate::parameter::ParameterNameAndValue;
use crate::quantity::{byte, const_time_from_seconds, ratio, second, FormatQuantity, Time, Zero};
use crate::util::exit_code::extract_exit_code;
use benchmark_result::BenchmarkResult;
use benchmark_result::{BenchmarkResult, Parameter};
use measurement::{Measurement, Measurements};
use anyhow::{anyhow, Result};
@@ -494,7 +494,15 @@ impl<'a> Benchmark<'a> {
.command
.get_parameters()
.iter()
.map(|(name, value)| (name.to_string(), value.to_string()))
.map(|(name, value)| {
(
name.to_string(),
Parameter {
value: value.to_string(),
is_unused: self.command.is_parameter_unused(name),
},
)
})
.collect(),
})
}
+30 -5
View File
@@ -53,7 +53,7 @@ impl Exporter for CsvExporter {
fields.push(Cow::Owned(format!("{f:.CSV_PRECISION$}").into_bytes()))
}
for v in res.parameters.values() {
fields.push(Cow::Borrowed(v.as_bytes()))
fields.push(Cow::Borrowed(v.value.as_bytes()))
}
writer.write_record(fields)?;
}
@@ -64,6 +64,7 @@ impl Exporter for CsvExporter {
#[test]
fn test_csv() {
use crate::benchmark::benchmark_result::Parameter;
use std::collections::BTreeMap;
let exporter = CsvExporter::default();
@@ -83,8 +84,20 @@ fn test_csv() {
exit_codes: vec![Some(0), Some(0), Some(0)],
parameters: {
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
params.insert("bar".into(), "two".into());
params.insert(
"foo".into(),
Parameter {
value: "one".into(),
is_unused: false,
},
);
params.insert(
"bar".into(),
Parameter {
value: "two".into(),
is_unused: false,
},
);
params
},
},
@@ -103,8 +116,20 @@ fn test_csv() {
exit_codes: vec![Some(0), Some(0), Some(0)],
parameters: {
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
params.insert("bar".into(), "seven".into());
params.insert(
"foo".into(),
Parameter {
value: "one".into(),
is_unused: false,
},
);
params.insert(
"bar".into(),
Parameter {
value: "seven".into(),
is_unused: false,
},
);
params
},
},
+5 -1
View File
@@ -158,7 +158,11 @@ impl ExportManager {
/// Write the given content to a file with the specified name
fn write_to_file(filename: &str, content: &[u8]) -> Result<()> {
let mut file = OpenOptions::new().write(true).open(filename)?;
let mut file = OpenOptions::new()
.write(true)
// Avoid leaving trailing bytes when the new export is shorter.
.truncate(true)
.open(filename)?;
file.write_all(content)
.with_context(|| format!("Failed to export results to '{filename}'"))
}