Question

on.exit在函数退出时调用代码，但是我应该如何以及何时使用它？

Answer 1

on.exit的优点是在函数退出时调用，无论是否抛出错误。这意味着它的主要用途是在危险行为之后进行清理。在这种情况下，风险通常意味着访问R之外的资源（因此无法保证工作）。常见示例包括连接到数据库或文件（完成后必须关闭连接，即使出现错误），或将绘图保存到文件（之后必须关闭图形设备）。

您还可以将on.exit用于带有副作用的低风险行为，例如设置工作目录。

使用`on.exit`

的软件包

withr包中包含许多with_*个函数，用于更改设置，运行一些代码，然后更改设置。这些功能也出现在devtools包中。

在later包中可以找到替代语法，其中defer是on.exit的便捷包装，而scope_*函数的工作方式与with_*函数类似前面提到的包。

数据库连接

在此示例中，sqlite_get_query连接到sqlite数据库，确保查询运行后，连接始终关闭。 cookies 数据库要求您在计算机上安装了firefox，并且您可以需要调整路径才能找到cookie文件。

library(RSQLite)
sqlite_get_query <- function(db, sql)
{
  conn <- dbConnect(RSQLite::SQLite(), db)
  on.exit(dbDisconnect(conn))
  dbGetQuery(conn, sql)
}

cookies <- dir(
  file.path(Sys.getenv("APPDATA"), "Mozilla", "Firefox"), 
  recursive  = TRUE, 
  pattern    = "cookies.sqlite$",
  full.names = TRUE
)[1]

sqlite_get_query(
  cookies, 
  "SELECT `baseDomain`, `name`, `value` FROM moz_cookies LIMIT 20"
)

文件连接

在此示例中，read_chars包装readChars，确保连接阅读完成后，文件始终关闭。

read_chars <- function(file_name)
{
  conn <- file(file_name, "r")
  on.exit(close(conn))
  readChar(conn, file.info(file_name)$size)
}

tmp <- tempfile()
cat(letters, file = tmp, sep = "")
read_chars(tmp)

临时文件

以下从CodeDepends改编的示例使用临时文件来保存会话历史记录。该函数返回后不需要此临时文件，因此将其删除。

history_lines <- function()
{
  f <- tempfile()
  on.exit(unlink(f))
  savehistory(f)
  readLines(f, encoding = "UTF-8")
}

保存基本图形

在此示例中，my_plot是使用base创建绘图的函数图形。 save_base_plot接受一个函数和一个文件来保存它，使用 on.exit以确保图形设备始终处于关闭状态。

my_plot <- function()
{
  with(cars, plot(speed, dist))
}

save_base_plot <- function(plot_fn, file)
{
  png(file)
  on.exit(dev.off())
  plot_fn()
}

save_base_plot(my_plot, "testcars.png")

暂时设置基本图形选项

在此示例中，plot_with_big_margins调用plot，覆盖全局mar杜松子酒par，使用on.exit在绘图完成后重置它。

plot_with_big_margins <- function(...)
{
  old_pars <- par(mar = c(10, 9, 9, 7))  
  on.exit(par(old_pars))
  plot(...)
}

plot_with_big_margins(with(cars, speed, dist))

withr / devtools等效：with_par

暂时设置全局选项

在此示例中，create_data_frame是一个创建data.frame的函数。 create_data_frame确保创建的对象不包含显式因子。

create_data_frame <- function(){
  op <- options(stringsAsFactors = FALSE)
  on.exit(options(op))

  data.frame(x=1:10)
}

withr / devtools相当于：with_options
等效later：scope_options

其他例子

设置工作目录（withr::with_dir，later::scope_dir）
设置区域设置组件（withr::with_locale）
设置环境变量（withr::with_envvars，later::scope_env_var）
设置库路径（withr::with_libpaths）
使用接收器重定向输出
暂时加载包裹（withr::with_package，withr::with_namespace）

我应该如何以及何时使用on.exit？

1 个答案: