operator — 标准运算符作为函数

源代码: Lib/operator.py

---

operator 模块导出了一组高效函数，它们对应于 Python 的内在运算符。例如，operator.add(x, y) 等价于表达式 x+y。许多函数名称与特殊方法使用的名称相同，只是没有双下划线。为了向后兼容，许多函数都有一个保留双下划线的变体。为了清晰起见，推荐使用没有双下划线的变体。

这些函数分为执行对象比较、逻辑运算、数学运算和序列运算的类别。

对象比较函数对所有对象都很有用，并以它们支持的富比较运算符命名。

operator.lt(a, b)

operator.le(a, b)

operator.eq(a, b)

operator.ne(a, b)

operator.ge(a, b)

operator.gt(a, b)

operator.__lt__(a, b)

operator.__le__(a, b)

operator.__eq__(a, b)

operator.__ne__(a, b)

operator.__ge__(a, b)

operator.__gt__(a, b)

在 a 和 b 之间执行“富比较”。具体来说，lt(a, b) 等价于 a < b，le(a, b) 等价于 a <= b，eq(a, b) 等价于 a == b，ne(a, b) 等价于 a != b，gt(a, b) 等价于 a > b，ge(a, b) 等价于 a >= b。请注意，这些函数可以返回任何值，这些值可能或不可能被解释为布尔值。有关富比较的更多信息，请参阅比较。

逻辑操作通常也适用于所有对象，并支持真值测试、同一性测试和布尔操作

operator.not_(obj)

operator.__not__(obj)

返回 not obj 的结果。（请注意，对象实例没有 __not__() 方法；只有解释器核心定义此操作。结果受 __bool__() 和 __len__() 方法的影响。）

operator.truth(obj)

如果 obj 为真，则返回 True，否则返回 False。这等价于使用 bool 构造函数。

operator.is_(a, b)

返回 a is b。测试对象同一性。

operator.is_not(a, b)

返回 a is not b。测试对象同一性。

operator.is_none(a)

返回 a is None。测试对象同一性。

在 3.14 版本加入。

operator.is_not_none(a)

返回 a is not None。测试对象同一性。

在 3.14 版本加入。

数学和位运算最为繁多

operator.abs(obj)

operator.__abs__(obj)

返回 obj 的绝对值。

operator.add(a, b)

operator.__add__(a, b)

当 a 和 b 为数字时，返回 a + b。

operator.and_(a, b)

operator.__and__(a, b)

返回 a 和 b 的按位与。

operator.floordiv(a, b)

operator.__floordiv__(a, b)

返回 a // b。

operator.index(a)

operator.__index__(a)

将 a 转换为整数后返回。等价于 a.__index__()。

3.10 版本中已变更: 结果总是精确的 int 类型。以前，结果可能是 int 的子类实例。

operator.inv(obj)

operator.invert(obj)

operator.__inv__(obj)

operator.__invert__(obj)

返回数字 obj 的按位反。这等价于 ~obj。

operator.lshift(a, b)

operator.__lshift__(a, b)

返回 a 左移 b 位。

operator.mod(a, b)

operator.__mod__(a, b)

返回 a % b。

operator.mul(a, b)

operator.__mul__(a, b)

当 a 和 b 为数字时，返回 a * b。

operator.matmul(a, b)

operator.__matmul__(a, b)

返回 a @ b。

在 3.5 版本加入。

operator.neg(obj)

operator.__neg__(obj)

返回 obj 的负值 (-obj)。

operator.or_(a, b)

operator.__or__(a, b)

返回 a 和 b 的按位或。

operator.pos(obj)

operator.__pos__(obj)

返回 obj 的正值 (+obj)。

operator.pow(a, b)

operator.__pow__(a, b)

当 a 和 b 为数字时，返回 a ** b。

operator.rshift(a, b)

operator.__rshift__(a, b)

返回 a 右移 b 位。

operator.sub(a, b)

operator.__sub__(a, b)

返回 a - b。

operator.truediv(a, b)

operator.__truediv__(a, b)

返回 a / b，其中 2/3 为 .66 而不是 0。这也称为“真”除法。

operator.xor(a, b)

operator.__xor__(a, b)

返回 a 和 b 的按位异或。

与序列（有些也与映射）一起使用的操作包括

operator.concat(a, b)

operator.__concat__(a, b)

