Filter out rules that require config

Author: oxinabox

src/ruleset_loading.jl

@@ -52,15 +52,22 @@ clear_new_rule_hooks!(rule_kind) = empty!(_hook_list(rule_kind))
     _rule_list(frule | rrule)
 
 Returns a list of all the methods of the currently defined rules of the given kind.
-Excluding the fallback rule that returns `nothing` for every input.
+Excluding the fallback rule that returns `nothing` for every input;
+and excluding rules that require a particular `RuleConfig`.
 """
-function _rule_list end
-_rule_list(rule_kind) = (m for m in methods(rule_kind) if !_is_fallback(rule_kind, m))
+function _rule_list(rule_kind)
+    return Iterators.filter(methods(rule_kind)) do m
+        !_is_fallback(rule_kind, m) && !_requires_config(m)
+    end
+end
 
 "check if this is the fallback-frule/rrule that always returns `nothing`"
 _is_fallback(::typeof(rrule), m::Method) = m.sig === Tuple{typeof(rrule),Any,Vararg{Any}}
 _is_fallback(::typeof(frule), m::Method) = m.sig === Tuple{typeof(frule),Any,Any,Vararg{Any}}
 
+"check if this rule requires a particular configuation (`RuleConfig`)"
+_requires_config(m::Method) = m.sig.parameters[2] <: RuleConfig
+
 const LAST_REFRESH_RRULE = Ref(0)
 const LAST_REFRESH_FRULE = Ref(0)
 last_refresh(::typeof(frule)) = LAST_REFRESH_FRULE

test/ruleset_loading.jl

@@ -75,4 +75,29 @@
         @test _is_fallback(rrule, first(methods(rrule, (Nothing,))))
         @test _is_fallback(frule, first(methods(frule, (Tuple{}, Nothing,))))
     end
+
+    @test "_rule_list" begin
+        _rule_list = ChainRulesOverloadGeneration._rule_list
+        @testset "should not have frules that need RuleConfig" begin
+            old_frule_list = collect(_rule_list(frule))
+            function ChainRulesCore.frule(
+                ::RuleConfig{>:Union{HasForwardsMode,HasReverseMode}}, dargs, sum, f, xs
+            )
+                return 1.0, 1.0 # this will not be call so return doesn't matter
+            end
+            # New rule should not have appeared
+            @test collect(_rule_list(frule)) == old_frule_list
+        end
+
+        @testset "should not have rrules that need RuleConfig" begin
+            old_rrule_list = collect(_rule_list(rrule))
+            function ChainRulesCore.rrule(
+                ::RuleConfig{>:Union{HasForwardsMode,HasReverseMode}}, sum, f, xs
+            )
+                return 1.0, x->(x,x,x) # this will not be call so return doesn't matter
+            end
+            # New rule should not have appeared
+            @test collect(_rule_list(rrule)) == old_rrule_list
+        end
+    end
 end