当且仅当 Python 不存在文件时，才安全地创建文件

Question

我希望根据文件是否已经存在来写入文件，仅在文件不存在时写入（实际上，我希望继续尝试文件，直到找到不存在的文件）。

以下代码显示了一种潜在攻击者可以插入符号链接的方式，正如this post 中所建议的那样，在文件测试和正在写入的文件之间。如果代码以足够高的权限运行，这可能会覆盖任意文件。

有没有办法解决这个问题？

import os
import errno

file_to_be_attacked = 'important_file'

with open(file_to_be_attacked, 'w') as f:
    f.write('Some important content!\n')

test_file = 'testfile'

try:
    with open(test_file) as f: pass
except IOError, e:

    # Symlink created here
    os.symlink(file_to_be_attacked, test_file)

    if e.errno != errno.ENOENT:
        raise
    else:
        with open(test_file, 'w') as f:
            f.write('Hello, kthxbye!\n')

Answer 1

编辑：另见Dave Jones' answer：从 Python 3.3 开始，您可以使用 x 标志到 open() 来提供此功能。

原答案如下

是的，但不使用 Python 的标准 open() 调用。您需要改用 os.open()，它允许您为底层 C 代码指定标志。

特别是，您想使用O_CREAT | O_EXCL。从我的 Unix 系统上 O_EXCL 下的 open(2) 手册页：

确保此调用创建文件：如果此标志与O_CREAT 一起指定，并且路径名已存在，则open() 将失败。如果未指定 O_CREAT，则 O_EXCL 的行为未定义。

当指定这两个标志时，不遵循符号链接：如果路径名是符号链接，则无论符号链接指向何处，open() 都会失败。

O_EXCL 仅在内核 2.6 或更高版本上使用 NFSv3 或更高版本时在 NFS 上受支持。在不提供 NFS O_EXCL 支持的环境中，依赖它来执行锁定任务的程序将包含竞争条件。

所以它并不完美，但 AFAIK 是您可以避免这种竞争条件的最接近的方法。

编辑：使用os.open() 而不是open() 的其他规则仍然适用。特别是，如果您想使用返回的文件描述符进行读取或写入，您还需要 O_RDONLY、O_WRONLY 或 O_RDWR 标志之一。

所有O_* 标志都在Python 的os 模块中，因此您需要import os 并使用os.O_CREAT 等。

示例：

import os
import errno

flags = os.O_CREAT | os.O_EXCL | os.O_WRONLY

try:
    file_handle = os.open('filename', flags)
except OSError as e:
    if e.errno == errno.EEXIST:  # Failed as the file already exists.
        pass
    else:  # Something unexpected went wrong so reraise the exception.
        raise
else:  # No exception, so the file must have been created successfully.
    with os.fdopen(file_handle, 'w') as file_obj:
        # Using `os.fdopen` converts the handle to an object that acts like a
        # regular Python file object, and the `with` context manager means the
        # file will be automatically closed when we're done with it.
        file_obj.write("Look, ma, I'm writing to a new file!")

Answer 2

如果文件不存在，此代码将轻松创建一个文件。

import os
if not os.path.exists('file'):
    open('file', 'w').close() 

Answer 3

作为参考，Python 3.3 在open() 函数中实现了一个新的'x' 模式来覆盖这个用例（仅创建，如果文件存在则失败）。请注意，'x' 模式是单独指定的。使用'wx' 会产生ValueError，因为'w' 是多余的（如果调用成功，你唯一能做的就是写入文件；如果调用成功，它就不会存在）：

>>> f1 = open('new_binary_file', 'xb')
>>> f2 = open('new_text_file', 'x')

对于 Python 3.2 及以下版本（包括 Python 2.x）请参考the accepted answer。