Merge pull request #44 from kescobo/reexport-logging

Re-export Logging.jl

Author: oxinabox

Project.toml

@@ -5,6 +5,7 @@ version = "0.4.5"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 
 [compat]
 julia = "0.7, 1"

README.md

@@ -50,8 +50,7 @@ ConsoleLogger(stream, min_level) =
 
 # Usage
 Load the package with `using LoggingExtras`.
-You likely also want to load the `Logging` standard lib.
-Loggers can be constructed and used like normal.
+For convenience, this also re-exports the `Logging` standard library.
 
 
 ### Basics of working with loggers
@@ -154,7 +153,7 @@ see the HTTP example below.
 Another example is using them to stop messages every being repeated within a given time period.
 
 ```julia
-using Dates, Logging, LoggingExtras
+using Dates, LoggingExtras
 
 julia> function make_throttled_logger(period)
     history = Dict{Symbol, DateTime}()
@@ -196,7 +195,7 @@ that just checks if the level of the message is above the level specified when i
 ### Demo: filter out all the log messages that are less severe than `Error`
 
 ```julia
-julia> using Logging, LoggingExtras
+julia> using LoggingExtras
 
 julia> error_only_logger = MinLevelLogger(current_logger(), Logging.Error);
 
@@ -222,7 +221,7 @@ and should return a new modified named tuple.
 A simple example of its use is truncating messages.
 
 ```julia
-julia> using Logging, LoggingExtras
+julia> using LoggingExtras
 
 julia> truncating_logger  = TransformerLogger(global_logger()) do log
     if length(log.message) > 128
@@ -263,7 +262,7 @@ We are going to log info and above to one file,
 and warnings and above to another.
 
 ```julia
-julia> using Logging; using LoggingExtras;
+julia> using LoggingExtras;
 
 julia> demux_logger = TeeLogger(
     MinLevelLogger(FileLogger("info.log"), Logging.Info),
@@ -299,7 +298,7 @@ when the `DateFormat` would change the filename.  Note that if you wish to have
 escape them so they are not interpreted by the `DateFormat` code.  Example:
 
 ```julia
-julia> using Logging, LoggingExtras
+julia> using LoggingExtras
 
 julia> rotating_logger = DatetimeRotatingFileLogger(pwd(), raw"\a\c\c\e\s\s-YYYY-mm-dd-HH-MM-SS.\l\o\g");
 
@@ -327,7 +326,7 @@ The `FormatLogger` is a sink that formats the message and prints to a wrapped IO
 Formatting is done by providing a function `f(io::IO, log_args::NamedTuple)`.
 
 ```julia
-julia> using Logging, LoggingExtras
+julia> using LoggingExtras
 
 julia> logger = FormatLogger() do io, args
            println(io, args._module, " | ", "[", args.level, "] ", args.message)
@@ -347,7 +346,6 @@ Main | [Warn] This is a warning, should take a look.
 
 ```julia
 using LoggingExtras
-using Logging
 
 function sensible_message_filter(log)
     length(log.message) < 1028
@@ -361,7 +359,6 @@ global_logger(ActiveFilteredLogger(sensible_message_filter, global_logger()))
 
 ```julia
 using LoggingExtras
-using Logging
 using HTTP
 
 function not_HTTP_message_filter(log)
@@ -375,7 +372,6 @@ global_logger(EarlyFilteredLogger(not_HTTP_message_filter, global_logger()))
 
 ```julia
 using LoggingExtras
-using Logging
 using HTTP
 
 transformer_logger(global_logger()) do log
@@ -394,7 +390,7 @@ global_logger(transformer_logger)
 ## Add timestamp to all logging
 
 ```julia
-using Logging, LoggingExtras, Dates
+using LoggingExtras, Dates
 
 const date_format = "yyyy-mm-dd HH:MM:SS"
 

src/LoggingExtras.jl

@@ -12,6 +12,16 @@ export TeeLogger, TransformerLogger, FileLogger,
     ActiveFilteredLogger, EarlyFilteredLogger, MinLevelLogger,
     DatetimeRotatingFileLogger, FormatLogger
 
+######
+# Re export Logging.jl from stdlib 
+# list is stable between julia 1.0 and 1.6
+# https://github.com/JuliaLang/julia/blob/release-1.6/stdlib/Logging/src/Logging.jl#L32-L46
+using Logging
+
+export Logging, AbstractLogger, LogLevel, NullLogger,
+    @debug, @info, @warn, @error, @logmsg,
+    with_logger, current_logger, global_logger, disable_logging,
+    SimpleLogger, ConsoleLogger
 
 ######
 # Utilities for dealing with compositional loggers.