当 a 和 b 为序列时，返回 a + b。

operator.contains(a, b)

operator.__contains__(a, b)

返回测试 b in a 的结果。请注意操作数是反向的。

operator.countOf(a, b)

返回 b 在 a 中出现的次数。

operator.delitem(a, b)

operator.__delitem__(a, b)

删除 a 在索引 b 处的值。

operator.getitem(a, b)

operator.__getitem__(a, b)

返回 a 在索引 b 处的值。

operator.indexOf(a, b)

返回 b 在 a 中首次出现的索引。

operator.setitem(a, b, c)

operator.__setitem__(a, b, c)

将 a 在索引 b 处的值设置为 c。

operator.length_hint(obj, default=0)

返回对象 obj 的估计长度。首先尝试返回其实际长度，然后使用 object.__length_hint__() 估计，最后返回默认值。

在 3.4 版本加入。

以下操作适用于可调用对象

operator.call(obj, /, *args, **kwargs)

operator.__call__(obj, /, *args, **kwargs)

返回 obj(*args, **kwargs)。

在 3.11 版本中新增。

operator 模块还定义了用于通用属性和项查找的工具。这些工具对于创建快速字段提取器作为 map()、sorted()、itertools.groupby() 或其他需要函数参数的函数的参数非常有用。

operator.attrgetter(attr)

operator.attrgetter(*attrs)

返回一个可调用对象，该对象从其操作数中获取 attr。如果请求了多个属性，则返回一个属性元组。属性名称也可以包含点。例如

• 在 f = attrgetter('name') 之后，调用 f(b) 返回 b.name。

• 在 f = attrgetter('name', 'date') 之后，调用 f(b) 返回 (b.name, b.date)。

• 在 f = attrgetter('name.first', 'name.last') 之后，调用 f(b) 返回 (b.name.first, b.name.last)。

等价于：

def attrgetter(*items):
    if any(not isinstance(item, str) for item in items):
        raise TypeError('attribute name must be a string')
    if len(items) == 1:
        attr = items[0]
        def g(obj):
            return resolve_attr(obj, attr)
    else:
        def g(obj):
            return tuple(resolve_attr(obj, attr) for attr in items)
    return g

def resolve_attr(obj, attr):
    for name in attr.split("."):
        obj = getattr(obj, name)
    return obj

operator.itemgetter(item)

operator.itemgetter(*items)

返回一个可调用对象，该对象使用操作数的 __getitem__() 方法从其操作数中获取 item。如果指定了多个项，则返回一个查找值元组。例如

• 在 f = itemgetter(2) 之后，调用 f(r) 返回 r[2]。

• 在 g = itemgetter(2, 5, 3) 之后，调用 g(r) 返回 (r[2], r[5], r[3])。

等价于：

def itemgetter(*items):
    if len(items) == 1:
        item = items[0]
        def g(obj):
            return obj[item]
    else:
        def g(obj):
            return tuple(obj[item] for item in items)
    return g

这些项可以是操作数的 __getitem__() 方法接受的任何类型。字典接受任何可哈希值。列表、元组和字符串接受索引或切片。

>>> itemgetter(1)('ABCDEFG')
'B'
>>> itemgetter(1, 3, 5)('ABCDEFG')
('B', 'D', 'F')
>>> itemgetter(slice(2, None))('ABCDEFG')
'CDEFG'
>>> soldier = dict(rank='captain', name='dotterbart')
>>> itemgetter('rank')(soldier)
'captain'

itemgetter() 用于从元组记录中检索特定字段的示例

