Merge pull request #150 from VirtualPlantLab/fix-printing

Fix printing of ModelList

Author: VEZY

src/component_models/ModelList.jl

@@ -187,8 +187,6 @@ function ModelList(
     ts_kwargs = homogeneous_ts_kwargs(status)
     ts_kwargs = add_model_vars(ts_kwargs, mods, type_promotion)
 
-
-
     model_list = ModelList(
         mods,
         ts_kwargs,
@@ -469,9 +467,10 @@ function convert_vars!(mapped_vars::Dict{String,Dict{Symbol,Any}}, type_promotio
     end
 end
 
-function Base.show(io::IO, ::MIME"text/plain", t::ModelList)
-    print(io, dep(t))
-    print(io, status(t))
+function Base.show(io::IO, m::MIME"text/plain", t::ModelList)
+    show(io, m, dep(t))
+    println(io, "")
+    show(io, m, status(t))
 end
 
 # Short form printing (e.g. inside another object)

src/dependencies/dependency_graph.jl

@@ -64,16 +64,18 @@ AbstractTrees.printnode(io::IO, node::HardDependencyNode{T}) where {T} = print(i
 AbstractTrees.printnode(io::IO, node::SoftDependencyNode{T}) where {T} = print(io, T)
 Base.show(io::IO, t::AbstractDependencyNode) = AbstractTrees.print_tree(io, t)
 Base.length(t::AbstractDependencyNode) = length(collect(AbstractTrees.PreOrderDFS(t)))
+Base.length(t::DependencyGraph) = length(traverse_dependency_graph(t))
+AbstractTrees.children(t::DependencyGraph) = collect(t.roots)
 
-function Base.show(io::IO, t::DependencyGraph{Dict{Pair{String,Symbol},PlantSimEngine.SoftDependencyNode}})
+# Long form printing
+function Base.show(io::IO, ::MIME"text/plain", t::DependencyGraph)
     # If the graph is cyclic, we print the cycle because we can't print indefinitely:
     iscyclic, cycle_vec = is_graph_cyclic(t; warn=false, full_stack=true)
     if iscyclic
         print(io, "⚠ Cyclic dependency graph: \n $(print_cycle(cycle_vec))")
         return nothing
     else
         draw_dependency_graph(io, t)
-        print(io, "The dependency graph is acyclic.")
     end
 end
 

src/dependencies/printing.jl

@@ -1,21 +1,29 @@
 function draw_dependency_graph(
     io,
-    graphs::DependencyGraph{Dict{Pair{String,Symbol},PlantSimEngine.SoftDependencyNode}};
-    title="Dependency graph",
+    graphs::DependencyGraph;
+    title=string("Dependency graph (", length(graphs), " models)"),
+    max_depth::Int=1,
     title_style::String="#FFA726 italic",
     guides_style::String="#42A5F5",
     dep_graph_guides=(space=" ", vline="│", branch="├", leaf="└", hline="─")
 )
 
     dep_graph_guides = map((g) -> Term.apply_style("{$guides_style}$g{/$guides_style}"), dep_graph_guides)
 
+    max_depth_reached = Ref(max_depth)
+
     graph_panel = []
     for (p, graph) in graphs.roots
+        if max_depth_reached[] <= 0
+            push!(graph_panel, "...")
+            break
+        end
         node = []
         # p = :process2; graph = graphs.roots[p]
         # typeof(deps[:process4].children[1].hard_dependency.children[1])
-        draw_panel(node, graph, "", dep_graph_guides, graph; title="Main model")
+        draw_panel(node, graph, "", dep_graph_guides, graph, max_depth_reached; title="Main model")
         push!(graph_panel, Term.Panel(node...; fit=true, title=string(p), style="green dim"))
+        max_depth_reached[] -= 1
     end
 
     print(
@@ -34,7 +42,12 @@ end
 
 Draw the panels for all dependencies
 """
-function draw_panel(node, graph, prefix, dep_graph_guides, parent; title="Soft-coupled model")
+function draw_panel(node, graph, prefix, dep_graph_guides, parent, max_depth_reached=Ref(5); title="Soft-coupled model")
+
+    if max_depth_reached[] <= 0
+        push!(node, "...")
+        return nothing
+    end
 
     # If the node has a sibling, draw a branching guide + a horizontal line:
     if length(parent.children) <= 1
@@ -65,7 +78,8 @@ function draw_panel(node, graph, prefix, dep_graph_guides, parent; title="Soft-c
     if graph isa SoftDependencyNode
         # draw a branching guide if there's more soft dependencies after this one:
         for child in graph.hard_dependency
-            draw_panel(node, child, panel_hright, dep_graph_guides, graph; title="Hard-coupled model")
+            draw_panel(node, child, panel_hright, dep_graph_guides, graph, max_depth_reached; title="Hard-coupled model")
+            max_depth_reached[] -= 1
         end
     elseif isa(parent, SoftDependencyNode) && length(parent.children) > 0
         # The current node is a hard dependency of a soft dependency.
@@ -75,7 +89,8 @@ function draw_panel(node, graph, prefix, dep_graph_guides, parent; title="Soft-c
 
     # Recursive call:
     for child in AbstractTrees.children(graph)
-        draw_panel(node, child, panel_hright, dep_graph_guides, graph; title=title_panel(child))
+        draw_panel(node, child, panel_hright, dep_graph_guides, graph, max_depth_reached; title=title_panel(child))
+        max_depth_reached[] -= 1
     end
 end
 
@@ -90,7 +105,7 @@ function draw_model_panel(i::SoftDependencyNode{T}; title=nothing) where {T}
             "Model: $(T)\n",
             "Dep: $(i.parent_vars)"
         );
-        fit=true,
+        fit=false,
         style="blue dim"
     )
 end

src/dependencies/soft_dependencies.jl

@@ -40,7 +40,8 @@ function soft_dependencies(d::DependencyGraph{Dict{Symbol,HardDependencyNode}},
     d_vars = Dict{Symbol,Vector{Pair{Symbol,NamedTuple}}}()
     for (procname, node) in d.roots
         var = Pair{Symbol,NamedTuple}[]
-        traverse_dependency_graph!(node, variables, var)
+        nodes_visited = Set{AbstractDependencyNode}()
+        traverse_dependency_graph!(node, variables, var; node_visited=nodes_visited)
         push!(d_vars, procname => var)
     end
 
@@ -138,7 +139,7 @@ function soft_dependencies(d::DependencyGraph{Dict{Symbol,HardDependencyNode}},
 end
 
 # For multiscale mapping:
-function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dict{String,Any}}, mapping::Dict{String,A}, hard_dep_dict::Dict{Pair{Symbol, String}, HardDependencyNode}) where {A<:Any}
+function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dict{String,Any}}, mapping::Dict{String,A}, hard_dep_dict::Dict{Pair{Symbol,String},HardDependencyNode}) where {A<:Any}
     mapped_vars = mapped_variables(mapping, soft_dep_graphs_roots, verbose=false)
     rev_mapping = reverse_mapping(mapped_vars, all=false)
 
@@ -151,11 +152,11 @@ function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dic
 
             # Remove the hard dependencies from the soft dependencies:
             soft_deps_not_hard = drop_process(soft_deps, [hd.process for hd in i.hard_dependency])
-           
+
             hard_dependencies_from_other_scale = [hd for hd in i.hard_dependency if hd.scale != i.scale]
 
             # NB: if a node is already a hard dependency of the node, it cannot be a soft dependency
-            
+
             # Check if the process has soft dependencies at other scales:
             soft_deps_multiscale = search_inputs_in_multiscale_output(proc, organ, ins, soft_dep_graphs_roots.roots, rev_mapping, hard_dependencies_from_other_scale)
             # Example output: "Soil" => Dict(:soil_water=>[:soil_water_content]), which means that the variable :soil_water_content
@@ -171,37 +172,37 @@ function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dic
                     # If the process has soft dependencies, then it is not independant
                     # and we need to add its parent(s) to the node, and the node as a child
                     for (parent_soft_dep, soft_dep_vars) in pairs(soft_deps_not_hard)
-    
+
                         # if the parent isn't registered as a soft dependency, it likely means the soft dependecy should be to an internal hard dependency to the parent
-                        if(!haskey(soft_dep_graph, parent_soft_dep))
+                        if (!haskey(soft_dep_graph, parent_soft_dep))
 
                             roots_at_given_scale = soft_dep_graphs_roots.roots[i.scale][:soft_dep_graph]
-                            if !(parent_soft_dep in keys(roots_at_given_scale))                                                               
+                            if !(parent_soft_dep in keys(roots_at_given_scale))
                                 master_node = ()
-                                for ((hd_key, hd_scale), hd) in hard_dep_dict 
-                                    if parent_soft_dep == hd_key     
-                                        master_node = hd                                                                                                                                                                                       
+                                for ((hd_key, hd_scale), hd) in hard_dep_dict
+                                    if parent_soft_dep == hd_key
+                                        master_node = hd
                                         depth = 0
                                         # A cleaner way of preventing cycles or infinite loops would be more desirable
                                         while !isa(master_node, SoftDependencyNode) && depth < 50
                                             master_node.parent === nothing && error("Finalised hard dependency has no parent")
                                             master_node = master_node.parent
                                             depth += 1
-                                        end                                      
-                                        
+                                        end
+
                                         break
                                     end
-                               end
-                            master_node == () && error("Parent is not located in hard deps, nor in roots, which should be the case when initalizing soft dependencies")
-                        end
+                                end
+                                master_node == () && error("Parent is not located in hard deps, nor in roots, which should be the case when initalizing soft dependencies")
+                            end
                             # NOTE : this may need to be propagated within internal hard dependencies' ancestors of this model... ?
                             parent_node = soft_dep_graphs_roots.roots[master_node.scale][:soft_dep_graph][master_node.process]
                         else
                             parent_node = soft_dep_graph[parent_soft_dep]
                         end
-                        
-                        
-                        
+
+
+
                         # preventing a cyclic dependency
                         if parent_soft_dep == proc
                             error("Cyclic model dependency detected for process $proc from organ $organ.")
@@ -247,33 +248,33 @@ function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dic
                 # If the node has soft dependencies at other scales, add it as child of the other scale (and add its parent too):
                 if length(soft_deps_multiscale) > 0
                     for org in keys(soft_deps_multiscale)
-                        for (parent_soft_dep, soft_dep_vars) in soft_deps_multiscale[org]                            
-                                                      
+                        for (parent_soft_dep, soft_dep_vars) in soft_deps_multiscale[org]
+
                             # if the node has a soft dependency on a node that is a nested hard dependency, 
                             # have it point to the master node of that hard dependency instead of the internal node
                             # This check is meant in case the organ at the inspected scale is part of a hard dependency, 
                             # and therefore already absent from the roots
 
-                            roots_at_given_scale = soft_dep_graphs_roots.roots[org][:soft_dep_graph]   
-                            if !(parent_soft_dep in keys(roots_at_given_scale))                                                               
+                            roots_at_given_scale = soft_dep_graphs_roots.roots[org][:soft_dep_graph]
+                            if !(parent_soft_dep in keys(roots_at_given_scale))
                                 master_node = ()
-                                for ((hd_key, hd_scale), hd) in hard_dep_dict 
-                                    if parent_soft_dep == hd_key     
-                                        master_node = hd                                                                                                                                                                                       
+                                for ((hd_key, hd_scale), hd) in hard_dep_dict
+                                    if parent_soft_dep == hd_key
+                                        master_node = hd
                                         depth = 0
                                         # A cleaner way of preventing cycles or infinite loops would be more desirable
                                         while !isa(master_node, SoftDependencyNode) && depth < 50
                                             master_node.parent === nothing && error("Finalised hard dependency has no parent")
                                             master_node = master_node.parent
                                             depth += 1
-                                        end                                      
-                                        
+                                        end
+
                                         break
                                     end
-                               end
+                                end
 
                                 master_node == () && error("Parent is not located in hard deps, nor in roots, which should be the case when initalizing soft dependencies")
-                            
+
                                 # NOTE : this may need to be propagated within internal hard dependencies' ancestors of this model... ?
                                 parent_node = soft_dep_graphs_roots.roots[master_node.scale][:soft_dep_graph][master_node.process]
                             else
@@ -298,13 +299,13 @@ function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dic
                                 )
                             end
 
-                            
+
                             if !(i in parent_node.children) # && error("Cyclic dependency detected for process $proc from organ $organ.")
 
                                 # Add the current node as a child of the node on which it depends:
                                 push!(parent_node.children, i)
                             end
-                                # Add the node on which the current node depends as a parent
+                            # Add the node on which the current node depends as a parent
                             if i.parent === nothing
                                 # If the node had no parent already, it is nothing, so we change into a vector
                                 i.parent = [parent_node]
@@ -315,7 +316,7 @@ function soft_dependencies_multiscale(soft_dep_graphs_roots::DependencyGraph{Dic
                             end
 
                             # Add the multiscale soft dependencies variables of the parent to the current node
-                            i.parent_vars = NamedTuple(Symbol(k) => NamedTuple(v) for (k, v) in soft_deps_multiscale)                             
+                            i.parent_vars = NamedTuple(Symbol(k) => NamedTuple(v) for (k, v) in soft_deps_multiscale)
                         end
                     end
                 end
@@ -488,9 +489,9 @@ function search_inputs_in_multiscale_output(process, organ, inputs, soft_dep_gra
                 # Avoid collecting variables at other scales if they come from a hard dependency
                 # They are handled internally by the hard dep, so if a hard dependency contains that variable, don't add it
                 # (This only needs to be done one level beneath the soft dependency nodes, any hard dependencies internal to another one don't expose their variables here)
-               
+
                 in_hard_dep::Bool = false
-                hd_os_current_scale = filter(x -> x.scale == org, hard_dependencies_from_other_scale)               
+                hd_os_current_scale = filter(x -> x.scale == org, hard_dependencies_from_other_scale)
                 for hd_os in hd_os_current_scale
                     hd_os_output_vars = [first(p) for p in pairs(hd_os.outputs)]
                     in_hard_dep |= length(filter(x -> x == var, hd_os_output_vars)) > 0