Skip to main content

10.3. 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)

ab 之间执行“丰富比较”。具体地,lt(a, b) 等价于 a < ble(a, b) 等价于 a <= beq(a, b) 等价于 a == bne(a, b) 等价于 a != bgt(a, b) 等价于 a > bge(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.abs(obj)
operator.__abs__(obj)

返回 obj 的绝对值。

operator.add(a, b)
operator.__add__(a, b)

返回 a + b,用于 ab 数。

operator.and_(a, b)
operator.__and__(a, b)

返回 ab 的按位和。

operator.floordiv(a, b)
operator.__floordiv__(a, b)

返回 a // b

operator.index(a)
operator.__index__(a)

返回 a 转换为整数。相当于 a.__index__()

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,用于 ab 数。

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)

返回按位或 ab

operator.pos(obj)
operator.__pos__(obj)

返回 obj 阳性(+obj)。

operator.pow(a, b)
operator.__pow__(a, b)

返回 a ** b,用于 ab 数。

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)

返回按位异或或 ab

使用序列(其中一些与映射)的操作包括:

operator.concat(a, b)
operator.__concat__(a, b)

ab 序列返回 a + b

operator.contains(a, b)
operator.__contains__(a, b)

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

operator.countOf(a, b)

返回 ab 的出现次数。

operator.delitem(a, b)
operator.__delitem__(a, b)

在索引 b 处删除 a 的值。

operator.getitem(a, b)
operator.__getitem__(a, b)

在索引 b 处返回 a 的值。

operator.indexOf(a, b)

返回 ab 的第一次出现的索引。

operator.setitem(a, b, c)
operator.__setitem__(a, b, c)

a 的值在索引 b 设置为 c

operator.length_hint(obj, default=0)

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

3.4 新版功能.

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'

使用 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...])

返回在其操作数上调用方法 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

10.3.1. 将运算符映射到函数

此表显示抽象操作如何对应于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)

索引赋值

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)

10.3.2. Inplace运算符

许多操作都有“in-place”版本。下面列出的是比通常的语法提供对原位操作符更原始的访问的函数;例如,statement 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'

对于可变目标(如列表和字典),inplace方法将执行更新,因此不需要后续分配:

>>> 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) 相当于 ab 序列的 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