R语言如何将表达式转为字符型并保留原有格式与注释

核心思路 #

R在解析代码时默认会保留原代码的源引用（srcref）属性，该属性存储了代码的原始文本内容、格式、注释和符号，不会被语法树解析逻辑覆盖，直接提取该属性即可得到完全符合原格式的字符结果。

可直接使用的函数实现 #

my_fun <- function(expr) {
  # 提取入参表达式的源引用属性，直接转字符即可保留全部原格式
  expr_srcref <- attr(substitute(expr), "srcref")
  as.character(expr_srcref)
}

测试效果 #

运行测试用例：

x <- my_fun({
  a <- 1+1
  # a comment
  if (a > 1) print("foo")
  if (a < 1) {
    print("foo",
      "bar");
  }
})

调用writeLines(x)输出结果和预期完全一致：

{
  a <- 1+1
  # a comment
  if (a > 1) print("foo")
  if (a < 1) {
    print("foo",
      "bar");
  }
}

注意事项 #

• 交互式环境下R默认开启源引用保留，如果是在脚本中运行，需要在脚本开头添加配置：options(keep.source = TRUE)
• 原deparse方法失效的原因是它基于解析后的语法树生成代码，语法树不会存储注释、空格、分号、换行这类纯格式信息，所以必然会丢失原格式。

内容的提问来源于stack exchange，提问作者Jan van der Laan