Skip to content

Commit b935f0a

Browse files
daroczigdaroczig
authored
Merge pull request #199 from hadley/function-wrapping
Consistently wrap long definitions/calls
2 parents 3e3a1ee + 5b3e4b5 commit b935f0a

4 files changed

Lines changed: 99 additions & 34 deletions

File tree

‎R/appenders.R‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,9 @@ appender_kinesis <- function(stream) {
399399
#' attr(my_appender, "async_writer_process")$is_alive()
400400
#' attr(my_appender, "async_writer_process")$read_error()
401401
#' }
402-
appender_async <- function(appender, batch = 1, namespace = "async_logger",
402+
appender_async <- function(appender,
403+
batch = 1,
404+
namespace = "async_logger",
403405
init = function() log_info("Background process started")) {
404406
fail_on_missing_package("txtq")
405407
fail_on_missing_package("callr")

‎R/formatters.R‎

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
#' @export
66
#' @family `log_formatters`
77
formatter_paste <- function(...,
8-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
8+
.logcall = sys.call(),
9+
.topcall = sys.call(-1),
10+
.topenv = parent.frame()) {
911
paste(...)
1012
}
1113
attr(formatter_paste, "generator") <- quote(formatter_paste())
@@ -17,8 +19,11 @@ attr(formatter_paste, "generator") <- quote(formatter_paste())
1719
#' @return character vector
1820
#' @export
1921
#' @family `log_formatters`
20-
formatter_sprintf <- function(fmt, ...,
21-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
22+
formatter_sprintf <- function(fmt,
23+
...,
24+
.logcall = sys.call(),
25+
.topcall = sys.call(-1),
26+
.topenv = parent.frame()) {
2227
sprintf(fmt, ...)
2328
}
2429
attr(formatter_sprintf, "generator") <- quote(formatter_sprintf())
@@ -33,7 +38,10 @@ attr(formatter_sprintf, "generator") <- quote(formatter_sprintf())
3338
#' will be used as a fallback.
3439
#' @family `log_formatters`
3540
#' @importFrom utils str
36-
formatter_glue <- function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
41+
formatter_glue <- function(...,
42+
.logcall = sys.call(),
43+
.topcall = sys.call(-1),
44+
.topenv = parent.frame()) {
3745
fail_on_missing_package("glue")
3846

3947
withCallingHandlers(
@@ -63,7 +71,9 @@ attr(formatter_glue, "generator") <- quote(formatter_glue())
6371
#' @family `log_formatters`
6472
#' @importFrom utils str
6573
formatter_glue_safe <- function(...,
66-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
74+
.logcall = sys.call(),
75+
.topcall = sys.call(-1),
76+
.topenv = parent.frame()) {
6777
fail_on_missing_package("glue")
6878
as.character(
6979
tryCatch(
@@ -111,8 +121,10 @@ attr(formatter_glue_safe, "generator") <- quote(formatter_glue_safe())
111121
#' formatter_glue_or_sprintf("Hi %s, did you know that 2*4={2*4}", c("foo", "bar"))
112122
#' formatter_glue_or_sprintf("Hi %s, did you know that 2*4=%s", c("foo", "bar"), 2 * 4)
113123
#' }
114-
formatter_glue_or_sprintf <- function(msg, ...,
115-
.logcall = sys.call(), .topcall = sys.call(-1),
124+
formatter_glue_or_sprintf <- function(msg,
125+
...,
126+
.logcall = sys.call(),
127+
.topcall = sys.call(-1),
116128
.topenv = parent.frame()) {
117129
params <- list(...)
118130

@@ -176,7 +188,10 @@ attr(formatter_glue_or_sprintf, "generator") <- quote(formatter_glue_or_sprintf(
176188
#' log_info(everything = 42)
177189
#' log_info(mtcars = mtcars, species = iris$Species)
178190
#' }
179-
formatter_json <- function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
191+
formatter_json <- function(...,
192+
.logcall = sys.call(),
193+
.topcall = sys.call(-1),
194+
.topenv = parent.frame()) {
180195
fail_on_missing_package("jsonlite")
181196
eval(as.character(jsonlite::toJSON(list(...), auto_unbox = TRUE)), envir = .topenv)
182197
}
@@ -229,7 +244,10 @@ skip_formatter <- function(message, ...) {
229244
#' log_info("vector %s", 1:3)
230245
#' log_info(12, 1 + 1, 2 * 2)
231246
#' }
232-
formatter_logging <- function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
247+
formatter_logging <- function(...,
248+
.logcall = sys.call(),
249+
.topcall = sys.call(-1),
250+
.topenv = parent.frame()) {
233251
params <- list(...)
234252
.logcall <- substitute(.logcall)
235253

@@ -261,8 +279,11 @@ attr(formatter_logging, "generator") <- quote(formatter_logging())
261279
#' log_info(head(iris), style = "simple")
262280
#' log_info(lm(hp ~ wt, mtcars))
263281
#' }
264-
formatter_pander <- function(x, ...,
265-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
282+
formatter_pander <- function(x,
283+
...,
284+
.logcall = sys.call(),
285+
.topcall = sys.call(-1),
286+
.topenv = parent.frame()) {
266287
fail_on_missing_package("pander")
267288
pander::pander_return(x, ...)
268289
}

‎R/helpers.R‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,11 @@ log_separator <- function(level = INFO,
141141
#' log_layout(logger)
142142
#' log_with_separator("Boo!", level = FATAL, width = 120)
143143
#' @seealso [log_separator()]
144-
log_with_separator <- function(..., level = INFO, namespace = NA_character_, separator = "=", width = 80) {
144+
log_with_separator <- function(...,
145+
level = INFO,
146+
namespace = NA_character_,
147+
separator = "=",
148+
width = 80) {
145149
base_info_chars <- nchar(catch_base_log(level, namespace, .topcall = sys.call(-1)))
146150

147151
log_separator(

‎R/layouts.R‎

Lines changed: 59 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,11 @@
3131
#' @importFrom utils packageVersion
3232
#' @seealso [layout_glue_generator()]
3333
#' @family `log_layouts`
34-
get_logger_meta_variables <- function(log_level = NULL, namespace = NA_character_,
35-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
34+
get_logger_meta_variables <- function(log_level = NULL,
35+
namespace = NA_character_,
36+
.logcall = sys.call(),
37+
.topcall = sys.call(-1),
38+
.topenv = parent.frame()) {
3639
sysinfo <- Sys.info()
3740
timestamp <- Sys.time()
3841

@@ -92,17 +95,24 @@ get_logger_meta_variables <- function(log_level = NULL, namespace = NA_character
9295
layout_glue_generator <- function(format = '{level} [{format(time, "%Y-%m-%d %H:%M:%S")}] {msg}') {
9396
force(format)
9497

95-
structure(function(level, msg, namespace = NA_character_,
96-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
98+
structure(function(level,
99+
msg,
100+
namespace = NA_character_,
101+
.logcall = sys.call(),
102+
.topcall = sys.call(-1),
103+
.topenv = parent.frame()) {
97104
fail_on_missing_package("glue")
98105
if (!inherits(level, "loglevel")) {
99106
stop("Invalid log level, see ?log_levels")
100107
}
101108

102109
with(
103110
get_logger_meta_variables(
104-
log_level = level, namespace = namespace,
105-
.logcall = .logcall, .topcall = .topcall, .topenv = .topenv
111+
log_level = level,
112+
namespace = namespace,
113+
.logcall = .logcall,
114+
.topcall = .topcall,
115+
.topenv = .topenv
106116
),
107117
glue::glue(format)
108118
)
@@ -117,8 +127,12 @@ layout_glue_generator <- function(format = '{level} [{format(time, "%Y-%m-%d %H:
117127
#' @return character vector
118128
#' @export
119129
#' @family `log_layouts`
120-
layout_blank <- function(level, msg, namespace = NA_character_,
121-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
130+
layout_blank <- function(level,
131+
msg,
132+
namespace = NA_character_,
133+
.logcall = sys.call(),
134+
.topcall = sys.call(-1),
135+
.topenv = parent.frame()) {
122136
msg
123137
}
124138
attr(layout_blank, "generator") <- quote(layout_blank())
@@ -130,8 +144,12 @@ attr(layout_blank, "generator") <- quote(layout_blank())
130144
#' @return character vector
131145
#' @export
132146
#' @family `log_layouts`
133-
layout_simple <- function(level, msg, namespace = NA_character_,
134-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
147+
layout_simple <- function(level,
148+
msg,
149+
namespace = NA_character_,
150+
.logcall = sys.call(),
151+
.topcall = sys.call(-1),
152+
.topenv = parent.frame()) {
135153
paste0(attr(level, "level"), " [", format(Sys.time(), "%Y-%m-%d %H:%M:%S"), "] ", msg)
136154
}
137155
attr(layout_simple, "generator") <- quote(layout_simple())
@@ -150,8 +168,12 @@ attr(layout_simple, "generator") <- quote(layout_simple())
150168
#' devtools::load_all(system.file("demo-packages/logger-tester-package", package = "logger"))
151169
#' logger_tester_function(INFO, 42)
152170
#' }
153-
layout_logging <- function(level, msg, namespace = NA_character_,
154-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
171+
layout_logging <- function(level,
172+
msg,
173+
namespace = NA_character_,
174+
.logcall = sys.call(),
175+
.topcall = sys.call(-1),
176+
.topenv = parent.frame()) {
155177
meta <- get_logger_meta_variables(
156178
log_level = level, namespace = namespace,
157179
.logcall = .logcall, .topcall = .topcall, .topenv = .topenv
@@ -225,8 +247,12 @@ attr(layout_glue_colors, "generator") <- quote(layout_glue_colors())
225247
layout_json <- function(fields = default_fields()) {
226248
force(fields)
227249

228-
structure(function(level, msg, namespace = NA_character_,
229-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
250+
structure(function(level,
251+
msg,
252+
namespace = NA_character_,
253+
.logcall = sys.call(),
254+
.topcall = sys.call(-1),
255+
.topenv = parent.frame()) {
230256
fail_on_missing_package("jsonlite")
231257

232258
json <- get_logger_meta_variables(
@@ -257,13 +283,20 @@ layout_json <- function(fields = default_fields()) {
257283
layout_json_parser <- function(fields = default_fields()) {
258284
force(fields)
259285

260-
structure(function(level, msg, namespace = NA_character_,
261-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
286+
structure(function(level,
287+
msg,
288+
namespace = NA_character_,
289+
.logcall = sys.call(),
290+
.topcall = sys.call(-1),
291+
.topenv = parent.frame()) {
262292
fail_on_missing_package("jsonlite")
263293

264294
meta <- get_logger_meta_variables(
265-
log_level = level, namespace = namespace,
266-
.logcall = .logcall, .topcall = .topcall, .topenv = .topenv
295+
log_level = level,
296+
namespace = namespace,
297+
.logcall = .logcall,
298+
.topcall = .topcall,
299+
.topenv = .topenv
267300
)[fields]
268301

269302
msg <- jsonlite::fromJSON(msg)
@@ -290,10 +323,15 @@ default_fields <- function() {
290323
#' @return A character vector with a severity attribute.
291324
#' @export
292325
layout_syslognet <- structure(
293-
function(level, msg, namespace = NA_character_,
294-
.logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
326+
function(level,
327+
msg,
328+
namespace = NA_character_,
329+
.logcall = sys.call(),
330+
.topcall = sys.call(-1),
331+
.topenv = parent.frame()) {
295332
ret <- paste(attr(level, "level"), msg)
296-
attr(ret, "severity") <- switch(attr(level, "level", exact = TRUE),
333+
attr(ret, "severity") <- switch(
334+
attr(level, "level", exact = TRUE),
297335
"FATAL" = "CRITICAL",
298336
"ERROR" = "ERR",
299337
"WARN" = "WARNING",

0 commit comments

Comments
 (0)