update BenchmarkTool's use of show to be API compliant for Julia 1.0 (#121)

Author: willow-ahrens

doc/manual.md

@@ -591,7 +591,7 @@ Following from the previous section, we see that running our benchmark suite ret
 julia> results["utf8"]
 BenchmarkTools.BenchmarkGroup:
   tags: ["string", "unicode"]
-  "join" => Trial(133.84 ms) # showcompact for Trial displays the minimum time estimate
+  "join" => Trial(133.84 ms) # summary(::Trial) displays the minimum time estimate
   "replace" => Trial(202.3 μs)
 
 julia> results["trig"]

src/groups.jl

@@ -248,21 +248,24 @@ Base.setindex!(group::BenchmarkGroup, v, k::BenchmarkGroup) = error("A Benchmark
 
 tagrepr(tags) = string("[", join(map(repr, tags), ", "), "]")
 
-Base.show(io::IO, group::BenchmarkGroup) = print(io, "$(length(group))-element BenchmarkGroup($(tagrepr(group.tags)))")
+Base.summary(io::IO, group::BenchmarkGroup) = print(io, "$(length(group))-element BenchmarkGroup($(tagrepr(group.tags)))")
 
-function Base.show(io::IO, mime::MIME"text/plain", group::BenchmarkGroup, pad = ""; verbose = false, limit = 10)
+function Base.show(io::IO, group::BenchmarkGroup)
     println(io, "$(length(group))-element BenchmarkTools.BenchmarkGroup:")
+    pad = get(io, :pad, "")
     print(io, pad, "  tags: ", tagrepr(group.tags))
     count = 1
     for (k, v) in group
         println(io)
         print(io, pad, "  ", repr(k), " => ")
-        if verbose && isa(v, BenchmarkGroup)
-            show(io, mime, v, "\t"*pad; verbose = verbose, limit = limit)
+        if get(io, :verbose, false) && isa(v, BenchmarkGroup)
+            show(IOContext(io, :pad => "\t"*pad), v)
+        elseif get(io, :compact, true)
+            summary(IOContext(io, :pad => "\t"*pad), v)
         else
-            show(io, v)
+            show(IOContext(io, :pad => "\t"*pad), v)
         end
-        count > limit && (println(io); print(io, pad, "  ⋮"); break)
+        count > get(io, :limit, 10) && (println(io); print(io, pad, "  ⋮"); break)
         count += 1
     end
 end

src/trials.jl

@@ -262,12 +262,12 @@ function prettymemory(b)
     return string(@sprintf("%.2f", value), " ", units)
 end
 
-Base.show(io::IO, t::Trial) = print(io, "Trial(", prettytime(time(t)), ")")
-Base.show(io::IO, t::TrialEstimate) = print(io, "TrialEstimate(", prettytime(time(t)), ")")
-Base.show(io::IO, t::TrialRatio) = print(io, "TrialRatio(", prettypercent(time(t)), ")")
-Base.show(io::IO, t::TrialJudgement) = print(io, "TrialJudgement(", prettydiff(time(ratio(t))), " => ", time(t), ")")
+Base.summary(io::IO, t::Trial) = print(io, "Trial(", prettytime(time(t)), ")")
+Base.summary(io::IO, t::TrialEstimate) = print(io, "TrialEstimate(", prettytime(time(t)), ")")
+Base.summary(io::IO, t::TrialRatio) = print(io, "TrialRatio(", prettypercent(time(t)), ")")
+Base.summary(io::IO, t::TrialJudgement) = print(io, "TrialJudgement(", prettydiff(time(ratio(t))), " => ", time(t), ")")
 
-function Base.show(io::IO, ::MIME"text/plain", t::Trial)
+function Base.show(io::IO, t::Trial)
     if length(t) > 0
         min = minimum(t)
         max = maximum(t)
@@ -288,36 +288,40 @@ function Base.show(io::IO, ::MIME"text/plain", t::Trial)
         meanstr = "N/A"
     end
     println(io, "BenchmarkTools.Trial: ")
-    println(io, "  memory estimate:  ", memorystr)
-    println(io, "  allocs estimate:  ", allocsstr)
-    println(io, "  --------------")
-    println(io, "  minimum time:     ", minstr)
-    println(io, "  median time:      ", medstr)
-    println(io, "  mean time:        ", meanstr)
-    println(io, "  maximum time:     ", maxstr)
-    println(io, "  --------------")
-    println(io, "  samples:          ", length(t))
-    print(io,   "  evals/sample:     ", t.params.evals)
+    pad = get(io, :pad, "")
+    println(io, pad, "  memory estimate:  ", memorystr)
+    println(io, pad, "  allocs estimate:  ", allocsstr)
+    println(io, pad, "  --------------")
+    println(io, pad, "  minimum time:     ", minstr)
+    println(io, pad, "  median time:      ", medstr)
+    println(io, pad, "  mean time:        ", meanstr)
+    println(io, pad, "  maximum time:     ", maxstr)
+    println(io, pad, "  --------------")
+    println(io, pad, "  samples:          ", length(t))
+    print(io,   pad, "  evals/sample:     ", t.params.evals)
 end
 
-function Base.show(io::IO, ::MIME"text/plain", t::TrialEstimate)
+function Base.show(io::IO, t::TrialEstimate)
     println(io, "BenchmarkTools.TrialEstimate: ")
-    println(io, "  time:             ", prettytime(time(t)))
-    println(io, "  gctime:           ", prettytime(gctime(t)), " (", prettypercent(gctime(t) / time(t)),")")
-    println(io, "  memory:           ", prettymemory(memory(t)))
-    print(io,   "  allocs:           ", allocs(t))
+    pad = get(io, :pad, "")
+    println(io, pad, "  time:             ", prettytime(time(t)))
+    println(io, pad, "  gctime:           ", prettytime(gctime(t)), " (", prettypercent(gctime(t) / time(t)),")")
+    println(io, pad, "  memory:           ", prettymemory(memory(t)))
+    print(io,   pad, "  allocs:           ", allocs(t))
 end
 
-function Base.show(io::IO, ::MIME"text/plain", t::TrialRatio)
+function Base.show(io::IO, t::TrialRatio)
     println(io, "BenchmarkTools.TrialRatio: ")
-    println(io, "  time:             ", time(t))
-    println(io, "  gctime:           ", gctime(t))
-    println(io, "  memory:           ", memory(t))
-    print(io,   "  allocs:           ", allocs(t))
+    pad = get(io, :pad, "")
+    println(io, pad, "  time:             ", time(t))
+    println(io, pad, "  gctime:           ", gctime(t))
+    println(io, pad, "  memory:           ", memory(t))
+    print(io,   pad, "  allocs:           ", allocs(t))
 end
 
-function Base.show(io::IO, ::MIME"text/plain", t::TrialJudgement)
+function Base.show(io::IO, t::TrialJudgement)
     println(io, "BenchmarkTools.TrialJudgement: ")
-    println(io, "  time:   ", prettydiff(time(ratio(t))), " => ", time(t), " (", prettypercent(params(t).time_tolerance), " tolerance)")
-    print(io,   "  memory: ", prettydiff(memory(ratio(t))), " => ", memory(t), " (", prettypercent(params(t).memory_tolerance), " tolerance)")
+    pad = get(io, :pad, "")
+    println(io, pad, "  time:   ", prettydiff(time(ratio(t))), " => ", time(t), " (", prettypercent(params(t).time_tolerance), " tolerance)")
+    print(io,   pad, "  memory: ", prettydiff(memory(ratio(t))), " => ", memory(t), " (", prettypercent(params(t).memory_tolerance), " tolerance)")
 end