`shutil.rmtree` 不适用于 `tempfile.TemporaryDirectory()`

Question

考虑一下这个测试

import shutil, tempfile
from os import path
import unittest

from pathlib import Path

class TestExample(unittest.TestCase):
    def setUp(self):
        # Create a temporary directory
        self.test_dir = tempfile.TemporaryDirectory()
        self.test_dir2 = tempfile.mkdtemp()

    def tearDown(self):
        # Remove the directory after the  test
        shutil.rmtree(self.test_dir2) 
        shutil.rmtree(self.test_dir.name) #throws error

    def test_something(self):
        self.assertTrue(Path(self.test_dir.name).is_dir())
        self.assertTrue(Path(self.test_dir2).is_dir())

if __name__ == '__main__':
    unittest.main()

在tearDown 中却引发了错误

FileNotFoundError: [Errno 2] No such file or directory: '/tmp/tmpxz7ts7a7'

指的是self.test_dir.name。

根据the source code for tempfile，两个元素是一样的。

    def __init__(self, suffix=None, prefix=None, dir=None):
        self.name = mkdtemp(suffix, prefix, dir)
        self._finalizer = _weakref.finalize(
            self, self._cleanup, self.name,
            warn_message="Implicitly cleaning up {!r}".format(self))

而且我没有在上下文中使用它，所以据我所知，不应调用 __exit__()。

发生了什么？

Answer 1

不要用shutil 清理这些。 tempfile.TemporaryDirectory 类提供了一个 cleanup() 方法，如果您想选择显式清理，只需调用它即可。

代码崩溃的原因是TemporaryDirectory 类被设计为在超出范围后自行清理（参考计数为零）。但是，由于您已经手动从文件系统中删除了该目录，因此当实例随后尝试删除自身时，拆除会失败。 “没有这样的文件或目录”错误来自TemporaryDirectory 自己的拆解，而不是来自您的shutil.rmtree 行！

Answer 2

这与上下文无关：

import tempfile,os

t = tempfile.TemporaryDirectory()
s = t.name
print(os.path.isdir(s))
# os.rmdir(s) called here triggers error on the next line
t = None
print(os.path.isdir(s))

打印出来

True
False

因此，一旦t 的引用设置为None，对象就会被垃圾收集并删除目录，正如documentation 所述：

在上下文或临时目录对象销毁完成后，新创建的临时目录及其所有内容将从文件系统中删除。

当对象完成时，在下面的 sn-p 中取消注释 os.rmdir(s) 会引发异常：

Exception ignored in: <finalize object at 0x20b20f0; dead>
Traceback (most recent call last):
  File "L:\Python34\lib\weakref.py", line 519, in __call__
    return info.func(*info.args, **(info.kwargs or {}))
  File "L:\Python34\lib\tempfile.py", line 698, in _cleanup
    _shutil.rmtree(name)
  File "L:\Python34\lib\shutil.py", line 482, in rmtree
    return _rmtree_unsafe(path, onerror)
  File "L:\Python34\lib\shutil.py", line 364, in _rmtree_unsafe
    onerror(os.listdir, path, sys.exc_info())
  File "L:\Python34\lib\shutil.py", line 362, in _rmtree_unsafe
    names = os.listdir(path)

所以你的调用可能成功了，但是你在对象的最终确定时得到了异常（就在之后）

调用cleanup() 对象方法而不是rmtree 解决了这个问题，因为对象内部状态已更新，not 在完成时尝试删除目录（如果你问我，对象应该在尝试清理之前测试目录是否存在，但即使这样也并不总是有效，因为它不是原子操作）

所以替换

shutil.rmtree(self.test_dir.name)

通过

self.test_dir.cleanup()

或者什么都不做，让对象在删除时清理目录。