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

问题描述

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

#!/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版本呢？

解决方法

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

您在评论中说，您不想使用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 Core团队的故意选择。无论哪种方式，很明显它们在Ruby 2.7.1中都有不同的行为。

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

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

通过Kernel#at_exit注册处理程序，将 @dir 定义为顶级范围中的实例变量或处理程序已注册的{ {3}}。路径名不是严格必需的，但可以包含它以匹配您当前的代码。

require 'pathname'
require 'tmpdir'

at_exit { @dir.rmtree }

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

使用块进行自动清除

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

require 'tmpdir'

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

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