mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-11-14 08:21:39 +00:00
Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d746117b41 | ||
|
|
6cb7bb01d1 | ||
|
|
e8cdbf25b1 | ||
|
|
ce49529780 |
No files matched your search
@@ -1,3 +1,12 @@
|
||||
# v2.0.0-alpha.2
|
||||
|
||||
## Changes
|
||||
|
||||
- Always run `--setup`, `--prepare`, `--conclude`, and `--cleanup` commands in a shell, even when benchmarked commands run directly. Improve error messages for these commands, see #990 (@sharkdp).
|
||||
- Require an explicit shell choice for commands containing unquoted, standalone shell operators such as `&&` or `>`: use `-S` to interpret shell syntax or `-N` to pass operators as literal arguments (@sharkdp).
|
||||
- Use a compact output layout on narrow terminals (@sharkdp).
|
||||
- Make plotting and analysis scripts runnable directly from GitHub with `uvx --from 'git+https://github.com/sharkdp/hyperfine' <script>` (@sharkdp).
|
||||
|
||||
# v2.0.0-alpha.1
|
||||
|
||||
This is the first alpha release of hyperfine 2.0. Command-line options and export formats may change before the stable release. See the breaking changes below when migrating from hyperfine 1.x.
|
||||
|
||||
+2
-2
@@ -13,5 +13,5 @@ authors:
|
||||
repository-code: 'https://github.com/sharkdp/hyperfine'
|
||||
abstract: A command-line benchmarking tool.
|
||||
license: MIT
|
||||
version: 2.0.0-alpha.1
|
||||
date-released: '2026-10-06'
|
||||
version: 2.0.0-alpha.2
|
||||
date-released: '2026-10-07'
|
||||
Generated
+2
-1
@@ -377,7 +377,7 @@ checksum = "15cdd26707701c53297e2fa6afb323d55fbc1d0810c3aec078ae3ef0424c3c15"
|
||||
|
||||
[[package]]
|
||||
name = "hyperfine"
|
||||
version = "2.0.0-alpha.1"
|
||||
version = "2.0.0-alpha.2"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"approx",
|
||||
@@ -402,6 +402,7 @@ dependencies = [
|
||||
"serde_json",
|
||||
"shell-words",
|
||||
"tempfile",
|
||||
"terminal_size",
|
||||
"thiserror",
|
||||
"uom",
|
||||
"windows-sys 0.61.2",
|
||||
|
||||
+2
-1
@@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0"
|
||||
name = "hyperfine"
|
||||
readme = "README.md"
|
||||
repository = "https://github.com/sharkdp/hyperfine"
|
||||
version = "2.0.0-alpha.1"
|
||||
version = "2.0.0-alpha.2"
|
||||
edition = "2018"
|
||||
build = "build.rs"
|
||||
rust-version = "1.97.0"
|
||||
@@ -26,6 +26,7 @@ serde_json = "1.0"
|
||||
rust_decimal = "1.43"
|
||||
rand = "0.10"
|
||||
shell-words = "1.1"
|
||||
terminal_size = "0.4"
|
||||
thiserror = "2.0"
|
||||
anyhow = "1.0"
|
||||
uom = { version = "0.36.0", default-features = false, features = ["std", "si", "f64"] }
|
||||
|
||||
@@ -114,6 +114,10 @@ Shell syntax such as pipes, redirections, environment-variable expansion, `*`, a
|
||||
This avoids shell startup overhead and the noise from correcting for it, especially for fast commands
|
||||
(< 5 ms).
|
||||
|
||||
Commands containing unquoted, standalone shell operators such as `&&` or `>` require an explicit
|
||||
choice: use `-S` / `--shell=default` to interpret shell syntax, or `-N` / `--shell=none` to pass
|
||||
the operators as literal arguments.
|
||||
|
||||
To enable shell syntax, use `-S` (an alias for `--shell=default`). This selects `sh`
|
||||
on Unix (resolved through `PATH`) or `cmd.exe` on Windows:
|
||||
```sh
|
||||
|
||||
+24
-2
@@ -11,9 +11,9 @@ use cli::get_cli_arguments;
|
||||
use command::Commands;
|
||||
use error::ConsoleOutputError;
|
||||
use export::ExportManager;
|
||||
use options::Options;
|
||||
use options::{ExecutorKind, Options};
|
||||
|
||||
use anyhow::Result;
|
||||
use anyhow::{bail, Result};
|
||||
use colored::*;
|
||||
|
||||
pub mod benchmark;
|
||||
@@ -27,6 +27,7 @@ pub mod outlier_detection;
|
||||
pub mod output;
|
||||
pub mod parameter;
|
||||
pub mod quantity;
|
||||
pub mod shell_syntax;
|
||||
pub mod timer;
|
||||
pub mod util;
|
||||
|
||||
@@ -40,6 +41,27 @@ fn run() -> Result<()> {
|
||||
let commands = Commands::from_cli_arguments(&cli_arguments)?;
|
||||
options.validate_against_command_list(&commands)?;
|
||||
|
||||
if matches!(options.executor_kind, ExecutorKind::Raw)
|
||||
&& !cli_arguments.get_flag("no-shell")
|
||||
&& cli_arguments.get_one::<String>("shell").is_none()
|
||||
{
|
||||
for command in commands.iter() {
|
||||
let command_line = command.get_command_line();
|
||||
if let Some(operator) = shell_syntax::first_unquoted_operator(&command_line) {
|
||||
bail!(
|
||||
concat!(
|
||||
"Command '{command_line}' contains unquoted shell syntax ('{operator}').\n",
|
||||
"Explicitly choose how to execute it:\n",
|
||||
" -S / --shell=default Interpret shell syntax.\n",
|
||||
" -N / --shell=none Run directly, passing '{operator}' as a literal argument.",
|
||||
),
|
||||
command_line = command_line,
|
||||
operator = operator,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let export_manager = ExportManager::from_cli_arguments(&cli_arguments, options.metrics[0])?;
|
||||
|
||||
let mut scheduler = Scheduler::new(&commands, &options, &export_manager);
|
||||
|
||||
+16
-8
@@ -1,4 +1,4 @@
|
||||
use std::io::{self, Write};
|
||||
use std::io::{self, IsTerminal, Write};
|
||||
|
||||
use anyhow::{ensure, Result};
|
||||
use colored::Colorize;
|
||||
@@ -12,6 +12,8 @@ use crate::output::console_writeln;
|
||||
const MIN_VALUE_WIDTH: usize = 7;
|
||||
const MIN_UNIT_WIDTH: usize = 3;
|
||||
const MIN_CHANGE_WIDTH: usize = 14;
|
||||
// Leave room for long metric labels and comparison factors in the full layout.
|
||||
const COMPACT_WIDTH_THRESHOLD: u16 = 110;
|
||||
|
||||
/// Print a completed benchmark immediately, comparing every metric with benchmark 1.
|
||||
pub fn print(
|
||||
@@ -22,6 +24,10 @@ pub fn print(
|
||||
skip_unavailable_metrics: bool,
|
||||
reference: Option<&BenchmarkResult>,
|
||||
) -> Result<()> {
|
||||
// Only adapt interactive output; redirected reports keep their usual layout.
|
||||
let compact = io::stdout().is_terminal()
|
||||
&& terminal_size::terminal_size()
|
||||
.is_some_and(|(terminal_size::Width(width), _)| width < COMPACT_WIDTH_THRESHOLD);
|
||||
let comparison = reference.is_some();
|
||||
let multiple_runs = measurements.len() > 1;
|
||||
let value_columns = 1..if multiple_runs { 5 } else { 2 };
|
||||
@@ -57,10 +63,12 @@ pub fn print(
|
||||
.unwrap_or(&summary)
|
||||
.mean;
|
||||
let unit = selection.display_unit(scale_mean);
|
||||
let mut row = vec![
|
||||
selection.metric.label().to_owned(),
|
||||
unit.format_value(summary.mean),
|
||||
];
|
||||
let label = if compact && unit.symbol != "count" {
|
||||
format!("{} [{}]", selection.metric.label(), unit.symbol)
|
||||
} else {
|
||||
selection.metric.label().to_owned()
|
||||
};
|
||||
let mut row = vec![label, unit.format_value(summary.mean)];
|
||||
if let Some(stddev) = summary.stddev {
|
||||
row.push(unit.format_value(stddev));
|
||||
row.push(unit.format_value(summary.min));
|
||||
@@ -108,9 +116,9 @@ pub fn print(
|
||||
if column == 0 {
|
||||
width.max(metric_width)
|
||||
} else if value_columns.contains(&column) {
|
||||
width.max(MIN_VALUE_WIDTH)
|
||||
width.max(if compact { 5 } else { MIN_VALUE_WIDTH })
|
||||
} else {
|
||||
width.max(MIN_CHANGE_WIDTH)
|
||||
width.max(if compact { 7 } else { MIN_CHANGE_WIDTH })
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
@@ -147,7 +155,7 @@ pub fn print(
|
||||
});
|
||||
}
|
||||
let padding = " ".repeat(widths[column] - value.chars().count());
|
||||
let has_unit = value_columns.contains(&column);
|
||||
let has_unit = !compact && value_columns.contains(&column);
|
||||
let text = if has_unit && !unit.is_empty() {
|
||||
format!("{value} {unit}")
|
||||
} else {
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
//! Conservative detection of shell operators in commands run without a shell.
|
||||
|
||||
use std::iter::Peekable;
|
||||
use std::str::CharIndices;
|
||||
|
||||
/// Find the first standalone operator that is neither quoted nor escaped.
|
||||
///
|
||||
/// Operators attached to another word (such as `hello>out`), expansions, and
|
||||
/// other shell syntax are deliberately outside the scope of this check.
|
||||
pub fn first_unquoted_operator(command: &str) -> Option<&'static str> {
|
||||
tokenize(command).find_map(|token| {
|
||||
["&&", "||", "|", ";", ">", ">>", "<"]
|
||||
.iter()
|
||||
.copied()
|
||||
.find(|operator| {
|
||||
// An escaped newline joins lines without quoting either side.
|
||||
// All other quotes and escapes remain in the token, preventing
|
||||
// it from matching an operator.
|
||||
token
|
||||
.split("\\\n")
|
||||
.flat_map(str::bytes)
|
||||
.eq(operator.bytes())
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
/// Split words while preserving their original quoting and escaping.
|
||||
///
|
||||
/// Word boundaries and comments follow the same rules as `shell_words`, which
|
||||
/// parses commands for direct execution. This tokenizer neither expands shell
|
||||
/// expressions nor validates balanced quotes; command parsing handles errors.
|
||||
fn tokenize(command: &str) -> impl Iterator<Item = &str> {
|
||||
Tokens {
|
||||
command,
|
||||
chars: command.char_indices().peekable(),
|
||||
}
|
||||
}
|
||||
|
||||
struct Tokens<'a> {
|
||||
command: &'a str,
|
||||
chars: Peekable<CharIndices<'a>>,
|
||||
}
|
||||
|
||||
impl<'a> Iterator for Tokens<'a> {
|
||||
type Item = &'a str;
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
// Whitespace, comments, and line continuations cannot start a word.
|
||||
let start = loop {
|
||||
let &(index, character) = self.chars.peek()?;
|
||||
match character {
|
||||
' ' | '\t' | '\n' => {
|
||||
self.chars.next();
|
||||
}
|
||||
'#' => {
|
||||
for (_, character) in self.chars.by_ref() {
|
||||
if character == '\n' {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
'\\' if self.chars.clone().nth(1).map(|(_, c)| c) == Some('\n') => {
|
||||
self.chars.next();
|
||||
self.chars.next();
|
||||
}
|
||||
_ => break index,
|
||||
}
|
||||
};
|
||||
|
||||
let mut quote = None;
|
||||
while let Some((index, character)) = self.chars.next() {
|
||||
match (quote, character) {
|
||||
(Some('\''), '\'') | (Some('"'), '"') => quote = None,
|
||||
(Some('\''), _) => {}
|
||||
(_, '\\') => {
|
||||
// Within double quotes, skipping a non-special escaped
|
||||
// character is also safe: it cannot end the quoted word.
|
||||
self.chars.next();
|
||||
}
|
||||
(Some('"'), _) => {}
|
||||
(None, '\'' | '"') => quote = Some(character),
|
||||
(None, ' ' | '\t' | '\n') => return Some(&self.command[start..index]),
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
Some(&self.command[start..])
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{first_unquoted_operator, tokenize};
|
||||
|
||||
#[test]
|
||||
fn tokenizer_preserves_words_quotes_and_escapes() {
|
||||
for (command, expected) in [
|
||||
("", vec![]),
|
||||
(" \t\n", vec![]),
|
||||
(" echo\thello\nworld ", vec!["echo", "hello", "world"]),
|
||||
(
|
||||
r#"echo '' "" 'hello world'"#,
|
||||
vec!["echo", "''", "\"\"", "'hello world'"],
|
||||
),
|
||||
(
|
||||
r#"echo pre'quoted part'"more"post"#,
|
||||
vec!["echo", r#"pre'quoted part'"more"post"#],
|
||||
),
|
||||
(
|
||||
r"echo hello\ world \&\&",
|
||||
vec!["echo", r"hello\ world", r"\&\&"],
|
||||
),
|
||||
(r#"echo "a\" b" 'a\'"#, vec!["echo", r#""a\" b""#, r"'a\'"]),
|
||||
("echo hello>out", vec!["echo", "hello>out"]),
|
||||
(
|
||||
"echo café\t&&\n日本語",
|
||||
vec!["echo", "café", "&&", "日本語"],
|
||||
),
|
||||
("echo a\r\u{a0}b", vec!["echo", "a\r\u{a0}b"]),
|
||||
] {
|
||||
assert_eq!(
|
||||
tokenize(command).collect::<Vec<_>>(),
|
||||
expected,
|
||||
"{command:?}"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tokenizer_handles_comments_and_continuations() {
|
||||
for (command, expected) in [
|
||||
("# ignored &&", vec![]),
|
||||
(
|
||||
"echo # ignored &&\nnext | cat",
|
||||
vec!["echo", "next", "|", "cat"],
|
||||
),
|
||||
(
|
||||
r##"echo a#b \#c "#d" '#e'"##,
|
||||
vec!["echo", "a#b", r"\#c", "\"#d\"", "'#e'"],
|
||||
),
|
||||
("\\\n echo \\\n&& more", vec!["echo", "&&", "more"]),
|
||||
("echo hello\\\nworld", vec!["echo", "hello\\\nworld"]),
|
||||
("\\\n# comment\necho", vec!["echo"]),
|
||||
] {
|
||||
assert_eq!(
|
||||
tokenize(command).collect::<Vec<_>>(),
|
||||
expected,
|
||||
"{command:?}"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn finds_supported_operators_in_command_order() {
|
||||
for operator in ["&&", "||", "|", ";", ">", ">>", "<"] {
|
||||
let command = format!("echo café\t{operator}\n日本語");
|
||||
assert_eq!(first_unquoted_operator(&command), Some(operator));
|
||||
assert_eq!(first_unquoted_operator(operator), Some(operator));
|
||||
}
|
||||
assert_eq!(first_unquoted_operator("echo a >> out && next"), Some(">>"));
|
||||
assert_eq!(first_unquoted_operator("echo \\\n&& next"), Some("&&"));
|
||||
assert_eq!(first_unquoted_operator("echo &\\\n& next"), Some("&&"));
|
||||
assert_eq!(first_unquoted_operator("echo &&\\\n next"), Some("&&"));
|
||||
assert_eq!(first_unquoted_operator("echo # &&\nnext | cat"), Some("|"));
|
||||
assert_eq!(first_unquoted_operator(r#"echo "&&" || next"#), Some("||"));
|
||||
assert_eq!(first_unquoted_operator(r"echo \&\& | cat"), Some("|"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ignores_quoted_escaped_and_attached_operators() {
|
||||
for command in [
|
||||
r#"echo "&&""#,
|
||||
"echo '&&'",
|
||||
r"echo \&\&",
|
||||
r"echo &\&",
|
||||
r#"echo '&'"&""#,
|
||||
r#"echo ""&&"#,
|
||||
"echo &&''",
|
||||
r#"python -c "print(1 > 0)""#,
|
||||
"sh -c 'true && false'",
|
||||
r#"sh -c "echo 'a | b' && false""#,
|
||||
r#"sh -c 'echo "a | b" && false'"#,
|
||||
r#"echo "escaped \" && still quoted""#,
|
||||
"echo hello>out",
|
||||
"true&&false",
|
||||
"echo a;",
|
||||
"echo 2> out",
|
||||
"echo >>> out",
|
||||
"echo $VARIABLE *.rs ~/path NAME=value",
|
||||
"echo # && ignored",
|
||||
"echo foo#bar",
|
||||
"echo\u{a0}&&",
|
||||
"echo &&\r",
|
||||
] {
|
||||
assert_eq!(first_unquoted_operator(command), None, "{command:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn handles_empty_and_malformed_commands_without_panicking() {
|
||||
for (command, expected) in [
|
||||
("", vec![]),
|
||||
("\\\n", vec![]),
|
||||
("\\", vec!["\\"]),
|
||||
(r"echo \", vec!["echo", r"\"]),
|
||||
("echo 'unclosed &&", vec!["echo", "'unclosed &&"]),
|
||||
("echo \"unclosed &&", vec!["echo", "\"unclosed &&"]),
|
||||
("echo \"unclosed\\", vec!["echo", "\"unclosed\\"]),
|
||||
] {
|
||||
assert_eq!(
|
||||
tokenize(command).collect::<Vec<_>>(),
|
||||
expected,
|
||||
"{command:?}"
|
||||
);
|
||||
assert_eq!(first_unquoted_operator(command), None, "{command:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -266,6 +266,42 @@ fn fails_with_duplicate_parameter_names() {
|
||||
.stderr(predicate::str::contains("Duplicate parameter names: x"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn requires_explicit_shell_for_shell_syntax() {
|
||||
let directory = tempfile::tempdir().unwrap();
|
||||
|
||||
let assert = hyperfine()
|
||||
.current_dir(directory.path())
|
||||
.arg("rm -rf cache/ && ./my_command")
|
||||
.assert()
|
||||
.failure();
|
||||
|
||||
insta::assert_snapshot!(String::from_utf8_lossy(&assert.get_output().stderr), @"
|
||||
Error: Command 'rm -rf cache/ && ./my_command' contains unquoted shell syntax ('&&').
|
||||
Explicitly choose how to execute it:
|
||||
-S / --shell=default Interpret shell syntax.
|
||||
-N / --shell=none Run directly, passing '&&' as a literal argument.
|
||||
");
|
||||
|
||||
hyperfine()
|
||||
.arg("--show-output")
|
||||
.arg("--command-name=benchmark")
|
||||
.args(["--shell=default", "--runs=1", "echo before && echo after"])
|
||||
.assert()
|
||||
.success()
|
||||
.stdout(predicate::str::contains("before"))
|
||||
.stdout(predicate::str::contains("after"))
|
||||
.stdout(predicate::str::contains("&&").not());
|
||||
|
||||
hyperfine()
|
||||
.arg("--show-output")
|
||||
.arg("--command-name=benchmark")
|
||||
.args(["--shell=none", "--runs=1", "echo before && echo after"])
|
||||
.assert()
|
||||
.success()
|
||||
.stdout(predicate::str::contains("before && echo after"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_for_unknown_command() {
|
||||
hyperfine()
|
||||
|
||||
Reference in new issue
Block a user