Include comments when constructing functions?

[krlmlr]

r-dbi/RSQLite#437 is generated by r-dbi/DBItest#267 which uses constructive. In DBItest I'm making extensive use of inline comments. Is there a way to keep them with construct() ?

[moodymudskipper]

Comments are part of the srcref, not of the body, but it would make sense to keep them when constructing with `function(){}`, on the condition that the srcref matches the body (true for every non artificial case), in that case we won't deparse anything, just print the srcref

…

On Thu, 13 Oct 2022, 18:44 Kirill Müller, ***@***.***> wrote: r-dbi/RSQLite#437 <r-dbi/RSQLite#437> is generated by r-dbi/DBItest#267 <r-dbi/DBItest#267> which uses constructive. In DBItest I'm making extensive use of inline comments. Is there a way to keep them with construct() ? — Reply to this email directly, view it on GitHub <#58>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEMAMYRT2ARC6GHZ67DQXV3WDA37RANCNFSM6AAAAAAREO437E> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[krlmlr]

Right, I'd switch to capturing the body then.

We can still parse + style, though?

[moodymudskipper]

foo <- function(x) {
  # foo
  x
}

library(constructive)

# we have
construct(foo)
#> {constructive} couldn't create code that reproduces perfectly the input
#> ℹ Call `construct_issues()` to inspect the last issues
#> function(x) {
#>   x
#> }

# we can construct with the srcref
construct(foo, opts_function(srcref = TRUE))
#> {constructive} couldn't create code that reproduces perfectly the input
#> ℹ Call `construct_issues()` to inspect the last issues
#> (function(x) {
#>   x
#> }) |>
#>   structure(
#>     srcref = c(1L, 8L, 4L, 1L, 8L, 1L, 1L, 4L) |>
#>       structure(
#>         srcfile = list2env(
#>           list(
#>             fixedNewlines = TRUE,
#>             lines = c("foo <- function(x) {", "  # foo", "  x", "}", ""),
#>             filename = ""
#>           ),
#>           parent = .GlobalEnv
#>         ) |>
#>           structure(class = c("srcfilecopy", "srcfile")),
#>         class = "srcref"
#>       )
#>   )

# and we can verify that it prints properly
(function(x) {
  x
}) |>
  structure(
    srcref = c(1L, 8L, 4L, 1L, 8L, 1L, 1L, 4L) |>
      structure(
        srcfile = list2env(
          list(
            fixedNewlines = TRUE,
            lines = c("foo <- function(x) {", "  # foo", "  x", "}", ""),
            filename = ""
          ),
          parent = .GlobalEnv
        ) |>
          structure(class = c("srcfilecopy", "srcfile")),
        class = "srcref"
      )
  )
#> function(x) {
#>   # foo
#>   x
#> }

# but the compact and proper way would be to reproduce the idiomatic definition with the comments and get:
function(x) {
  # foo
  x
}

# then I think we just need, though to be safe we should parse it and check that get the same language tree
as.character(attr(foo, "srcref"))
#> [1] "function(x) {" "  # foo"       "  x"           "}"

# This is only for the `opts_function("function")` (the default), for `as.function()` for instance we lose the 
# comments so we cannot use this shortcut to set the secret
as.function(alist(x=, {
  # foo
  x
}))
#> function (x) 
#> {
#>     x
#> }

# For language objects We need `opts_language(srcref=)` because now we cannot faithfully reconstruct the body in isolation
construct(body(foo))
#> quote({
#>   x
#> })
attributes(body(foo))
#> $srcref
#> $srcref[[1]]
#> {
#> 
#> $srcref[[2]]
#> x
#> 
#> 
#> $srcfile
#> <text> 
#> 
#> $wholeSrcref
#> foo <- function(x) {
#>   # foo
#>   x
#> }

# however for that case we cannot reproduce the srcref without setting attributes, because the srcref
# either doesn't reproduce the object, as above, or contains too much, as below
bar <- identity(quote({
  # foo
  x
}))

attributes(bar)
#> $srcref
#> $srcref[[1]]
#> {
#> 
#> $srcref[[2]]
#> x
#> 
#> 
#> $srcfile
#> <text> 
#> 
#> $wholeSrcref
#> bar <- identity(quote({
#>   # foo
#>   x
#> }
as.character(attr(bar, "wholeSrcref"))
#> [1] "bar <- identity(quote({" "  # foo"                
#> [3] "  x"                     "}"

[moodymudskipper]

@krlmlr does this now works for you ? it's pushed to f-48-... as part of #56

If the srcref matches the function's definition (as measured with identical, ignoring env and srcref) it is used, if not we deparse the body.

x <- function(x) {
  # foo
  x
}

constructive::construct(x)
#> function(x) {
#>   # foo
#>   x
#> }
constructive::construct(list(a= x))
#> list(
#>   a = function(x) {
#>     # foo
#>     x
#>   }
#> )

^{Created on 2022-10-14 with reprex v2.0.2}

Re:

We can still parse + style, though?

I don't fully understand, but styling (indention and pretty code) is done through styler in any case, and since it uses getParseData it doesn't destroy comments.

[krlmlr]

Thanks, works beautifully!