working Preferences

Author: t-bltg

Project.toml

@@ -21,6 +21,7 @@ NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PlotThemes = "ccf2f8ad-2431-5c83-bf29-c5338b663b6a"
 PlotUtils = "995b91a9-d308-5afd-9ec6-746e21dbc043"
+Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
@@ -58,6 +59,7 @@ PlotUtils = "1"
 PlotlyBase = "0.7 - 0.8"
 PlotlyJS = "0.18"
 PlotlyKaleido = "1"
+Preferences = "1"
 PyCall = "1"
 PyPlot = "2"
 RecipesBase = "1.3.1"

src/Plots.jl

@@ -29,11 +29,8 @@ function _check_compat(sim::Module)
     end
 end
 
-using Dates, Printf, Statistics, Base64, LinearAlgebra, Random
-using SparseArrays
-using Base.Meta
-using Requires
-using Reexport
+using Base.Meta, Dates, Printf, Statistics, Base64, LinearAlgebra, SparseArrays, Random
+using SnoopPrecompile, Preferences, Requires, Reexport
 using Unzip
 @reexport using RecipesBase
 @reexport using PlotThemes
@@ -167,6 +164,7 @@ using .PlotMeasures
 import .PlotMeasures: Length, AbsoluteLength, Measure, width, height
 # ---------------------------------------------------------
 
+const PLOTS_SEED  = 1234
 const PX_PER_INCH = 100
 const DPI         = PX_PER_INCH
 const MM_PER_INCH = 25.4
@@ -193,20 +191,10 @@ include("backends.jl")
 include("output.jl")
 include("ijulia.jl")
 include("fileio.jl")
+include("shorthands.jl")
+include("backends/web.jl")
 
-# Use fixed version of Plotly instead of the latest one for stable dependency
-# Ref: https://github.com/JuliaPlots/Plots.jl/pull/2779
-const _plotly_min_js_filename = "plotly-2.6.3.min.js"
 const CURRENT_BACKEND = CurrentBackend(:none)
-const PLOTS_SEED = 1234
-
 include("init.jl")
 
-include("backends/plotly.jl")
-include("backends/web.jl")
-include("backends/gr.jl")
-
-include("shorthands.jl")
-include("precompile.jl")
-
 end

src/backends.jl

@@ -16,6 +16,7 @@ backend_name() = CURRENT_BACKEND.sym
 _backend_instance(sym::Symbol)::AbstractBackend =
     haskey(_backendType, sym) ? _backendType[sym]() : error("Unsupported backend $sym")
 
+backend_package_name() = _backend_packages[backend_name()]
 backend_package_name(sym::Symbol) = _backend_packages[sym]
 
 macro init_backend(s)
@@ -131,21 +132,20 @@ CurrentBackend(sym::Symbol) = CurrentBackend(sym, _backend_instance(sym))
 
 # ---------------------------------------------------------
 
-_fallback_default_backend() = backend(GRBackend())
-
-function _pick_default_backend()
-    if (env_default = get(ENV, "PLOTS_DEFAULT_BACKEND", "")) != ""
-        if (sym = Symbol(lowercase(env_default))) in _backends
-            backend(sym)
-        else
-            @warn """You have set PLOTS_DEFAULT_BACKEND=$env_default, but it is not a valid backend package.
-            Choose from: \n\t$(join(sort(_backends), "\n\t"))
-            """
-            _fallback_default_backend()
-        end
-    else
-        _fallback_default_backend()
-    end
+function load_default_backend()
+    default_backend = get(ENV, "PLOTS_DEFAULT_BACKEND", "gr")
+    CURRENT_BACKEND.sym = @load_preference("backend", default_backend) |> lowercase |> Symbol
+    backend(CURRENT_BACKEND.sym)
+    nothing
+end
+
+set_backend!(backend::Union{AbstractString,Symbol} = "gr"; kw...) =
+    set_preferences!(Plots, "backend" => lowercase(string(backend)); kw...)
+
+function diagnostics()
+    from_env = haskey(ENV, "PLOTS_DEFAULT_BACKEND")
+    @info "Selected `Plots` backend: $(backend()), from $(from_env ? "environment variable" : "`Preferences`")"
+    nothing
 end
 
 # ---------------------------------------------------------
