as_logger_config.list now uses logger_config

Author: s-fleck

NAMESPACE

@@ -63,6 +63,7 @@ export(is_filter)
 export(label_levels)
 export(lgr)
 export(log_exception)
+export(logger_config)
 export(pad_left)
 export(pad_right)
 export(read_json_lines)

R/Logger.R

@@ -235,28 +235,22 @@ Logger <- R6::R6Class(
         )
       }
 
-      self$set_appenders(appenders)
-      self$set_exception_handler(exception_handler)
       self$set_name(name)
-      self$set_propagate(propagate)
-      self$set_filters(filters)
       private$.last_event <- LogEvent$new(self)
+
       self$set_threshold(threshold)
+      self$set_appenders(appenders)
+      self$set_propagate(propagate)
+      self$set_filters(filters)
+      self$set_exception_handler(exception_handler)
 
       invisible(self)
     },
 
-
     config = function(
       cfg  = NULL,
       file = NULL,
-      text = NULL,
-      ...,
-      appenders,
-      threshold,
-      filters,
-      exception_handler,
-      propagate
+      text = NULL
     ){
       assert(
         is.null(cfg) + is.null(file) + is.null(text) >= 2,
@@ -276,7 +270,7 @@ Logger <- R6::R6Class(
       } else if (!is.null(text)){
         assert(
           is_scalar_character(text) && grepl("\n", text),
-          "`text` must be a character scalar containing valid yaml"
+          "`text` must be a character scalar containing valid YAML"
         )
         cfg <- as_logger_config(text)
 

R/log_levels.R

@@ -198,7 +198,8 @@ colorize_levels <- function(
 #' @noRd
 standardize_threshold <- function(
   x,
-  log_levels = c(getOption("lgr.log_levels"), c("all" = NA_integer_, "off" = 0L))
+  log_levels = c(getOption("lgr.log_levels"), c("all" = NA_integer_, "off" = 0L)),
+  allow_null = FALSE
 ){
   assert(is_scalar(x), "A threshold must be a scalar (a vector of length 1)" )
 

R/logger_config.R

@@ -6,7 +6,7 @@
 #'
 #' @param x any \R object. Especially:
 #'   * A `character` scalar. This can either be the path to a
-#'     [yaml][https://yaml.org/] file, or directly valid yaml.
+#'     [YAML][https://yaml.org/] file, or directly valid YAML
 #'   * a list containing the elements `appenders`, `threshold`, `exception_handler`,
 #'     `propagate` and `filters`. See the section *Fields* in [Logger] for
 #'     details.
@@ -38,6 +38,21 @@ as_logger_config <- function(x){
 
 
 
+#' Create a Logger configuration object
+#'
+#' @param appenders
+#' @param threshold
+#' @param filters
+#' @param exception_handler
+#' @param propagate
+#'
+#' @return a `list` with subclass `"logger_config"`
+#' @export
+#'
+#' @examples
+#' # call without arguments to generate the default configuration
+#' cfg <- logger_config()
+#'
 logger_config <- function(
   appenders = list(),
   threshold = NULL,
@@ -48,10 +63,14 @@ logger_config <- function(
   assert(is.function(exception_handler))
   assert(is_scalar_bool(propagate))
 
+  if (!is.null(threshold)){
+    threshold <- standardize_threshold(threshold)
+  }
+
   structure(
     list(
       appenders = standardize_appenders_list(appenders),
-      threshold = standardize_threshold(threshold),
+      threshold = threshold,
       filters   = standardize_filters_list(filters),
       exception_handler = exception_handler,
       propagate = propagate
@@ -69,19 +88,16 @@ logger_config <- function(
 as_logger_config.list <- function(x){
   assert(is.list(x))
 
-  assert(all(
-    names(x) %in% c("exception_handler", "propagate", "threshold", "appenders", "filters")
+  assert(setequal(
+    names(x), c("exception_handler", "propagate", "threshold", "appenders", "filters")
   ))
 
-  assert(is.function(x$exception_handler))
-  assert(is_scalar_bool(x$propagate))
-
-  x$threshold <- standardize_threshold(x$threshold)
-  x$filters   <- standardize_filters_list(x$filters)
-  x$appenders <- standardize_appenders_list(x$appenders)
-
-  class(x) <- c("logger_config", "list")
-  x
+  logger_config(
+    threshold = x$threshold,
+    filters = x$filters,
+    appenders = x$appenders,
+    exception_handler = x$exception_handler
+  )
 }
 
 
@@ -102,14 +118,14 @@ as_logger_config.character <- function(
 
   assert(
     identical(length(names(dd)), 1L),
-    "If 'x' is a yaml file, it must contain a single logger object"
+    "If 'x' is a YAML file, it must contain a single logger object"
   )
 
   res <- resolve_r6_ctors(dd)
 
   assert(
     is_Logger(res),
-    "If `x` is a yaml file or string, it must contain a single logger object"
+    "If `x` is a YAML file or string, it must contain a single logger object"
   )
 
   res

man/as_logger_config.Rd

@@ -21,10 +21,10 @@ for (strategy in c(
     tf <- tempfile()
 
     lr <- get_logger("par_root")
-    lr$config(
+    lr$config(logger_config(
       propagate = FALSE,
       appenders = AppenderFile$new(tf)
-    )
+    ))
 
     lg <- get_logger("par_root/par_child")
 

man/logger_config.Rd

@@ -691,14 +691,14 @@ just set the buffer size to `0`.
 ```{r}
 # install.packages("RSQLite")
 lg <- get_logger("db_logger")
-
-lg$config(
-  appenders = list(db = AppenderDbi$new(
+lg$set_propagate(FALSE)
+lg$add_appender(
+  name = "db", 
+  AppenderDbi$new(
     conn = DBI::dbConnect(RSQLite::SQLite()),
     table = "log",
     buffer_size = 2L
-  )), 
-  propagate = FALSE
+  )
 )
 
 lg$info("Logging to databases uses a buffer")