断言是什么意思?它是如何使用的?

这里有很好的答案，但不是问题的第二部分。尽管有多年的实践经验，但我直到最近才明白断言的目的。

其他人已经解释了如何使用assert，所以我非常简短。下面是它的用法:

assert condition, "error message"

不要使用圆括号，assert是关键字，不是函数。

assert (condition, "error message")  # wrong: this never fails!

这里给出了如何使用assert的一个很好的解释:http://wiki.c2.com/?WhatAreAssertions assert的目的是在代码中声明不变量。不变式是一种永远不应该违反的条件，除非代码中存在错误。把它们看作是可执行的文档。这与面向对象编程如何封装来自外部世界的代码密切相关。

简单地说:对于其他开发人员，您应该在代码中像使用注释一样使用断言。但它比注释要好，“注释”实际上是在调试模式下检查的!如果删除断言后，您的程序不能正常工作，那么您使用错误。事实上，如果你打开优化(Python -O)， Python将忽略所有的断言。所以不要依赖他们。特别是，不要使用断言来验证用户输入。而是引发异常。

这里有一个很好的例子来把它们联系在一起。让我们假设您希望在代码中有一个特殊的数字类，它表示称为PositiveInt的正整数。你为什么想要那个?有许多函数使用正整数作为参数。通过在代码中使用PositiveInt，您不必在每个函数中反复检查输入是否有效。它由PositiveInt保证。粗略的实现如下所示

class PositiveInt(int):
    # int is immutable, so we have to override new and not init
    def __new__(cls, value):
        if value <= 0:
            raise ValueError(f"{value} is not positive")
        assert value > 0, "value must be positive"
        return super(PositiveInt, cls).__new__(cls, value)   

如你所见，我用了两个if…:提高……用于输入验证和函数末尾的断言。这似乎是多余的，但仅在这个微不足道的示例中!假设函数稍微长一些，也更复杂一些，因此您是否正确地验证了输入并不明显。末尾的断言确保检测到验证代码中的错误。它还使另一个程序员更清楚地了解验证代码的意图，而不是简单的注释。

总之:像使用注释一样使用assert。到处使用!它很便宜，如果它成为用户的性能问题，你可以在发行版中使用python -O关闭它。

assert语句几乎存在于每一种编程语言中。它有两个主要用途:

它有助于在程序的早期(原因很清楚的时候)检测问题，而不是在其他一些操作失败的时候。例如，Python中的类型错误如果没有在早期被捕获，可能会在实际引发异常之前经历几层代码。 对于阅读代码的其他开发人员来说，它可以作为文档使用，他们看到断言后可以自信地说从现在开始它的条件是成立的。

当你……

assert condition

．.． 您告诉程序测试该条件，如果条件为假，则立即触发一个错误。

在Python中，它大致相当于:

if not condition:
    raise AssertionError()

在Python shell中试试:

>>> assert True # nothing happens
>>> assert False
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AssertionError

断言可以包含可选的消息，您可以在运行解释器时禁用它们。

如果断言失败，打印一条消息:

assert False, "Oh no! This assertion failed!"

不要像调用函数一样使用括号来调用assert。这是一个声明。如果执行断言(condition, message)，则运行断言时将使用(condition, message)元组作为第一个参数。

至于禁用它们，当以优化模式运行python时，其中__debug__为False, assert语句将被忽略。只需要传递-O标志:

python -O script.py

相关文档请参见这里。

def getUser(self, id, Email):

    user_key = id and id or Email

    assert user_key

可用于确保在函数调用中传递参数。

在Python中，断言的目标是通知开发人员程序中不可恢复的错误。

断言并不是为了表明预期的错误条件，比如“文件未找到”，用户可以采取纠正措施(或者只是重试)。

另一种看待它的方法是，断言是代码中的内部自检。它们通过在代码中声明一些不可能的条件来工作。如果这些条件不成立，则意味着程序中存在错误。

如果您的程序没有错误，这些情况将永远不会发生。但如果其中一个确实发生了，程序将崩溃，并提示一个断言错误，告诉您究竟触发了哪个“不可能”条件。这使得跟踪和修复程序中的错误变得更加容易。

以下是我写的Python断言教程的摘要:

Python的assert语句是一种调试辅助，而不是处理运行时错误的机制。使用断言的目标是让开发人员更快地找到错误的可能根源。除非程序中存在错误，否则绝不应引发断言错误。

如果你想知道python中保留函数的确切功能，输入help(enter_keyword)

如果您正在输入保留关键字，请确保将其输入为字符串。

正如在其他回答中所写的那样，assert语句用于检查 程序:在给定点上的程序

