Add HTML repr for InferenceData (#91)

* Catch html character entities

* Use html repr if available and requested

* Test html repr for InferenceData

* Increment version number

* Call PyObject

* Use right variable name

* Drop prefix

* Rewrite tests

Project.toml

@@ -1,7 +1,7 @@
 name = "ArviZ"
 uuid = "131c737c-5715-5e2e-ad31-c244f01c1dc7"
 authors = ["Seth Axen <[email protected]>"]
-version = "0.4.4"
+version = "0.4.5"
 
 [deps]
 Conda = "8f4d0f93-b110-5947-807f-2305c1781a2d"

src/data.jl

@@ -55,6 +55,15 @@ function Base.show(io::IO, data::InferenceData)
     print(io, out)
     return nothing
 end
+function Base.show(io::IO, ::MIME"text/html", data::InferenceData)
+    obj = PyObject(data)
+    (:_repr_html_ in propertynames(obj)) || return show(io, data)
+    out = obj._repr_html_()
+    out = replace(out, r"arviz.InferenceData" => "InferenceData")
+    out = replace(out, r"(<|&lt;)?xarray.Dataset(>|&gt;)?" => "Dataset (xarray.Dataset)")
+    print(io, out)
+    return nothing
+end
 
 """
     groupnames(data::InferenceData) -> Vector{Symbol}

src/dataset.jl

@@ -56,10 +56,10 @@ function Base.show(io::IO, data::Dataset)
     return nothing
 end
 function Base.show(io::IO, ::MIME"text/html", data::Dataset)
-    obj = data.o
+    obj = PyObject(data)
     (:_repr_html_ in propertynames(obj)) || return show(io, data)
     out = obj._repr_html_()
-    out = replace(out, r"<?xarray.Dataset>?" => "Dataset (xarray.Dataset)")
+    out = replace(out, r"(<|&lt;)?xarray.Dataset(>|&gt;)?" => "Dataset (xarray.Dataset)")
     print(io, out)
     return nothing
 end

test/test_data.jl

@@ -48,9 +48,22 @@ using MonteCarloMeasurements: Particles
     end
 
     @testset "show" begin
-        @test startswith(sprint(show, data), "InferenceData with groups:")
-        rest = split(PyObject(data).__str__(), '\n'; limit = 2)[2]
-        @test split(sprint(show, data), '\n'; limit = 2)[2] == rest
+        @testset "plain" begin
+            text = sprint(show, data)
+            @test startswith(text, "InferenceData with groups:")
+            rest = split(PyObject(data).__str__(), '\n'; limit = 2)[2]
+            @test split(text, '\n'; limit = 2)[2] == rest
+        end
+
+        @testset "html" begin
+            text = repr(MIME("text/html"), data)
+            @test text isa String
+            @test !occursin("<xarray.Dataset>", text)
+            @test !occursin("&lt;xarray.Dataset&gt;", text)
+            @test !occursin("arviz.InferenceData", text)
+            @test occursin("Dataset (xarray.Dataset)", text)
+            @test occursin("InferenceData", text)
+        end
     end
 end
 

test/test_dataset.jl

@@ -32,6 +32,8 @@
         @testset "$mimetype" for mimetype in ("plain", "html")
             text = repr(MIME("text/$(mimetype)"), dataset)
             @test text isa String
+            @test !occursin("<xarray.Dataset>", text)
+            @test !occursin("&lt;xarray.Dataset&gt;", text)
             @test occursin("Dataset (xarray.Dataset)", text)
         end
     end