Add _show_data function to skip data loading during show (#1130)

* Add _show_data function to ensure DiskArrays don't try to load data during show

* Apply suggestions from code reviewRename to can_show_data

Co-authored-by: Rafael Schouten <[email protected]>

* Fix DiskArray show test

* Convert string descriptors to comments in Makie tests

This is to fix the nightly tests. Because the behaviour has changed in Julia 1.14

---------

Co-authored-by: Rafael Schouten <[email protected]>

Author: Felix Cremer

ext/DimensionalDataDiskArraysExt.jl

@@ -16,7 +16,7 @@ DiskArrays.eachchunk(da::AbstractBasicDimArray) = DiskArrays.eachchunk(parent(da
 
 # Only define methods if they are available, 
 # to avoid dropping older DiskArrays versions
-# TODO remove these checks
+# TODO remove these checks when we drop DiskArrays below 0.4.8
 @static if isdefined(DiskArrays, :isdisk)
     DiskArrays.isdisk(x::AbstractDimArray) = DiskArrays.isdisk(parent(x))
     DiskArrays.isdisk(x::AbstractDimStack) = any(map(DiskArrays.isdisk, layers(x)))
@@ -96,4 +96,6 @@ end
         modify(A -> DiskArrays.mockchunks(A, chunks), x)
 end
 
+DD.can_show_data(A::DiskArrays.AbstractDiskArray) = false
+
 end

src/array/show.jl

@@ -91,11 +91,14 @@ But read the DimensionalData.jl `show.jl` code for details.
 function show_after(io::IO, mime, A::AbstractBasicDimArray)
     blockwidth = get(io, :blockwidth, 0)
     print_block_close(io, blockwidth)
+    can_show_data(parent(A)) || return
     ndims(A) > 0 && println(io)
     any(==(0), size(A)) && return
     print_array(io, mime, A)
 end
 
+can_show_data(A) = true
+
 function print_ndims(io, size::Tuple;
     colors=map(dimcolor, ntuple(identity, length(size)))
 )

test/makie.jl

@@ -744,12 +744,12 @@ end
     volumeslices!(ax, A3abc; zdim=:a)
     volumeslices!(A3abc;zdim=:a)
 
-    "LScene support"
+    #LScene support 
     f, a, p = heatmap(A2ab; axis=(; type=LScene, show_axis=false))
     @test a isa LScene
     @test isnothing(a.scene[OldAxis])
 
-    "Colorbar support"
+    #Colorbar support
     fig, ax, _ = plot(A2ab; colorbar=(; width=50))
     colorbars = filter(x -> x isa Colorbar, fig.content)
     @test length(colorbars) == 1

test/show.jl

@@ -1,6 +1,7 @@
 using DimensionalData, Test, Dates
 using DimensionalData.Lookups, DimensionalData.Dimensions
 using DimensionalData: LazyLabelledPrintMatrix, ShowWith, showrowlabel, showcollabel, showarrows
+using DiskArrays.TestTypes: AccessCountDiskArray, getindex_count
 
 # define dims with both long name and Type name
 @dim Lon "Longitude"
@@ -261,4 +262,11 @@ end
     @test occursin("mybranch", sc)
     @test occursin(":c", sc)
 
+end
+
+@testset "DiskArray show" begin
+    da = AccessCountDiskArray(rand(10,10))
+    dd = DimArray(da, (X(1:10), Y(1:10)))
+    sc = sprint(show, MIME("text/plain"), dd)
+    @test getindex_count(da) == 0 
 end