Skip Base and Core by default in install_speculator

Author: jakobjpeters

.github/workflows/regenerate_readme.yml

@@ -20,5 +20,5 @@ jobs:
       - run: |
           git config user.name github-actions
           git config user.email github-actions@github.com
-          git diff --quiet || (git add . && git commit -m "Regenerate `README.md`")
+          git diff --quiet || (git add . && git commit -m 'Regenerate `README.md`')
           git push

NEWS.md

@@ -3,22 +3,12 @@
 
 ## v0.1.0
 
-- `speculate(predicate, value; parameters...)`: Search for compilation directives
-    - `predicate`: Filter values found in a `Module`
-    - `value`: The initial value to search
-    - `parameters`
-        - `background`: Whether to search in a background process
-        - `dry`: Whether to call `precompile` on generated methods
-        - `limit`:
-            The maximum number of compilable methods that may be generated from a generic method
-        - `path`: A file to write compilation directives to
-        - `verbosity`: Specifies which logging statements to show
-- Input Speculators
-    - `install_speculator`: Automatically calls `speculate` on values input to the REPL
-    - `uninstall_speculator`: Removes the automatic input speculator
-- `Verbosity`: A set used to specify which logging statements to show
+- `speculate`: Search for compilation directives
+- `install_speculator`: Automatically calls `speculate` on values input to the REPL
+- `uninstall_speculator`: Removes the automatic input speculator
+- `Verbosity`: A set used to specify which logging statements to show in `speculate`
     - `debug`: Shows each successful compilation directive
     - `review`: Summarizes the generated compilation directives
     - `silent`: Shows no logging statements
     - `warn`: Shows each unsuccessful compilation directive
-- `all_modules::AllModules`: A value used to `speculate` each loaded module
+- `all_modules::AllModules`: A singleton constant used to `speculate` every loaded module

docs/source/index.md

@@ -3,7 +3,7 @@
 
 ## Introduction
 
-Speculator.jl reduces latency by automatically searching for compilation directives.
+Speculator.jl reduces latency by automatically searching for compilable methods.
 
 ## Usage
 

src/input_speculators.jl

@@ -24,9 +24,11 @@ function install_speculator!(
 end
 
 """
-    install_speculator(predicate = Returns(true); background::Bool = true, parameters...)
+    install_speculator(
+        predicate = (m, _) -> m ∉ [Base, Core]; background::Bool = true,
+    parameters...)
 
-Install an input speculator that calls
+Install a hook that calls
 `speculate(predicate,\u00A0value;\u00A0background,\u00A0parameters...)`
 on each input `value` in the REPL.
 
@@ -53,7 +55,9 @@ julia> g(::Union{String, Symbol}) = nothing;
 [ Info: Compiled `Main.Example.g(::Symbol)`
 ```
 """
-function install_speculator(predicate = default_predicate; background::Bool = true, parameters...)
+function install_speculator(
+    predicate = (m, _) -> m ∉ [Base, Core]; background::Bool = true, parameters...
+)
     @nospecialize
     if isinteractive()
         if is_repl_ready()

src/speculate.jl

@@ -170,15 +170,15 @@ end
     speculate(predicate, value; parameters...)
     speculate(value; parameters...)
 
-Search for compilation directives.
+Search for compilable methods.
 
 See also [`install_speculator`](@ref).
 
 !!! tip
     Use this in a package to reduce latency.
 
 !!! note
-    Speculation only runs when called during precompilation or an interactive session,
+    This only runs when called during precompilation or an interactive session,
     or when writing precompilation directives to a file.
 
 # Parameters
@@ -189,10 +189,9 @@ See also [`install_speculator`](@ref).
     whereas returning `false` specifies to ignore the value.
     This is called when searching the names of a `Module` if the
     given module and name satisfy `isdefined` and `!isdeprecated`.
-    The default predicate `Returns(true)` will search everything possible,
-    up to the generic `limit`, whereas the predicate
-    `Returns(false)` will only generate methods from
-    callable values passed directly to `speculate`.
+    The default predicate `Returns(true)` will search every value,
+    whereas the predicate `Returns(false)` will only generate
+    methods from callable values passed directly to `speculate`.
     Some useful predicates include `Base.isexported`,
     `Base.ispublic`, and checking properties of the value itself.
 - `value`:
@@ -205,7 +204,7 @@ See also [`install_speculator`](@ref).
 # Keyword parameters
 
 - `background::Bool = false`:
-    Specifies whether to precompile on a thread in the `:default` pool.
+    Specifies whether to run on a thread in the `:default` pool.
     The number of available threads can be determined using `Threads.nthreads(:default)`.
 - `dry::Bool = false`:
     Specifies whether to run `precompile` on generated method signatures.

test/runtests.jl

@@ -58,6 +58,8 @@ end
     @test isempty(silent)
     @test !isempty(debug)
     @test issetequal(silent ∪ debug ∪ review, debug ∪ review)
+    @test setdiff(debug, debug) == silent
+    @test setdiff(review ∪ debug, debug) == review
 end
 
 @testset "`initialize_parameters`" begin
@@ -130,8 +132,8 @@ end
 
 path = tempname()
 f() = nothing
-@test_logs (:info, "Compiled `Main.f()`") speculate(f; path, verbosity = debug)
-@test_logs (:info, "Skipped `Main.f()`") speculate(f; path, verbosity = debug)
+@test_logs (:info, r"Compiled `.*f\(\)`") speculate(f; path, verbosity = debug)
+@test_logs (:info, r"Skipped `.*f\(\)`") speculate(f; path, verbosity = debug)
 
 @test_throws ErrorException Speculator.wait_for_repl()