Simplify/cleanup

Author: quinnj

src/LoggingExtras.jl

@@ -53,7 +53,6 @@ include("formatlogger.jl")
 include("datetime_rotation.jl")
 include("overridelogger.jl")
 include("verbosity.jl")
-include("util.jl")
 include("deprecated.jl")
 
 end # module

src/util.jl

@@ -1,24 +1,85 @@
-"""Calls @debug with the passed verbosity level"""
+function restore_callsite_source_position!(expr, src)
+    # used to fix the logging source file + line
+    # since we're lowering our verbose logging macros to the
+    # Logging.jl macros; otherwise, they would always report this (verbosity.jl)
+    # file as the logging callsite
+    expr.args[1].args[2] = src
+    return expr
+end
+
+vlogmacrodocs = """
+    @debugv N msg args...
+    @infov N msg args...
+    @warnv N msg args...
+    @errorv N msg args...
+
+"Verbose" logging macros. Drop in replacements of standard logging macros, but an
+additional verbosity level `N` is passed to indicate differing verbosity levels
+for a given log level. The verbosity argument is passed as the `group` argument
+to the core logging logic, so care should be taken if other loggers are being used
+that also use the group argument (which by default is passed the source file).
+
+The default logger doesn't have support for filtering on the `group` argument,
+so an `LoggingExtras.EarlyFilteredLogger` can be used. For convenience, a
+[`LoggintExtras.with(f; level, verbosity)`](@ref) function is provided to temporarily
+wrap the current logger with a level/verbosity filter while `f` is executed.
+"""
+
 macro debugv(verbosity::Int64, msg, exs...)
-    return esc(:($Base.@debug $msg verbosity=$verbosity $(exs...)))
+    return restore_callsite_source_position!(
+        esc(:($Base.@debug $msg _group=$verbosity $(exs...))),
+        __source__,
+    )
 end
 
-"""Calls @info with the passed verbosity level"""
 macro infov(verbosity::Int64, msg, exs...)
-    return esc(:($Base.@info $msg verbosity=$verbosity $(exs...)))
+    return restore_callsite_source_position!(
+        esc(:($Base.@info $msg _group=$verbosity $(exs...))),
+        __source__,
+    )
 end
 
-"""Calls @warn with the passed verbosity level"""
 macro warnv(verbosity::Int64, msg, exs...)
-    return esc(:($Base.@warn $msg verbosity=$verbosity $(exs...)))
+    return restore_callsite_source_position!(
+        esc(:($Base.@warn $msg _group=$verbosity $(exs...))),
+        __source__,
+    )
 end
 
-"""Calls @error with the passed verbosity level"""
 macro errorv(verbosity::Int64, msg, exs...)
-    return esc(:($Base.@error $msg verbosity=$verbosity $(exs...)))
+    return restore_callsite_source_position!(
+        esc(:($Base.@error $msg _group=$verbosity $(exs...))),
+        __source__,
+    )
 end
 
-"""Calls @error with the passed verbosity level"""
 macro logmsgv(verbosity::Int64, level, msg, exs...)
-    return esc(:($Base.@logmsgv $level $msg verbosity=$verbosity $(exs...)))
+    return restore_callsite_source_position!(
+        esc(:($Base.@logmsg $level $msg _group=$verbosity $(exs...))),
+        __source__,
+    )
+end
+
+@eval @doc $vlogmacrodocs :(@logmsgv)
+@eval @doc $vlogmacrodocs :(@debugv)
+@eval @doc $vlogmacrodocs :(@infov)
+@eval @doc $vlogmacrodocs :(@warnv)
+@eval @doc $vlogmacrodocs :(@errorv)
+
+"""
+    LoggingExtras.with(f; level=Info, verbosity=0)
+
+Convenience function like `Logging.with_logger` to temporarily wrap
+the current logger with a level/verbosity filter while `f` is executed.
+That is, the current logger will still be used for actual logging, but
+log messages will first be checked that they meet the `level` and
+`verbosity` levels before being passed on to be logged.
+"""
+function with(f; level::Union{Int, LogLevel}=Info, verbosity::Int=0)
+    with_logger(EarlyFilteredLogger(
+        args -> !(args.group isa Int) || verbosity >= args.group,
+        LevelOverrideLogger(level, current_logger()))
+    ) do
+        f()
+    end
 end