Unitful and weakdep handling for v2 extensions (#5143)

* Catch some fixes from #5098 and #5127 for v2

* Copypaste whitespace formatting

* EOF whitespace format

* Load latexify for Unitful tests

* Add improvements from #5158

* PlotsBase, not Plots

* Fully excise UnitfulLatexify, and drop Latexify as a dep for Unitful

* no need for brackets

* Fix unitful latexify tests

* Make Latexify and LaTeXStrings full deps of PlotsBase, remove hack

* Add Colors and Contour as full deps of PlotsBase, so PGFPlotsXExt triggers with no extra imports

* Allow Colors, Contour, LaTeXStrings, Latexify to be stale deps for PlotsBase

* Add a test to improve coverage

* Another test suggested by coverage

* do that test right, whoops

* Drop "WEAKDEPS" for triggering extensions

Author: Ickaser

PlotsBase/Project.toml

@@ -4,12 +4,16 @@ version = "0.1"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+Contour = "d38c429a-6771-53c6-b99e-75d170b6e991"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 FFMPEG = "c87230d0-a227-11e9-1b43-d7ebe4e7570a"
 FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
 JLFzf = "1019f520-868f-41f5-a6de-eb00f4b6a39c"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Measures = "442fdcdd-2543-5da2-b0f3-8c86c306513e"
 NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
@@ -40,24 +44,19 @@ RecipesBase = {path = "../RecipesBase"}
 RecipesPipeline = {path = "../RecipesPipeline"}
 
 [weakdeps]
-Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
-Contour = "d38c429a-6771-53c6-b99e-75d170b6e991"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 GR = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71"
 Gaston = "4b11ee91-296f-5714-9832-002c20994614"
 GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
 HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
 ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254"
-Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
-LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925"
 PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
 PlotlyKaleido = "f2990250-8cf9-495f-b13a-cce12b45703c"
 PythonPlot = "274fc56d-3b97-40fa-a1cd-1b4a50311bf9"
 UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
-UnitfulLatexify = "45397f5d-5981-4c77-b2b3-fc36d6e9b728"
 
 [extensions]
 FileIOExt = "FileIO"
@@ -67,12 +66,12 @@ GeometryBasicsExt = "GeometryBasics"
 HDF5Ext = "HDF5"
 IJuliaExt = "IJulia"
 ImageInTerminalExt = "ImageInTerminal"
-PGFPlotsXExt = ["Colors", "Contour", "Latexify", "LaTeXStrings", "PGFPlotsX"]
+PGFPlotsXExt = "PGFPlotsX"
 PlotlyJSExt = "PlotlyJS"
 PlotlyKaleidoExt = "PlotlyKaleido"
 PythonPlotExt = "PythonPlot"
 UnicodePlotsExt = "UnicodePlots"
-UnitfulExt = ["Latexify", "LaTeXStrings", "UnitfulLatexify", "Unitful"]
+UnitfulExt = "Unitful"
 
 [compat]
 Base64 = "1"
@@ -88,7 +87,7 @@ HDF5 = "0.17"
 JLFzf = "0.1"
 JSON = "0.21, 1"
 LaTeXStrings = "1"
-Latexify = "0.16"
+Latexify = "0.16.8"
 Measures = "0.3"
 NaNMath = "1"
 PGFPlotsX = "1"
@@ -114,7 +113,7 @@ StatsBase = "0.34"
 TableOperations = "1"
 UnicodeFun = "0.4"
 UnicodePlots = "3"
-UnitfulLatexify = "1"
+Unitful = "1.25"
 Unzip = "0.2"
 UUIDs = "1"
 julia = "1.10"

PlotsBase/ext/UnitfulExt.jl

@@ -18,12 +18,10 @@ import Unitful:
     Gain,
     uconvert
 import PlotsBase: PlotsBase, @recipe, PlotText, Subplot, AVec, AMat, Axis
+using Latexify: latexify
+using LaTeXStrings
 import PlotsBase.Axes: format_unit_label
 import RecipesBase
-import LaTeXStrings: LaTeXString
-import Latexify
-
-using UnitfulLatexify
 
 const MissingOrQuantity = Union{Missing, <:Quantity, <:LogScaled}
 
@@ -255,7 +253,7 @@ function append_cbar_unit_if_needed!(attr, label::Nothing, u)
         return attr[:colorbar_title] = UnitfulString("", u)
     end
     return attr[:colorbar_title] = if PlotsBase.backend_name() ≡ :pgfplotsx
-        UnitfulString(LaTeXString(Latexify.latexify(u)), u)
+        UnitfulString(LaTeXString(latexify(u)), u)
     else
         UnitfulString(string(u), u)
     end
@@ -267,7 +265,7 @@ function append_cbar_unit_if_needed!(attr, label::S, u) where {S <: AbstractStri
             LaTeXString(
                 format_unit_label(
                     label,
-                    Latexify.latexify(u),
+                    latexify(u),
                     get(attr, :zunitformat, :round),
                 ),
             ),

PlotsBase/src/Axes.jl

@@ -4,6 +4,7 @@ export Axis, Extrema, tickfont, guidefont, widen_factor, scale_inverse_scale_fun
 export sort_3d_axes, axes_letters, process_axis_arg!, has_ticks, get_axis, get_guide
 
 import ..PlotsBase: PlotsBase, Subplot, DefaultsDict
+using Latexify: latexify
 
 using ..RecipesPipeline
 using ..Commons
@@ -347,22 +348,20 @@ function PlotsBase.attr!(axis::Axis, args...; kw...)
     return axis
 end
 
-function get_guide(axis::Axis)
-    if isnothing(axis[:unit]) || axis[:unitformat] ≡ :nounit
-        return axis[:guide]
+get_guide(axis::Axis) = if isnothing(axis[:guide])
+    ""
+elseif isnothing(axis[:unit]) || axis[:unitformat] ≡ :nounit
+    axis[:guide]
+else
+    unit = if axis[:unitformat] isa Function
+        axis[:unit]
+    elseif PlotsBase.backend_name() ≡ :pgfplotsx
+        latexify(axis[:unit])
     else
-        ustr = if PlotsBase.backend_name() ≡ :pgfplotsx
-            pgext = Base.get_extension(PlotsBase, :PGFPlotsXExt)
-            isnothing(pgext) && error("PGFPlotsX extension not loaded. Problems")
-            pgext.Latexify.latexify(axis[:unit])
-        else
-            string(axis[:unit])
-        end
-        if isempty(axis[:guide])
-            return ustr
-        end
-        return format_unit_label(axis[:guide], ustr, axis[:unitformat])
+        string(axis[:unit])
     end
+    isempty(string(axis[:guide])) && return unit
+    format_unit_label(axis[:guide], unit, axis[:unitformat])
 end
 
 # Keyword options for unit formats

PlotsBase/src/PlotsBase.jl

@@ -7,16 +7,6 @@ if isdefined(Base, :Experimental) && isdefined(Base.Experimental, Symbol("@max_m
     @eval Base.Experimental.@max_methods 1
 end
 
-# multiple weakdeps triggers (keep in sync with Project.toml !)
-const WEAKDEPS = Expr(
-    :block,
-    :(import UnitfulLatexify),
-    :(import LaTeXStrings),
-    :(import Latexify),
-    :(import Contour),
-    :(import Colors),
-)
-
 using Base.Meta
 
 import PrecompileTools

PlotsBase/test/Project.toml

@@ -40,5 +40,4 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
 UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
-UnitfulLatexify = "45397f5d-5981-4c77-b2b3-fc36d6e9b728"
 VisualRegressionTests = "34922c18-7c2a-561c-bac1-01e79b2c4c92"

PlotsBase/test/runtests.jl

@@ -14,7 +14,6 @@ get!(ENV, "MPLBACKEND", "agg")
 get!(ENV, "PLOTSBASE_PLOTLYJS_UNSAFE_ELECTRON", "true")
 
 using PlotsBase
-eval(PlotsBase.WEAKDEPS)
 
 # initialize all backends
 for pkg in TEST_PACKAGES

PlotsBase/test/test_axes.jl

@@ -281,3 +281,20 @@ end
         end
     end
 end
+
+@testset "axis guides (labels)" begin
+    yguide(pl, idx = length(pl.subplots)) = PlotsBase.get_guide(pl.subplots[idx].attr[:yaxis])
+
+    @test yguide(plot(1:3, ylabel = "hello")) == "hello"
+    @test yguide(plot(1:3, ylabel = L"hello")) == L"hello"
+    @test yguide(plot(1:3, ylabel = :hello)) == :hello
+
+    @test yguide(plot(1:3, yunit = 1)) == "1"
+    @test yguide(plot(1:3, yunit = 1, ylabel = :hello)) == "hello (1)"
+    @test yguide(plot(1:3, yunit = 1, ylabel = :hello, unitformat = :square)) == "hello [1]"
+    @test yguide(plot(1:3, yunit = 1, ylabel = nothing, unitformat = :square)) == ""
+    @test yguide(plot(1:3, yunit = 1, ylabel = L"hello")) == L"hello" * " (1)"
+
+    uf = (l, u) -> Symbol(l, "_symb_", u)
+    @test yguide(plot(1:3, yunit = 1, ylabel = :hello, unitformat = uf)) == :hello_symb_1
+end

PlotsBase/test/test_preferences.jl

@@ -72,8 +72,6 @@ end
         write(
             script,
             """
-            $(PlotsBase.WEAKDEPS)
-
             import $pkg
             using Test, PlotsBase
 

PlotsBase/test/test_quality.jl

@@ -3,7 +3,7 @@
     # :CondaPkg stale deps show up when running CI
     Aqua.test_all(
         PlotsBase;
-        stale_deps = (; ignore = [:CondaPkg]),
+        stale_deps = (; ignore = [:Colors, :Contour, :LaTeXStrings, :Latexify, :CondaPkg]),
         persistent_tasks = false,
         ambiguities = false,
         deps_compat = false,  # FIXME: fails `CondaPkg`

PlotsBase/test/test_unitful.jl

@@ -1,5 +1,6 @@
 using PlotsBase, Test
 using Unitful
+using Latexify
 using Unitful: m, cm, s, DimensionError
 # Some helper functions to access the subplot labels and the series inside each test plot
 xguide(pl, idx = length(pl.subplots)) = PlotsBase.get_guide(pl.subplots[idx].attr[:xaxis])
@@ -292,6 +293,17 @@ end
         @test contourf(x, y, z) isa PlotsBase.Plot
     end
 
+    @testset "latexify as unitformat" begin
+        y = rand(10) * u"m^-1"
+        Latexify.set_default(labelformat = :slash)
+        @test yguide(plot(y, ylabel = "hello", unitformat = latexify)) == "\$hello\\;\\left/\\;\\mathrm{m}^{-1}\\right.\$"
+
+        uf = (l, u) -> l * " (" * latexify(u) * ")"
+        @test yguide(plot(y, ylabel = "hello", unitformat = uf)) == "hello (\$\\mathrm{m}^{-1}\$)"
+        Latexify.set_default(labelformat = :square)
+        @test yguide(plot(y, ylabel = "hello", unitformat = latexify)) == "\$hello\\;\\left[\\mathrm{m}^{-1}\\right]\$"
+    end
+
     @testset "colorbar title" begin
         x, y = (1:0.01:2) * m, (1:0.02:2) * s
         z = x' ./ y
@@ -301,6 +313,8 @@ end
         @test ctitle(pl) ∈ ["km hr^-1", "km hr⁻¹"]
         pl = heatmap(x, y, z, zunit = u"cm/s", zunitformat = :square, colorbar_title = "v")
         @test ctitle(pl) ∈ ["v [cm s^-1]", "v [cm s⁻¹]"]
+        pl = heatmap(x, y, z, zunit = u"cm/s", zunitformat = :nounit, colorbar_title = nothing)
+        @test ctitle(pl) == ""
     end
 
     @testset "twinx (#4750)" begin