address review comments

Author: quinnj

README.md

@@ -368,7 +368,7 @@ Main | [Warn] This is a warning, should take a look.
 ## `LevelOverrideLogger` (*Filter*)
 Allows overriding the minimum log level set by the logger it wraps.
 Useful when debug logging
-and used in conjuction with `Logging.with_logger` or `LoggingExtras.with` to
+and used in conjuction with `Logging.with_logger` or `LoggingExtras.withlevel` to
 temporarily modify the current logger with a custom level.
 More generally useful if you want to use the current/global logger as a _sink_ but don't know if it is going to have a problematically high min log level set (as julia's default logger sets min level to `Info`).
 
@@ -399,7 +399,7 @@ non-verbose counterparts, but allow specifying a verbosity level as well:
   * `@warnv N msg`
   * `@errorv N msg`
 
-For verbosity filtering, the `LoggingExtras.with(f; level=Info, verbosity=0)` utlility is provided
+For verbosity filtering, the `LoggingExtras.withlevel(f, Info; verbosity=0)` utlility is provided
 for temporarily (i.e. while `f()` is executed) allowing log messages with `level` and `verbosity`.
 This is very handy for allowing finer grained control in debug logging for long-running or complex user API function
 calls. For example:
@@ -408,7 +408,7 @@ calls. For example:
 using LoggingExtras
 
 function complex_user_call(; verbose=0)
-    LoggingExtras.with(; level=Debug, verbosity=verbose)
+    LoggingExtras.withlevel(Debug; verbosity=verbose)
         # execute complex function body
         @debugv 1 "a level 1 verbosity debug message"
         @debugv 2 "a more verbose level 2 debug message"

src/overridelogger.jl

@@ -16,6 +16,7 @@ handle_message(logger::LevelOverrideLogger, args...; kwargs...) =
 
 function shouldlog(logger::LevelOverrideLogger, level, args...)
     # Ignore the logger.logger's own level and instead check the override level
+    @show level, logger.level
     level >= logger.level && shouldlog(logger.logger, level, args...)
 end
 

src/verbosity.jl

@@ -1,4 +1,7 @@
 function restore_callsite_source_position!(expr, src)
+    @assert expr.head == :escape
+    @assert expr.args[1].head == :macrocall
+    @assert expr.args[1].args[2] isa LineNumberNode
     # 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)
@@ -24,57 +27,56 @@ For convenience, the
 wrap the current logger with a log level and verbosity subtracted to filter while `f` is executed.
 """
 
+"$vlogmacrodocs"
 macro debugv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
         esc(:($Base.@logmsg (Logging.Debug - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
+"$vlogmacrodocs"
 macro infov(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
         esc(:($Base.@logmsg (Logging.Info - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
+"$vlogmacrodocs"
 macro warnv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
         esc(:($Base.@logmsg (Logging.Warn - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
+"$vlogmacrodocs"
 macro errorv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
         esc(:($Base.@logmsg (Logging.Error - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
+"$vlogmacrodocs"
 macro logmsgv(verbosity::Int, level, msg, exs...)
     return restore_callsite_source_position!(
         esc(:($Base.@logmsg ($level - $verbosity) $msg $(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)
+    LoggingExtras.withlevel(f, level; verbosity::Integer=0)
 
 Convenience function like `Logging.with_logger` to temporarily wrap
 the current logger with a level 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`
 log level before being passed on to be logged.
 """
-function with(f; level::Union{Int, LogLevel}=Info, verbosity::Integer=0)
+function withlevel(f, level::Union{Int, LogLevel}=Info; verbosity::Integer=0)
     lvl = Base.CoreLogging._min_enabled_level[]
     try
         # by default, this global filter is Debug, but for debug logging

test/runtests.jl

@@ -243,15 +243,15 @@ end
 
     logger = TestLogger(min_level=Info)
     with_logger(logger) do
-        LoggingExtras.with(level=Debug) do
+        LoggingExtras.withlevel(Debug) do
             @debug "debug message"
         end
     end
     @test logger.logs[1].level == Debug
 
     logger = TestLogger(min_level=Info)
     with_logger(logger) do
-        LoggingExtras.with(level=Debug, verbosity=1) do
+        LoggingExtras.withlevel(Debug; verbosity=1) do
             @debugv 0 "debug 0 message"
             @debugv 1 "debug 1 message"
             @debugv 2 "debug 2 message"