test: more coverage of EvalOptions branches

Author: MilesCranmer

src/Evaluate.jl

@@ -1,6 +1,6 @@
 module EvaluateModule
 
-using DispatchDoctor: @unstable
+using DispatchDoctor: @stable, @unstable
 
 import ..NodeModule: AbstractExpressionNode, constructorof
 import ..StringsModule: string_tree
@@ -51,39 +51,53 @@ struct EvalOptions{T,B,E}
     early_exit::Val{E}
 end
 
-@inline _to_bool_val(x::Bool) = x ? Val(true) : Val(false)
-@inline _to_bool_val(x::Val{T}) where {T} = Val(T::Bool)
-
-function EvalOptions(;
-    turbo::Union{Bool,Val}=Val(false),
-    bumper::Union{Bool,Val}=Val(false),
-    early_exit::Union{Bool,Val}=Val(true),
+@stable(
+    default_mode = "disable",
+    default_union_limit = 2,
+    @inline _to_bool_val(x::Bool) = x ? Val(true) : Val(false)
 )
-    return EvalOptions(_to_bool_val(turbo), _to_bool_val(bumper), _to_bool_val(early_exit))
-end
-
-function _process_deprecated_kws(eval_options, deprecated_kws)
-    turbo = get(deprecated_kws, :turbo, nothing)
-    bumper = get(deprecated_kws, :bumper, nothing)
-    if any(Base.Fix2(∉, (:turbo, :bumper)), keys(deprecated_kws))
-        throw(ArgumentError("Invalid keyword argument(s): $(keys(deprecated_kws))"))
-    end
-    if !isempty(deprecated_kws)
-        @assert eval_options === nothing "Cannot use both `eval_options` and deprecated flags `turbo` and `bumper`."
-        Base.depwarn(
-            "The `turbo` and `bumper` keyword arguments are deprecated. Please use `eval_options` instead.",
-            :eval_tree_array,
-        )
-    end
-    if eval_options !== nothing
-        return eval_options
-    else
-        return EvalOptions(;
-            turbo=turbo === nothing ? Val(false) : turbo,
-            bumper=bumper === nothing ? Val(false) : bumper,
+@stable(default_mode = "disable", @inline _to_bool_val(x::Val{T}) where {T} = Val(T::Bool))
+
+@stable(
+    default_mode = "disable",
+    default_union_limit = 4,
+    begin
+        function EvalOptions(;
+            turbo::Union{Bool,Val}=Val(false),
+            bumper::Union{Bool,Val}=Val(false),
+            early_exit::Union{Bool,Val}=Val(true),
         )
+            return EvalOptions(
+                _to_bool_val(turbo), _to_bool_val(bumper), _to_bool_val(early_exit)
+            )
+        end
+
+        function _process_deprecated_kws(eval_options, deprecated_kws)
+            turbo = get(deprecated_kws, :turbo, nothing)
+            bumper = get(deprecated_kws, :bumper, nothing)
+            if any(Base.Fix2(∉, (:turbo, :bumper)), keys(deprecated_kws))
+                throw(
+                    ArgumentError("Invalid keyword argument(s): $(keys(deprecated_kws))")
+                )
+            end
+            if !isempty(deprecated_kws)
+                @assert eval_options === nothing "Cannot use both `eval_options` and deprecated flags `turbo` and `bumper`."
+                Base.depwarn(
+                    "The `turbo` and `bumper` keyword arguments are deprecated. Please use `eval_options` instead.",
+                    :eval_tree_array,
+                )
+            end
+            if eval_options !== nothing
+                return eval_options
+            else
+                return EvalOptions(;
+                    turbo=turbo === nothing ? Val(false) : turbo,
+                    bumper=bumper === nothing ? Val(false) : bumper,
+                )
+            end
+        end
     end
-end
+)
 
 """
     eval_tree_array(

test/test_deprecations.jl

@@ -1,6 +1,4 @@
-using DynamicExpressions
-using Test
-using Zygote
+using Test, DynamicExpressions, Zygote, LoopVectorization
 using Suppressor: @capture_err
 using DispatchDoctor: allow_unstable
 
@@ -47,6 +45,14 @@ if VERSION >= v"1.9"
     )
 end
 
+# Old usage of evaluation options
+if VERSION >= v"1.9-"
+    ex = Expression(Node{Float64}(; feature=1))
+    @test_logs (:warn, r"The `turbo` and `bumper` keyword arguments are deprecated.*") (ex(
+        randn(Float64, 1, 10), OperatorEnum(); turbo=true
+    ))
+end
+
 # Test deprecated modules
 logs = @capture_err begin
     @eval using DynamicExpressions.EquationModule

test/test_evaluation.jl

@@ -271,3 +271,15 @@ end
         @test !isfinite(y[2])
     end
 end
+
+@testitem "Test EvalOptions constructor" begin
+    using DynamicExpressions, LoopVectorization
+
+    @test EvalOptions(; turbo=true) isa EvalOptions{true}
+    @test EvalOptions(; turbo=Val(true)) isa EvalOptions{true}
+    @test EvalOptions(; turbo=false) isa EvalOptions{false}
+    @test EvalOptions(; turbo=Val(false)) isa EvalOptions{false}
+
+    ex = Expression(Node{Float64}(; feature=1))
+    @test_throws ArgumentError ex(randn(1, 5), OperatorEnum(); bad_arg=1)
+end