>>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
>>> getcount = itemgetter(1)
>>> list(map(getcount, inventory))
[3, 2, 5, 1]
>>> sorted(inventory, key=getcount)
[('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]

operator.methodcaller(name, /, *args, **kwargs)

返回一个可调用对象，该对象在其操作数上调用方法 name。如果提供了额外的参数和/或关键字参数，它们也将传递给该方法。例如

• 在 f = methodcaller('name') 之后，调用 f(b) 返回 b.name()。

• 在 f = methodcaller('name', 'foo', bar=1) 之后，调用 f(b) 返回 b.name('foo', bar=1)。

等价于：

def methodcaller(name, /, *args, **kwargs):
    def caller(obj):
        return getattr(obj, name)(*args, **kwargs)
    return caller

将运算符映射到函数

此表显示了抽象操作如何对应于 Python 语法中的运算符符号和 operator 模块中的函数。

操作	语法	函数
加法	a + b	add(a, b)
连接	seq1 + seq2	concat(seq1, seq2)
包含测试	obj in seq	contains(seq, obj)
除法	a / b	truediv(a, b)
除法	a // b	floordiv(a, b)
按位与	a & b	and_(a, b)
按位异或	a ^ b	xor(a, b)
按位反	~ a	invert(a)
按位或	a | b	or_(a, b)
幂运算	a ** b	pow(a, b)
同一性	a is b	is_(a, b)
同一性	a is not b	is_not(a, b)
同一性	a is None	is_none(a)
同一性	a is not None	is_not_none(a)
索引赋值	obj[k] = v	setitem(obj, k, v)
索引删除	del obj[k]	delitem(obj, k)
索引	obj[k]	getitem(obj, k)
左移	a << b	lshift(a, b)
取模	a % b	mod(a, b)
乘法	a * b	mul(a, b)
矩阵乘法	a @ b	matmul(a, b)
取反（算术）	- a	neg(a)
取反（逻辑）	not a	not_(a)
取正	+ a	pos(a)
右移	a >> b	rshift(a, b)
切片赋值	seq[i:j] = values	setitem(seq, slice(i, j), values)
切片删除	del seq[i:j]	delitem(seq, slice(i, j))
切片	seq[i:j]	getitem(seq, slice(i, j))
字符串格式化	s % obj	mod(s, obj)
减法	a - b	sub(a, b)
真值测试	obj	truth(obj)
排序	a < b	lt(a, b)
排序	a <= b	le(a, b)
相等	a == b	eq(a, b)
不等	a != b	ne(a, b)
排序	a >= b	ge(a, b)
排序	a > b	gt(a, b)

原地运算符

许多操作都有“原地”版本。下面列出的函数提供了比通常语法更原始的访问原地运算符的方式；例如，语句 x += y 等价于 x = operator.iadd(x, y)。另一种说法是，z = operator.iadd(x, y) 等价于复合语句 z = x; z += y。

在这些示例中，请注意，当调用原地方法时，计算和赋值分为两个独立的步骤进行。下面列出的原地函数只执行第一步，即调用原地方法。第二步，赋值，未处理。

对于字符串、数字和元组等不可变目标，计算更新后的值，但不重新赋值给输入变量

>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'

对于列表和字典等可变目标，原地方法将执行更新，因此无需后续赋值

>>> s = ['h', 'e', 'l', 'l', 'o']
>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
>>> s
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']

operator.iadd(a, b)

operator.__iadd__(a, b)

a = iadd(a, b) 等价于 a += b。

operator.iand(a, b)

operator.__iand__(a, b)

a = iand(a, b) 等价于 a &= b。

operator.iconcat(a, b)

operator.__iconcat__(a, b)

a = iconcat(a, b) 等价于序列 a 和 b 的 a += b。

operator.ifloordiv(a, b)

operator.__ifloordiv__(a, b)

a = ifloordiv(a, b) 等价于 a //= b。

operator.ilshift(a, b)

operator.__ilshift__(a, b)

a = ilshift(a, b) 等价于 a <<= b。

operator.imod(a, b)

operator.__imod__(a, b)

a = imod(a, b) 等价于 a %= b。

operator.imul(a, b)

operator.__imul__(a, b)

a = imul(a, b) 等价于 a *= b。

operator.imatmul(a, b)

operator.__imatmul__(a, b)

a = imatmul(a, b) 等价于 a @= b。

在 3.5 版本加入。

operator.ior(a, b)

operator.__ior__(a, b)

a = ior(a, b) 等价于 a |= b。

operator.ipow(a, b)

operator.__ipow__(a, b)

a = ipow(a, b) 等价于 a **= b。

operator.irshift(a, b)

operator.__irshift__(a, b)

a = irshift(a, b) 等价于 a >>= b。

operator.isub(a, b)

operator.__isub__(a, b)

a = isub(a, b) 等价于 a -= b。

operator.itruediv(a, b)

operator.__itruediv__(a, b)

a = itruediv(a, b) 等价于 a /= b。

operator.ixor(a, b)

operator.__ixor__(a, b)

a = ixor(a, b) 等价于 a ^= b。