Python 错误检查标准实践

Question

我有一个关于 Python 错误检查的问题。假设我有一个将文件路径作为输入的函数：

def myFunction(filepath):
    infile = open(filepath)
    #etc etc...

一个可能的前提条件是该文件应该存在。

有几种可能的方法来检查这个前提条件，我只是想知道最好的方法是什么。

i) 使用 if 语句进行检查：

if not os.path.exists(filepath):
    raise IOException('File does not exist: %s' % filepath)

这是我通常会这样做的方式，尽管如果文件不存在，Python 也会引发相同的 IOException，即使我不引发它。

ii）使用断言检查前置条件：

assert os.path.exists(filepath), 'File does not exist: %s' % filepath

使用断言似乎是检查前置/后置条件的“标准”方法，所以我很想使用它们。但是，当在执行期间使用 -o 标志时，这些断言可能会被关闭，这意味着此检查可能会被关闭，这似乎有风险。

iii）根本不处理前提条件

这是因为如果文件路径不存在，无论如何都会生成异常，并且异常消息足够详细，让用户知道该文件不存在

---

我只是想知道哪一个以上是我应该用于我的代码的标准做法。

Answer 1

如果您只想引发异常，请使用选项 iii：

def myFunction(filepath):
    with open(filepath) as infile:
        pass

要以特殊方式处理异常，请使用 try... except 块：

def myFunction(filepath):
    try:
        with open(filepath) as infile:
            pass
    except IOError:
        # special handling code here

在任何情况下都不会最好先检查文件是否存在（选项i或ii），因为在检查或断言发生与Python尝试打开文件之间的时间里，该文件可能会被删除或更改（例如使用符号链接），这可能会导致错误或安全漏洞。

此外，从 Python 2.6 开始，打开文件的最佳实践是使用 with open(...) 语法。这保证了即使 with 块内发生异常，文件也将被关闭。

在 Python 2.5 中，如果您的脚本前面带有以下内容，则可以使用 with 语法

from __future__ import with_statement

Answer 2

绝对不要使用断言。仅当代码错误时断言才会失败。不应使用断言检查外部条件（例如丢失文件）。

正如其他人指出的那样，可以关闭断言。

断言的正式语义是：

1. 条件可能会或可能不会被评估（所以不要依赖于表达式的副作用）。

2. 如果条件为真，则继续执行。

3. 如果条件为假，会发生什么是未定义的。

有关此想法的更多信息。

Answer 3

以下内容扩展自 ~unutbu 的示例。如果文件不存在，或者发生任何其他类型的 IO 错误，文件名也会在错误消息中传递：

path = 'blam'
try:
    with open(path) as f:
        print f.read()
except IOError as exc:
    raise IOError("%s: %s" % (path, exc.strerror))

=> IOError：blam：没有这样的文件或目录

Answer 4

我认为你应该混合使用 iii) 和 i)。如果你确实知道 python 会抛出异常（即情况 iii），那么就让 python 来做吧。如果还有一些其他先决条件（例如，您的业务逻辑要求），您应该抛出自己的异常，甚至可能从Exception派生。

恕我直言，使用断言太脆弱了，因为它们可能会被关闭。