Python,我应该__ne__()
基于 实现运算符__eq__
吗?
简短回答:不要实现它,但如果必须,请使用==
,而不是__eq__
在 Python 3 中,默认情况下!=
是否定的==
,因此您甚至不需要编写 a __ne__
,并且文档不再固执己见。
一般来说,对于仅 Python 3 的代码,除非您需要掩盖父实现,例如对于内置对象,否则不要编写代码。
也就是说,请记住Raymond Hettinger 的评论:
仅当
尚未在超类中定义时,该__ne__
方法才会自动遵循。所以,如果你从一个内置继承,最好覆盖两者。__eq__
__ne__
如果您需要您的代码在 Python 2 中工作,请遵循 Python 2 的建议,它可以在 Python 3 中正常工作。
在 Python 2 中,Python 本身不会自动根据另一个来实现任何操作 - 因此,您应该__ne__
根据==
而不是__eq__
. 例如
class A(object):
def __eq__(self, other):
return self.value == other.value
def __ne__(self, other):
return not self == other # NOT `return not self.__eq__(other)`
见证明
__ne__()
基于__eq__
和的实现算子
- 根本没有
__ne__
在 Python 2 中实现
在下面的演示中提供了不正确的行为。
长答案
Python 2的文档说:
比较运算符之间没有隐含的关系。的真理x==y
并不意味着它x!=y
是错误的。因此,在定义 时__eq__()
,还应该定义__ne__()
操作符的行为与预期一致。
所以这意味着如果我们__ne__
根据 的倒数来定义__eq__
,我们可以获得一致的行为。
文档的这一部分已针对Python 3 进行了更新:
默认情况下,__ne__()
委托__eq__()
并反转结果,除非它是NotImplemented
.
在“新增功能”部分,我们看到这种行为发生了变化:
!=
现在返回相反的==
,除非==
返回NotImplemented
。
为了实现__ne__
,我们更喜欢使用==
运算符而不是直接使用__eq__
方法,这样如果self.__eq__(other)
子类返回NotImplemented
检查的类型,Python 将适当地检查other.__eq__(self)
来自文档:
NotImplemented
对象_
这种类型只有一个值。有一个具有此值的对象。该对象通过内置名称访问
NotImplemented
。如果数值方法和富比较方法没有实现对提供的操作数的操作,则它们可能会返回此值。(然后解释器将尝试反射操作或其他一些回退操作,具体取决于操作员。)其真值为真。
当给定一个丰富的比较运算符时,如果它们不是同一类型,Python 会检查 是否other
是子类型,如果它定义了该运算符,它首先使用' 方法(other
对于<
、<=
和)。如果返回,则使用相反的方法。(它不会两次检查相同的方法。)使用运算符允许发生这种逻辑。>=
>
NotImplemented
==
期望
从语义上讲,您应该__ne__
根据相等性检查来实现,因为您的类的用户会期望以下函数对于 A. 的所有实例都是等效的:
def negation_of_equals(inst1, inst2):
"""always should return same as not_equals(inst1, inst2)"""
return not inst1 == inst2
def not_equals(inst1, inst2):
"""always should return same as negation_of_equals(inst1, inst2)"""
return inst1 != inst2
也就是说,上述两个函数应始终返回相同的结果。但这取决于程序员。
__ne__
基于以下定义时的意外行为演示__eq__
:
首先是设置:
class BaseEquatable(object):
def __init__(self, x):
self.x = x
def __eq__(self, other):
return isinstance(other, BaseEquatable) and self.x == other.x
class ComparableWrong(BaseEquatable):
def __ne__(self, other):
return not self.__eq__(other)
class ComparableRight(BaseEquatable):
def __ne__(self, other):
return not self == other
class EqMixin(object):
def __eq__(self, other):
"""override Base __eq__ & bounce to other for __eq__, e.g.
if issubclass(type(self), type(other)): # True in this example
"""
return NotImplemented
class ChildComparableWrong(EqMixin, ComparableWrong):
"""__ne__ the wrong way (__eq__ directly)"""
class ChildComparableRight(EqMixin, ComparableRight):
"""__ne__ the right way (uses ==)"""
class ChildComparablePy3(EqMixin, BaseEquatable):
"""No __ne__, only right in Python 3."""
实例化非等价实例:
right1, right2 = ComparableRight(1), ChildComparableRight(2)
wrong1, wrong2 = ComparableWrong(1), ChildComparableWrong(2)
right_py3_1, right_py3_2 = BaseEquatable(1), ChildComparablePy3(2)
预期行为:
(注意:虽然下面每一个的第二个断言都是等价的,因此在逻辑上与前面的断言是多余的,但我将它们包括在内是为了证明当一个是另一个的子类时顺序无关紧要。)
这些实例已通过以下__ne__
方式实现==
:
assert not right1 == right2
assert not right2 == right1
assert right1 != right2
assert right2 != right1
这些在 Python 3 下测试的实例也可以正常工作:
assert not right_py3_1 == right_py3_2
assert not right_py3_2 == right_py3_1
assert right_py3_1 != right_py3_2
assert right_py3_2 != right_py3_1
回想一下,这些已经__ne__
实现了__eq__
- 虽然这是预期的行为,但实现是不正确的:
assert not wrong1 == wrong2 # These are contradicted by the
assert not wrong2 == wrong1 # below unexpected behavior!
意外行为:
请注意,此比较与上面的比较 ( not wrong1 == wrong2
) 相矛盾。
>>> assert wrong1 != wrong2
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AssertionError
和,
>>> assert wrong2 != wrong1
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AssertionError
不要跳过__ne__
Python 2
有关不应跳过__ne__
在 Python 2 中实现的证据,请参阅以下等效对象:
>>> right_py3_1, right_py3_1child = BaseEquatable(1), ChildComparablePy3(1)
>>> right_py3_1 != right_py3_1child # as evaluated in Python 2!
True
上面的结果应该是False
!
Python 3 源代码
默认的CPython 实现__ne__
位于:typeobject.c
object_richcompare
case Py_NE:
/* By default, __ne__() delegates to __eq__() and inverts the result,
unless the latter returns NotImplemented. */
if (Py_TYPE(self)->tp_richcompare == NULL) {
res = Py_NotImplemented;
Py_INCREF(res);
break;
}
res = (*Py_TYPE(self)->tp_richcompare)(self, other, Py_EQ);
if (res != NULL && res != Py_NotImplemented) {
int ok = PyObject_IsTrue(res);
Py_DECREF(res);
if (ok < 0)
res = NULL;
else {
if (ok)
res = Py_False;
else
res = Py_True;
Py_INCREF(res);
}
}
break;
但默认__ne__
使用__eq__
?
Python 3__ne__
在 C 级别使用的默认实现细节是__eq__
因为更高级别==
(PyObject_RichCompare)效率较低 - 因此它还必须处理NotImplemented
.
如果__eq__
正确实现,那么否定==
也是正确的——它允许我们避免在__ne__
.
使用==
允许我们将低级逻辑保存在一个地方,并避免在.NotImplemented
__ne__
一个人可能会错误地认为==
可能会返回NotImplemented
。
它实际上使用与 的默认实现相同的逻辑__eq__
,它检查身份(参见do_richcompare和我们下面的证据)
class Foo:
def __ne__(self, other):
return NotImplemented
__eq__ = __ne__
f = Foo()
f2 = Foo()
以及比较:
>>> f == f
True
>>> f != f
False
>>> f2 == f
False
>>> f2 != f
True
表现
不要相信我的话,让我们看看性能更好:
class CLevel:
"Use default logic programmed in C"
class HighLevelPython:
def __ne__(self, other):
return not self == other
class LowLevelPython:
def __ne__(self, other):
equal = self.__eq__(other)
if equal is NotImplemented:
return NotImplemented
return not equal
def c_level():
cl = CLevel()
return lambda: cl != cl
def high_level_python():
hlp = HighLevelPython()
return lambda: hlp != hlp
def low_level_python():
llp = LowLevelPython()
return lambda: llp != llp
我认为这些性能数据不言自明:
>>> import timeit
>>> min(timeit.repeat(c_level()))
0.09377292497083545
>>> min(timeit.repeat(high_level_python()))
0.2654011140111834
>>> min(timeit.repeat(low_level_python()))
0.3378178110579029
low_level_python
当您考虑在 Python 中执行本应在 C 级别处理的逻辑时,这是有道理的。
回应一些批评者
另一位回答者写道:
Aaron Hall 的方法实现not self == other
是__ne__
不正确的,因为它永远无法返回NotImplemented
( not NotImplemented
is False
),因此__ne__
具有优先级的方法永远不会退回到__ne__
没有优先级的方法上。
永不__ne__
返回NotImplemented
并不意味着它不正确。NotImplemented
相反,我们通过检查与 的相等性来处理优先级==
。假设==
正确实施,我们就完成了。
not self == other
曾经是该__ne__
方法的默认 Python 3 实现,但它是一个错误,并在 2015 年 1 月的 Python 3.4 中得到纠正,正如 ShadowRanger 所注意到的(参见问题 #21408)。
好吧,让我们解释一下。
如前所述,Python 3 默认__ne__
通过首先检查是否self.__eq__(other)
返回NotImplemented
(单例)来处理 - 应该检查是否is
返回,如果是则返回,否则它应该返回相反的结果。这是编写为类 mixin 的逻辑:
class CStyle__ne__:
"""Mixin that provides __ne__ functionality equivalent to
the builtin functionality
"""
def __ne__(self, other):
equal = self.__eq__(other)
if equal is NotImplemented:
return NotImplemented
return not equal
这对于 C 级 Python API 的正确性是必要的,它是在 Python 3 中引入的,使得
多余的。所有相关__ne__
的方法都被删除了,包括那些实现自己的检查的方法以及__eq__
直接或通过委托的方法==
——==
这是最常见的方法。
对称重要吗?
我们坚持不懈的批评者提供了一个病态的例子来说明处理的情况NotImplemented
,__ne__
重视对称性高于一切。让我们用一个明确的例子来论证这个论点:
class B:
"""
this class has no __eq__ implementation, but asserts
any instance is not equal to any other object
"""
def __ne__(self, other):
return True
class A:
"This class asserts instances are equivalent to all other objects"
def __eq__(self, other):
return True
>>> A() == B(), B() == A(), A() != B(), B() != A()
(True, True, False, True)
因此,按照这个逻辑,为了保持对称性,我们需要编写复杂的__ne__
,无论 Python 版本如何。
class B:
def __ne__(self, other):
return True
class A:
def __eq__(self, other):
return True
def __ne__(self, other):
result = other.__eq__(self)
if result is NotImplemented:
return NotImplemented
return not result
>>> A() == B(), B() == A(), A() != B(), B() != A()
(True, True, True, True)
显然,我们不应该介意这些实例既相等又不相等。
我建议对称性不如合理代码的假设和遵循文档的建议重要。
但是,如果 A 有一个合理的实现__eq__
,那么我们仍然可以按照我的方向在这里,我们仍然会有对称性:
class B:
def __ne__(self, other):
return True
class A:
def __eq__(self, other):
return False # <- this boolean changed...
>>> A() == B(), B() == A(), A() != B(), B() != A()
(False, False, True, True)
结论
对于 Python 2 兼容代码,用于==
实现__ne__
. 它更多:
仅在 Python 3 中,使用 C 级别的低级否定 - 它更加简单和高效(尽管程序员负责确定它是正确的)。
同样,不要在高级 Python 中编写低级逻辑。