Add options for varinfo() to show all and imported, sort by each column, search modules recursively

stdlib/InteractiveUtils/src/InteractiveUtils.jl

@@ -21,27 +21,36 @@ include("macros.jl")
 include("clipboard.jl")
 
 """
-    varinfo(m::Module=Main, pattern::Regex=r"")
+    varinfo(m::Module=Main, pattern::Regex=r""; all::Bool = false, imported::Bool = false, sort_size::Bool = false)
 
 Return a markdown table giving information about exported global variables in a module, optionally restricted
 to those matching `pattern`.
 
 The memory consumption estimate is an approximate lower bound on the size of the internal structure of the object.
+
+- `all` : also list non-exported objects defined in the module, deprecated objects, and compiler-generated objects.
+- `imported` : also list objects explicitly imported from other modules.
+- `sort_size` : sort results by their size, in descending order
 """
-function varinfo(m::Module=Main, pattern::Regex=r"")
+function varinfo(m::Module=Main, pattern::Regex=r""; all::Bool = false, imported::Bool = false, sort_size::Bool = false)
     rows =
         Any[ let value = getfield(m, v)
                  Any[string(v),
                      (value===Base || value===Main || value===Core ? "" : format_bytes(summarysize(value))),
-                     summary(value)]
+                     summary(value),
+                     summarysize(value)]
              end
-             for v in sort!(names(m)) if isdefined(m, v) && occursin(pattern, string(v)) ]
-
+             for v in sort!(names(m, all = all, imported = imported)) if isdefined(m, v) && occursin(pattern, string(v)) ]
+    if sort_size
+        sizes = map(r->r[4], rows)
+        p = sortperm(sizes, rev=true)
+        rows = rows[p]
+    end
     pushfirst!(rows, Any["name", "size", "summary"])
 
-    return Markdown.MD(Any[Markdown.Table(rows, Symbol[:l, :r, :l])])
+    return Markdown.MD(Any[Markdown.Table(map(r->r[1:3], rows), Symbol[:l, :r, :l])])
 end
-varinfo(pat::Regex) = varinfo(Main, pat)
+varinfo(pat::Regex; kwargs...) = varinfo(Main, pat, kwargs...)
 
 """
     versioninfo(io::IO=stdout; verbose::Bool=false)

stdlib/InteractiveUtils/test/runtests.jl

@@ -153,15 +153,35 @@ mktemp() do f, io
 end
 
 module _test_varinfo_
-export x
-x = 1.0
+import Test: @test
+export exported
+exported = 1.0
+not_exp = 1.0
+z_larger = Vector{Float64}(undef, 3)
+a_smaller = Vector{Float64}(undef, 2)
 end
 @test repr(varinfo(Main, r"^$")) == """
 | name | size | summary |
 |:---- | ----:|:------- |
 """
 let v = repr(varinfo(_test_varinfo_))
-    @test occursin("| x              |   8 bytes | Float64 |", v)
+    @test occursin("| exported       |   8 bytes | Float64 |", v)
+    @test !occursin("not_exp", v)
+    @test !occursin("@test", v)
+end
+let v = repr(varinfo(_test_varinfo_, all = true))
+    @test occursin("exported", v)
+    @test occursin("not_exp", v)
+    @test !occursin("@test", v)
+    @test findfirst("a_smaller", v)[1] < findfirst("z_larger", v)[1] # check for alphabetical
+end
+let v = repr(varinfo(_test_varinfo_, imported = true))
+    @test occursin("exported", v)
+    @test !occursin("not_exp", v)
+    @test occursin("@test", v)
+end
+let v = repr(varinfo(_test_varinfo_, all=true, sort_size = true))
+    @test findfirst("z_larger", v)[1] < findfirst("a_smaller", v)[1] # check for size order
 end
 
 # Issue 14173