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)

Возвращает True, если obj истинно, и 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, для чисел 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)

Возвращает оценочную длину для объекта 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)

Возвращает вызываемый объект, который извлекает item из своего операнда, используя метод операнда __getitem__(). Если указано несколько элементов, возвращается кортеж значений поиска. Например:

  • После 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)

Индексированное назначение

obj[k] = v

setitem(obj, k, v)

Индексированное удаление

del obj[k]

delitem(obj, k)

Индексирование

obj[k]

getitem(obj, k)

Левая смена

a << b

lshift(a, b)

Modulo

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)

Правый Shift

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)

Операторы на месте

Многие операции имеют «in-place» версию. Ниже перечислены функции, обеспечивающие более примитивный доступ к операторам in-place, чем это делает обычный синтаксис; например, оператор statement x += y эквивалентен x = operator.iadd(x, y). По-другому можно сказать, что z = operator.iadd(x, y) эквивалентен составному оператору z = x; z += y.

В этих примерах обратите внимание, что при вызове метода in-place вычисление и присвоение выполняются в два отдельных этапа. Функции in-place, перечисленные ниже, выполняют только первый шаг - вызов метода in-place. Второй шаг, присвоение, не обрабатывается.

Для неизменяемых объектов, таких как строки, числа и кортежи, обновленное значение вычисляется, но не присваивается обратно входной переменной:

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

Для изменяемых объектов, таких как списки и словари, метод in-place будет выполнять обновление, поэтому последующее присвоение не требуется:

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

Вернуться на верх