Move checking of parameter values into constructor

Author: Zentrik

src/execution.jl

@@ -110,10 +110,6 @@ end
 function _run(b::Benchmark, p::Parameters; verbose=false, pad="", warmup=true, kwargs...)
     params = Parameters(p; kwargs...)
     @assert params.seconds > 0.0 "time limit must be greater than 0.0"
-    @assert params.enable_customisable_func in (:FALSE, :ALL, :LAST) "invalid value $(params.enable_customisable_func) for enable_customisable_func which must be :FALSE, :ALL or :LAST"
-    @assert !(
-        params.run_customisable_func_only && params.enable_customisable_func == :FALSE
-    ) "run_customisable_func_only is set to true, but enable_customisable_func is set to :FALSE"
     if warmup #warmup sample
         params.run_customisable_func_only &&
             b.samplefunc(b.quote_vals, Parameters(params; evals=1))

src/parameters.jl

@@ -23,6 +23,60 @@ mutable struct Parameters{A,B}
     sample_result
     prehook::A
     posthook::B
+
+    function Parameters{A,B}(
+        seconds,
+        samples,
+        evals,
+        evals_set,
+        overhead,
+        gctrial,
+        gcsample,
+        time_tolerance,
+        memory_tolerance,
+        run_customisable_func_only,
+        enable_customisable_func,
+        customisable_gcsample,
+        setup_prehook,
+        teardown_posthook,
+        sample_result,
+        prehook::A,
+        posthook::B,
+    ) where {A,B}
+        if enable_customisable_func ∉ (:FALSE, :ALL, :LAST)
+            throw(
+                ArgumentError(
+                    "invalid value $(enable_customisable_func) for enable_customisable_func which must be :FALSE, :ALL or :LAST",
+                ),
+            )
+        end
+        if run_customisable_func_only && enable_customisable_func == :FALSE
+            throw(
+                ArgumentError(
+                    "run_customisable_func_only is set to true, but enable_customisable_func is set to :FALSE",
+                ),
+            )
+        end
+        return new(
+            seconds,
+            samples,
+            evals,
+            evals_set,
+            overhead,
+            gctrial,
+            gcsample,
+            time_tolerance,
+            memory_tolerance,
+            run_customisable_func_only,
+            enable_customisable_func,
+            customisable_gcsample,
+            setup_prehook,
+            teardown_posthook,
+            sample_result,
+            prehook,
+            posthook,
+        )
+    end
 end
 
 # https://github.com/JuliaLang/julia/issues/17186

src/serialization.jl

@@ -70,18 +70,10 @@ function recover(x::Vector)
                 # These fields should all be >= 0, so we can ignore -Inf case
                 typemax(ft)
             elseif fn == "enable_customisable_func"
-                if !haskey(fields, fn) || fields[fn] == "FALSE"
+                if !haskey(fields, fn)
                     :FALSE
-                elseif fields[fn] == "LAST"
-                    :LAST
-                elseif fields[fn] == "ALL"
-                    :ALL
                 else
-                    throw(
-                        ArgumentError(
-                            "Invalid value $(fields[fn]) for enable_customisable_func which must be one of :ALL, :LAST, :FALSE",
-                        ),
-                    )
+                    Symbol(fields[fn])
                 end
             elseif fn in (
                 "run_customisable_func_only",

test/ParametersTests.jl

@@ -87,4 +87,23 @@ BenchmarkTools.DEFAULT_PARAMETERS.setup_prehook = old_setup_prehook
 BenchmarkTools.DEFAULT_PARAMETERS.teardown_posthook = old_teardown_posthook
 BenchmarkTools.DEFAULT_PARAMETERS.sample_result = old_sample_result
 
+for vals in (false, true, :ARST, :TRUE, :false, :ON)
+    @test_throws ArgumentError Parameters(p; enable_customisable_func=vals)
+    @test_throws ArgumentError Parameters(; enable_customisable_func=vals)
+end
+
+@test_throws ArgumentError Parameters(;
+    enable_customisable_func=:FALSE, run_customisable_func_only=true
+)
+@test_nowarn Parameters(; enable_customisable_func=:FALSE, run_customisable_func_only=false)
+for run_customisable_func_only in (false, true)
+    @test_nowarn Parameters(;
+        enable_customisable_func=:ALL, run_customisable_func_only=run_customisable_func_only
+    )
+    @test_nowarn Parameters(;
+        enable_customisable_func=:LAST,
+        run_customisable_func_only=run_customisable_func_only,
+    )
+end
+
 end # module