为什么 Pathname.rmtree 在 Signal.trap('EXIT') 上失败

Question

我正在尝试创建一个临时目录，该目录在脚本退出时会被删除。

#!/usr/bin/env ruby

require 'pathname'
require 'tmpdir'

Tmp_dir = Pathname.new(Dir.mktmpdir)

Signal.trap('EXIT') {
  Tmp_dir.rmtree
  puts 'Doing cleanup'
}

puts 'Will exit after this message'

Doing cleanup 消息永远不会触发并且目录保持不变。经过一些测试，Tmp_dir.rmtree 似乎永远不会运行，之后也不会执行任何操作。

The documentation 建议Pathname.rmtree 调用FileUtils.rm_r，所以我这样尝试：

#!/usr/bin/env ruby

require 'fileutils'
require 'pathname'
require 'tmpdir'

Tmp_dir = Pathname.new(Dir.mktmpdir)

Signal.trap('EXIT') {
  FileUtils.rm_r(Tmp_dir.to_path)
  puts 'Doing cleanup'
}

puts 'Will exit after this message'

而且它有效。那么rmtree 版本为什么没有呢？

Answer 1

信号陷阱与内核的 At_Exit 处理程序不同

您在 cmets 中说过您不想使用 Kernel#at_exit，但 Signal#trap 并不是一个确切的同义词。实际上，这两种方法的行为明显不同。你可以很容易地看到这一点：

# prints nil because variable not in scope; can't raise exceptions
Signal.trap(0) { p defined?(dir); p dir; raise dir }; dir="foo"; exit

# instance variables accessible; won't raise when undefined
Signal.trap(0) { p defined?(@dir); p @dir }; exit

# raises NameError because variable not in scope
at_exit { p defined?(dir); p dir }; dir="foo"; exit

# instance variable in scope, but won't raise when undefined
at_exit { p defined?(@dir); p @dir }; exit

# instance variable in scope; can raise manually
at_exit { p defined?(@dir); p @dir; raise @dir }; exit

如果您想知道为什么它们不同，您可能需要检查解析器或当前 Ruby 引擎的底层实现。这可能是一个错误，也可能是 Ruby 核心团队故意选择的。无论哪种方式，很明显它们在 Ruby 2.7.1 中具有不同的行为。

在 At_Exit 处理程序中使用实例变量

如所示，使用带有捕获信号的局部变量会带来范围问题，并且您所需代码的其他实现对于您的用例可能不可靠或不一致。您应该通过Kernel#at_exit 注册一个处理程序，并将您的临时目录名称存储在实例或类变量中。

当 @dir 被定义为顶级范围内的实例变量或处理程序注册的binding 时，通过Kernel#at_exit 注册处理程序将执行您对 irb 或命令行的期望.路径名不是绝对必要的，但包含在内以匹配您当前的代码。

require 'pathname'
require 'tmpdir'

at_exit { @dir.rmtree }

@dir = Pathname.new Dir.mktmpdir
p @dir

使用块进行自动清理

您可以通过使用Dir#mktmpdir 命令的块形式来完全避免信号/退出处理程序中的范围问题。例如：

require 'tmpdir'

Dir.mktmpdir do |dir|
  # do something with dir
end

这将在块退出时清理临时目录，而不必注册退出处理程序或信号陷阱。以我的经验，这通常比延迟关闭更容易测试和调试，但你的里程肯定会有所不同。