我就不重复刚才说的相关内容了 message，括号，或-O选项和__debug__常量。同时查看 首先是医生 手的信息。我将集中讨论你的问题:assert有什么用? 更准确地说，什么时候(什么时候不)应该使用assert?

assert语句对调试程序很有用，但不建议检查user 输入。我使用以下经验法则:keep断言来检测this 不应该发生的情况。一个用户 输入可能不正确，例如密码太短，但这不是一个this 不应该发生的情况。如果一个圆的直径不是它的两倍大 半径，这是不应该发生的情况。

在我看来，assert最有趣的用法是受到 通过合同编程 由B. Meyer在[面向对象软件构造]中描述( https://www.eiffel.org/doc/eiffel/Object-Oriented_Software_Construction%2C_2nd_Edition )，并以[Eiffel编程语言]( https://en.wikipedia.org/wiki/Eiffel_ (programming_language))。你不能完全 使用assert语句模拟契约编程，但它是 保持意图很有趣。

举个例子。假设您必须编写一个head函数(如 [Haskell中的头部功能]( http://www.zvon.org/other/haskell/Outputprelude/head_f.html))。的 给出的规范是:“如果列表不为空，则返回 清单的第一项”。看看下面的实现:

>>> def head1(xs): return xs[0]

And

>>> def head2(xs):
...     if len(xs) > 0:
...         return xs[0]
...     else:
...         return None

(是的，如果xs else None，这可以写成return xs[0]，但这不是重点)。

如果列表不为空，则两个函数的结果与此结果相同 是正确的:

>>> head1([1, 2, 3]) == head2([1, 2, 3]) == 1
True

因此，两种实现(我希望)都是正确的。当你尝试的时候，它们是不同的 取一个空列表的头项:

>>> head1([])
Traceback (most recent call last):
...
IndexError: list index out of range

But:

>>> head2([]) is None
True

同样，这两种实现都是正确的，因为不应该传递空值 列出这些函数(我们不在规范范围内)。这是一个 不正确的判断，但如果你做了这样的判断，任何事情都有可能发生。 一个函数引发异常，另一个函数返回一个特殊值。 最重要的是:我们不能依赖这种行为。如果xs是空的， 这是可行的:

print(head2(xs))

但是这会使程序崩溃:

print(head1(xs))

为了避免一些意外，我想知道我什么时候经过一些意外 函数的参数。换句话说:我想知道什么时候可观察到 行为是不可靠的，因为它依赖于实现，而不是规范。 当然，我可以阅读规范，但程序员并不总是仔细阅读 文档。

想象一下，如果我有一种方法将规范插入到代码中以获得 以下效果:当我违反规范，例如通过传递一个空 清单上的人头，我会收到警告。写正确的答案会有很大的帮助 (即符合规范)程序。这就是assert的地方 进入现场:

>>> def head1(xs):
...     assert len(xs) > 0, "The list must not be empty"
...     return xs[0]

And

>>> def head2(xs):
...     assert len(xs) > 0, "The list must not be empty"
...     if len(xs) > 0:
...         return xs[0]
...     else:
...         return None

现在，我们有:

>>> head1([])
Traceback (most recent call last):
...
AssertionError: The list must not be empty

And:

>>> head2([])
Traceback (most recent call last):
...
AssertionError: The list must not be empty

注意，head1抛出AssertionError，而不是IndexError。这是 因为AssertionError不是任何运行时错误:它标志着一个 违反规范。我想要一个警告，但是我得到了一个错误。 幸运的是，我可以禁用检查(使用-O选项)， 但风险由我自己承担。我将会做一个坠毁真的很贵，并希望 最好的想象一下，我的程序被嵌入到一艘宇宙飞船中，它穿越 黑洞。我将禁用断言，并希望程序足够健壮 尽量不要崩溃。

这个例子只是关于前提条件的，你可以使用assert来检查 后置条件(返回值和/或状态)和不变量(对象的状态) 类)。注意，使用assert检查后置条件和不变量可以 麻烦:

对于后置条件，您需要将返回值赋给一个变量，以及 也许是用来存储对象的初始状态如果你在处理一个方法; 对于不变量，必须在方法调用之前和之后检查状态。

你不会有像埃菲尔铁塔一样复杂的东西，但你可以 提高程序的整体质量。

---

总之，assert语句是检测this的一种方便方法 不应该发生的情况。违反规范(例如:通过 一个空列表头)是第一类这种不应该发生的情况。 因此，虽然assert语句可用于检测任何意外情况， 这是一种确保满足规范的特权方式。 在代码中插入断言语句以表示 规格，我们可以希望您已经提高了程序的质量，因为 不正确的参数，不正确的返回值，不正确的类状态… 将被报告。