refactor: warn in print methods inside Pluto

Author: AayushSabharwal

Project.toml

@@ -48,6 +48,7 @@ Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
 Nemo = "2edaba10-b0f1-5616-af89-8c11ac63239a"
+PlutoRunner = "dc6b355a-2368-4481-ae6d-ae0351418d79"
 PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
 SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
 SymPyPythonCall = "bc8888f7-b21e-4b7c-a06a-5d9c9496438c"
@@ -60,6 +61,7 @@ SymbolicsGroebnerExt = "Groebner"
 SymbolicsLatexifyExt = ["Latexify", "LaTeXStrings"]
 SymbolicsLuxExt = "Lux"
 SymbolicsNemoExt = "Nemo"
+SymbolicsPlutoRunnerExt = "PlutoRunner"
 SymbolicsPreallocationToolsExt = ["PreallocationTools", "ForwardDiff"]
 SymbolicsSymPyExt = "SymPy"
 SymbolicsSymPyPythonCallExt = "SymPyPythonCall"

ext/SymbolicsPlutoRunnerExt.jl

@@ -0,0 +1,18 @@
+module SymbolicsPlutoRunnerExt
+
+import Symbolics
+
+const WARNED_LATEXIFY = Ref(false)
+
+function Symbolics.warn_load_latexify(::Nothing)
+    Base.get_extension(Symbolics, :SymbolicsLatexifyExt) === nothing || return
+    WARNED_LATEXIFY[] && return
+    @warn """
+    Attempting to print a symbolic expression in a Pluto notebook. Please run \
+    `import Latexify` to enable pretty-printing of symbolic expressions.
+    """
+    WARNED_LATEXIFY[] = true
+    return nothing
+end
+
+end

src/Symbolics.jl

@@ -81,6 +81,9 @@ const STerm = SymbolicUtils.Term{VartypeT}
 
 export simplify, substitute
 
+warn_load_latexify() = warn_load_latexify(nothing)
+warn_load_latexify(_) = nothing
+
 export Num
 import MacroTools: splitdef, combinedef, postwalk, striplines
 include("wrapper-types.jl")

src/arrays.jl

@@ -56,6 +56,7 @@ maybewrap(T) = has_symwrapper(T) ? wrapper_type(T) : T
 # wrapper_type(::Type{<:AbstractVector{T}}) where {T} = Arr{maybewrap(T), 1}
 
 function Base.show(io::IO, arr::Arr)
+    warn_load_latexify()
     x = unwrap(arr)
     iscall(x) && print(io, "(")
     print(io, unwrap(arr))

src/diff.jl

@@ -81,7 +81,10 @@ function Base.:^(D::Differential, n::Integer)
     return Differential(D.x, D.order * n)
 end
 
-Base.show(io::IO, D::Differential) = print(io, "Differential(", D.x, ", ", D.order, ")")
+function Base.show(io::IO, D::Differential)
+    warn_load_latexify()
+    print(io, "Differential(", D.x, ", ", D.order, ")")
+end
 Base.nameof(D::Differential) = :Differential
 
 Base.:(==)(D1::Differential, D2::Differential) = isequal(D1.x, D2.x) && isequal(D1.order, D2.order)

src/equations.jl

@@ -23,6 +23,7 @@ Base.:(==)(a::Equation, b::Equation) = isequal(a.lhs, b.lhs) && isequal(a.rhs, b
 Base.hash(a::Equation, salt::UInt) = hash(a.lhs, hash(a.rhs, salt))
 
 function Base.show(io::IO, eq::Equation)
+    warn_load_latexify()
     if hide_lhs(eq.lhs)
         show(io, eq.rhs)
     else

src/inequality.jl

@@ -32,6 +32,7 @@ function SymbolicUtils.scalarize(ineq::Inequality)
 end
 
 function Base.show(io::IO, ineq::Inequality)
+    warn_load_latexify()
     print(io, ineq.lhs, ineq.relational_op == leq ? " ≲ " : " ≳ ", ineq.rhs)
 end
 

src/num.jl

@@ -189,6 +189,7 @@ Base.:^(z::Complex{Num}, n::Integer) = Base.power_by_squaring(z, n)
 Base.:^(::Irrational{:ℯ}, x::Num) = exp(x)
 
 function Base.show(io::IO, z::Complex{<:Num})
+    warn_load_latexify()
     r, i = reim(z)
     compact = get(io, :compact, false)
     show(io, r)
@@ -206,6 +207,7 @@ Base.isone(x::Num) = SymbolicUtils.fraction_isone(unwrap(x))
 import SymbolicUtils: <ₑ, Term, operation, arguments
 
 function Base.show(io::IO, n::Num)
+    warn_load_latexify()
     show_numwrap[] ? print(io, :(Num($(value(n))))) : Base.show(io, value(n))
 end
 

src/variable.jl

@@ -564,6 +564,7 @@ Base.isequal(a::CallAndWrap, b::BasicSymbolic{VartypeT}) = isequal(a.f,  b)
 Base.hash(x::CallAndWrap, h::UInt) = hash(x.f, h)
 
 function Base.show(io::IO, caw::CallAndWrap)
+    warn_load_latexify()
     show(io, caw.f)
     print(io, "⋆")
 end