Merge pull request #22 from oxinabox/ox/noglobal

Deprecate DemuxLogger for TeeLogger, that does not support `include_current_global` kwarg

Author: oxinabox

Project.toml

@@ -1,7 +1,7 @@
 name = "LoggingExtras"
 uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36"
 authors = ["Lyndon White <[email protected]>"]
-version = "0.3.0"
+version = "0.4.0"
 
 [compat]
 julia = "0.7, 1"

README.md

@@ -76,25 +76,25 @@ logger = global_logger()
 
 # Loggers introduced by this package:
 This package introduces 6 new loggers.
-The `DemuxLogger`, the `TransformerLogger`, 3 types of filtered logger, and the `FileLogger`.
+The `TeeLogger`, the `TransformerLogger`, 3 types of filtered logger, and the `FileLogger`.
 All of them just wrap existing loggers.
- - The `DemuxLogger` sends the logs to multiple different loggers.
+ - The `TeeLogger` sends the logs to multiple different loggers.
  - The `TransformerLogger` applies a function to modify log messages before passing them on.
  - The 3 filter loggers are used to control if a message is written or not
      - The `MinLevelLogger` only allowes messages to pass that are above a given level of severity
      - The `EarlyFilteredLogger` lets you write filter rules based on the `level`, `module`, `group` and `id` of the log message
      - The `ActiveFilteredLogger` lets you filter based on the full content
  - The `FileLogger` is a simple logger sink that writes to file.
 
-By combining `DemuxLogger` with filter loggers you can arbitrarily route log messages, wherever you want.
+By combining `TeeLogger` with filter loggers you can arbitrarily route log messages, wherever you want.
 
 
-## `DemuxLogger`
+## `TeeLogger`
 
-The `DemuxLogger` sends the log messages to multiple places.
+The `TeeLogger` sends the log messages to multiple places.
 It takes a list of loggers.
-It also has the keyword argument `include_current_global`,
-to determine if you also want to log to the global logger.
+You often want to pass the `current_logger()` or `global_logger()`
+as one of those inputs so it keeps going to that one as well.
 
 It is up to those loggers to determine if they will accept it.
 Which they do using their methods for `shouldlog` and `min_enabled_level`.
@@ -111,17 +111,16 @@ It is really simple.
 The resulting file format is similar to that which is shown in the REPL.
 (Not identical, but similar)
 
-### Demo: `DemuxLogger` and `FileLogger`
+### Demo: `TeeLogger` and `FileLogger`
 We are going to log info and above to one file,
 and warnings and above to another.
 
 ```julia
 julia> using Logging; using LoggingExtras;
 
-julia> demux_logger = DemuxLogger(
+julia> demux_logger = TeeLogger(
     MinLevelLogger(FileLogger("info.log"), Logging.Info),
     MinLevelLogger(FileLogger("warn.log"), Logging.Warn),
-    include_current_global=false
 );
 
 

src/LoggingExtras.jl

@@ -8,8 +8,7 @@ import Base.CoreLogging:
     AbstractLogger, SimpleLogger,
     handle_message, shouldlog, min_enabled_level, catch_exceptions
 
-export demux_global_logger,
-    DemuxLogger, TransformerLogger, FileLogger,
+export TeeLogger, TransformerLogger, FileLogger,
     ActiveFilteredLogger, EarlyFilteredLogger, MinLevelLogger
 
 
@@ -32,11 +31,12 @@ function comp_handle_message_check(logger, args...; kwargs...)
 end
 ###############################
 
-include("demux.jl")
+include("tee.jl")
 include("transformer.jl")
 include("activefiltered.jl")
 include("earlyfiltered.jl")
 include("minlevelfiltered.jl")
 include("filelogger.jl")
+include("deprecated.jl")
 
 end # module

src/demux.jl

@@ -0,0 +1,5 @@
+
+Base.@deprecate(
+    DemuxLogger(loggers::Vararg{AbstractLogger}; include_current_global=true),
+    include_current_global ? TeeLogger(global_logger(), loggers...) : TeeLogger(loggers...)
+)

src/deprecated.jl

@@ -0,0 +1,39 @@
+struct TeeLogger{T<:NTuple{<:Any, AbstractLogger}} <: AbstractLogger
+    loggers::T
+end
+
+
+
+"""
+    TeeLogger(loggers...)
+
+Send the same log message to all the loggers.
+
+To include the current logger do:
+`TeeLogger(current_logger(), loggers...)`
+to include the global logger, do:
+`TeeLogger(global_logger(), loggers...)`
+"""
+function TeeLogger(loggers::Vararg{AbstractLogger})
+    return TeeLogger(loggers)
+end
+
+function handle_message(demux::TeeLogger, args...; kwargs...)
+    for logger in demux.loggers
+        if comp_handle_message_check(logger, args...; kwargs...)
+            handle_message(logger, args...; kwargs...)
+        end
+    end
+end
+
+function shouldlog(demux::TeeLogger, args...)
+    any(comp_shouldlog(logger, args...) for logger in demux.loggers)
+end
+
+function min_enabled_level(demux::TeeLogger)
+    minimum(min_enabled_level(logger) for logger in demux.loggers)
+end
+
+function catch_exceptions(demux::TeeLogger)
+    any(catch_exceptions(logger) for logger in demux.loggers)
+end

src/tee.jl

@@ -1,22 +1,33 @@
 using LoggingExtras
 using Test
-using Base.CoreLogging
-using Base.CoreLogging: Debug, Info, Warn, Error
-
 using Test: collect_test_logs, TestLogger
 
+using Base.CoreLogging
+using Base.CoreLogging: BelowMinLevel, Debug, Info, Warn, Error
 
-@testset "Demux" begin
-    testlogger_info = TestLogger(min_level=Info)
-    testlogger_warn = TestLogger(min_level=Warn)
 
-    with_logger(DemuxLogger(testlogger_warn, testlogger_info)) do
-        @info "info1"
-        @warn "warn1"
-        @info "info2"
+@testset "Tee" begin
+    @testset "contructor" begin
+        @testset "mixed types" begin
+            @test TeeLogger(TestLogger(), NullLogger()) isa TeeLogger
+        end
+
+        @testset "errors if given nonloggers" begin
+            @test_throws Exception TeeLogger(stdout, stderr)
+        end
+    end
+    @testset "basic use with compositional levels" begin
+        testlogger_info = TestLogger(min_level=Info)
+        testlogger_warn = TestLogger(min_level=Warn)
+
+        with_logger(TeeLogger(testlogger_warn, testlogger_info)) do
+            @info "info1"
+            @warn "warn1"
+            @info "info2"
+        end
+        @test length(testlogger_info.logs) == 3
+        @test length(testlogger_warn.logs) == 1
     end
-    @test length(testlogger_info.logs) == 3
-    @test length(testlogger_warn.logs) == 1
 end
 
 
@@ -104,3 +115,20 @@ end
     end
     @test length(testlogger.logs) == 2
 end
+
+
+@testset "Deprecations" begin
+    testlogger = TestLogger(min_level=BelowMinLevel)
+
+    demux_logger = DemuxLogger(testlogger)
+    @test demux_logger isa TeeLogger
+    @test Set(demux_logger.loggers) == Set([testlogger, global_logger()])
+
+    demux_logger = DemuxLogger(testlogger; include_current_global=true)
+    @test demux_logger isa TeeLogger
+    @test Set(demux_logger.loggers) == Set([testlogger, global_logger()])
+
+    demux_logger = DemuxLogger(testlogger; include_current_global=false)
+    @test demux_logger isa TeeLogger
+    @test Set(demux_logger.loggers) == Set([testlogger])
+end