add Profile.Allocs.@pprof

Author: jw3126

Project.toml

@@ -1,7 +1,7 @@
 name = "PProf"
 uuid = "e4faabce-9ead-11e9-39d9-4379958e3056"
 authors = ["Valentin Churavy <[email protected]>", "Nathan Daly <[email protected]>"]
-version = "3.0.0"
+version = "3.1.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

src/Allocs.jl

@@ -223,4 +223,23 @@ function pprof(alloc_profile::Profile.Allocs.AllocResults = Profile.Allocs.fetch
     out
 end
 
+"""
+    Allocs.@pprof args...
+
+Profiles the expression using `Allocs.@profile` and starts or restarts the `Allocs.pprof()` web UI with
+default arguments. See also [`PProf.@pprof`](@ref).
+
+# Examples
+```julia
+PProf.Allocs.@pprof [randn(3) for _ in 1:100000]
+PProf.Allocs.@pprof sample_rate=1 randn(100)
+```
+"""
+macro pprof(args...)
+    esc(quote
+        $Profile.Allocs.@profile $(args...)
+        $(@__MODULE__).pprof()
+    end)
+end
+
 end  # module Allocs

src/PProf.jl

@@ -345,7 +345,7 @@ end
     @pprof ex
 
 Profiles the expression using `@profile` and starts or restarts the `pprof()` web UI with
-default arguments.
+default arguments. See also [`PProf.Allocs.@pprof`](@ref).
 """
 macro pprof(ex)
     esc(quote

test/Allocs.jl

@@ -9,6 +9,23 @@ using Test
 
 const out = tempname()
 
+@testset "PProf.Allocs.@pprof" begin
+    Profile.Allocs.clear()
+    rm("alloc-profile.pb.gz", force=true)
+    @assert !isfile("alloc-profile.pb.gz")
+    PProf.Allocs.@pprof sample_rate=1.0 randn(100)
+    @test isfile("alloc-profile.pb.gz")
+
+    Profile.Allocs.clear()
+    rm("alloc-profile.pb.gz", force=true)
+    @assert !isfile("alloc-profile.pb.gz")
+    PProf.Allocs.@pprof randn(100)
+    @test isfile("alloc-profile.pb.gz")
+
+    rm("alloc-profile.pb.gz", force=true)
+end
+
+
 @testset "basic profiling" begin
     Profile.Allocs.clear()
     Profile.Allocs.@profile sample_rate=1.0 begin