@@ -154,16 +154,18 @@ end
 Returns the current plotting package name.  Initializes package on first call.
 """
 function backend()
-    CURRENT_BACKEND.sym === :none && _pick_default_backend()
+    CURRENT_BACKEND.sym === :none && load_default_backend()
     CURRENT_BACKEND.pkg
 end
 
+initialized(sym::Symbol) = sym ∈ _initialized_backends
+
 """
 Set the plot backend.
 """
 function backend(pkg::AbstractBackend)
     sym = backend_name(pkg)
-    if sym ∉ _initialized_backends
+    if !initialized(sym)
         _initialize_backend(pkg)
         push!(_initialized_backends, sym)
     end
@@ -286,11 +288,6 @@ function _initialize_backend(pkg::AbstractBackend)
     end
 end
 
-# ------------------------------------------------------------------------------
-# gr
-
-_initialize_backend(pkg::GRBackend) = nothing  # COV_EXCL_LINE
-
 const _gr_attr = merge_with_base_supported([
     :annotations,
     :legend_background_color,

src/backends/gr.jl

@@ -1,8 +1,5 @@
 # https://github.com/jheinen/GR.jl - significant contributions by @jheinen
 
-import GR
-export GR
-
 const gr_projections = (auto = 1, ortho = 1, orthographic = 1, persp = 2, perspective = 2)
 const gr_linetypes = (auto = 1, solid = 1, dash = 2, dot = 3, dashdot = 4, dashdotdot = -1)
 const gr_fill_styles = ((/) = 9, (\) = 10, (|) = 7, (-) = 8, (+) = 11, (x) = 6)

src/init.jl

@@ -3,16 +3,12 @@ using Scratch
 using REPL
 
 const plotly_local_file_path = Ref{Union{Nothing,String}}(nothing)
-const BACKEND_PATH_GASTON = @path joinpath(@__DIR__, "backends", "gaston.jl")
-const BACKEND_PATH_HDF5 = @path joinpath(@__DIR__, "backends", "hdf5.jl")
-const BACKEND_PATH_INSPECTDR = @path joinpath(@__DIR__, "backends", "inspectdr.jl")
-const BACKEND_PATH_PLOTLYBASE = @path joinpath(@__DIR__, "backends", "plotlybase.jl")
-const BACKEND_PATH_PGFPLOTS =
-    @path joinpath(@__DIR__, "backends", "deprecated", "pgfplots.jl")
-const BACKEND_PATH_PGFPLOTSX = @path joinpath(@__DIR__, "backends", "pgfplotsx.jl")
-const BACKEND_PATH_PLOTLYJS = @path joinpath(@__DIR__, "backends", "plotlyjs.jl")
-const BACKEND_PATH_PYPLOT = @path joinpath(@__DIR__, "backends", "pyplot.jl")
-const BACKEND_PATH_UNICODEPLOTS = @path joinpath(@__DIR__, "backends", "unicodeplots.jl")
+
+backend_path(sym) = @path joinpath(@__DIR__, "backends", "$sym.jl")
+
+# Use fixed version of Plotly instead of the latest one for stable dependency
+# Ref: https://github.com/JuliaPlots/Plots.jl/pull/2779
+const _plotly_min_js_filename = "plotly-2.6.3.min.js"
 
 _plots_defaults() =
     if isdefined(Main, :PLOTS_DEFAULTS)
@@ -64,44 +60,50 @@ function __init__()
         end,
     )
 
-    @require HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f" begin
-        include(BACKEND_PATH_HDF5)
+    _plots_plotly_defaults()
+
+    @require GR = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71" begin
+        initialized(:gr) || include(backend_path(:gr))
     end
 
-    @require InspectDR = "d0351b0e-4b05-5898-87b3-e2a8edfddd1d" begin
-        include(BACKEND_PATH_INSPECTDR)
+    @require PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee" begin
+        initialized(:pyplot) || include(backend_path(:pyplot))
     end
 
     @require PGFPlots = "3b7a836e-365b-5785-a47d-02c71176b4aa" begin
-        include(BACKEND_PATH_PGFPLOTS)
+        initialized(:pgfplots) || include(backend_path(:pgfplots))
+    end
+
+    @require PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925" begin
+        initialized(:pgfplotsx) || include(backend_path(:pgfplotsx))
     end
 
     @require PlotlyBase = "a03496cd-edff-5a9b-9e67-9cda94a718b5" begin
         @require PlotlyKaleido = "f2990250-8cf9-495f-b13a-cce12b45703c" begin
-            include(BACKEND_PATH_PLOTLYBASE)
+            initialized(:plotly) || include(backend_path(:plotly))
+            initialized(:plotlybase) || include(backend_path(:plotlybase))
         end
     end
 
-    @require PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925" begin
-        include(BACKEND_PATH_PGFPLOTSX)
-    end
-
     @require PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a" begin
-        include(BACKEND_PATH_PLOTLYJS)
+        initialized(:plotly) || include(backend_path(:plotly))
+        initialized(:plotlyjs) || include(backend_path(:plotlyjs))
     end
 
-    _plots_plotly_defaults()
+    @require UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228" begin
+        initialized(:unicodeplots) || include(backend_path(:unicodeplots))
+    end
 
-    @require PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee" begin
-        include(BACKEND_PATH_PYPLOT)
+    @require Gaston = "4b11ee91-296f-5714-9832-002c20994614" begin
+        initialized(:gaston) || include(backend_path(:gaston))
     end
 
-    @require UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228" begin
-        include(BACKEND_PATH_UNICODEPLOTS)
+    @require InspectDR = "d0351b0e-4b05-5898-87b3-e2a8edfddd1d" begin
+        initialized(:inspectdr) || include(backend_path(:inspectdr))
     end
 
-    @require Gaston = "4b11ee91-296f-5714-9832-002c20994614" begin
-        include(BACKEND_PATH_GASTON)
+    @require HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f" begin
+        initialized(:hdf5) || include(backend_path(:hdf5))
     end
 
     @require IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a" begin
@@ -163,3 +165,46 @@ function __init__()
         @reexport using .UnitfulRecipes
     end
 end
+
+##################################################################
+backend()  # get from `Preferences` or env, and initialize backend
+
+# needs to be split from `init` for precompilation, because `__init__` is ran after parsing
+@eval const $(backend_package_name()) = Main.$(backend_package_name())
+
+include(backend_path(backend_name()))
+
+# COV_EXCL_START
+if get(ENV, "PLOTS_PRECOMPILE", "true") == "true"
+    @precompile_setup begin
+        n = length(_examples)
+        imports = sizehint!(Expr[], n)
+        examples = sizehint!(Expr[], 10n)
+        for i in setdiff(1:n, _backend_skips[backend_name()], _animation_examples)
+            _examples[i].external && continue
+            (imp = _examples[i].imports) === nothing || push!(imports, imp)
+            func = gensym(string(i))
+            push!(examples, quote
+                $func() = begin  # evaluate each example in a local scope
+                    $(_examples[i].exprs)
+                    if $i == 1  # only for one example
+                        fn = tempname()
+                        pl = current()
+                        show(devnull, pl)
+                        Sys.iswindows() || savefig(pl, "$fn.png")
+                        Sys.iswindows() || savefig(pl, "$fn.pdf")
+                    end
+                    nothing
+                end
+                $func()
+            end)
+        end
+        withenv("GKSwstype" => "nul") do
+            @precompile_all_calls begin
+                eval.(imports)
+                eval.(examples)
+            end
+        end
+    end
+end
+# COV_EXCL_STOP