google/benchmark

On Windows there is formating error when using compare.py

Open

#642 opened on Jul 18, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)C++ (7,968 stars) (1,539 forks)batch import
bughelp wantedos:windows

Description

So I am trying to compare my benchmark but it is really hard because the output contains garbage characters.

python.exe D:_Dev\Playground\gBenchmarkVulkan/bazel-gbenchmarkvulkan/external/gbenchmark/tools/compare.py filters D:_Dev\Playground\gBenchmarkVulkan/benchmark.json NoExcept WithExcept Comparing NoExcept to WithExcept (from D:_Dev\Playground\gBenchmarkVulkan/benchmark.json) Benchmark Time CPU Time Old Time New CPU Old CPU New

vkInstanceCreationUnique[NoExcept vs. WithExcept] +0.0067 +0.0250 107057091 107769236 56818182 58238636

benchmark.txt

Contributor guide

Tech stack
cpppython
Domain
toolingdeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic PythonUnderstanding Windows console
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is in the compare.py script within the benchmark tools. The script uses ANSI escape codes for color output, which are not handled well on Windows Command Prompt. One possible fix is to either disable color output on Windows or use a library like colorama to convert codes. The discussion indicates a few suggestions, so reviewing those comments and the script at tools/compare.py is recommended. The fix should be localized and not affect other parts of the codebase.