functools.md
1> **Источник:** https://python-all.ru/3.7/library/functools.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`functools`](https://python-all.ru/3.7/library/functools.html#module-functools) – Функции высшего порядка и операции над вызываемыми объектами89**Исходный код:** [Lib/functools.py](https://python-all.ru/src/3.7/Lib/functools.py)1011---1213Модуль [`functools`](https://python-all.ru/3.7/library/functools.html#module-functools) предназначен для функций высшего порядка: функций, которые действуют на или возвращают другие функции. В общем случае любой вызываемый объект может рассматриваться как функция для целей этого модуля.1415Модуль [`functools`](https://python-all.ru/3.7/library/functools.html#module-functools) определяет следующие функции:1617#### `functools.cmp_to_key(func)`1819Преобразует старую функцию сравнения в [функцию ключа](https://python-all.ru/3.7/glossary.html#term-key-function). Используется с инструментами, которые принимают функции ключа (такими как [`sorted()`](https://python-all.ru/3.7/library/functions.html#sorted), [`min()`](https://python-all.ru/3.7/library/functions.html#min), [`max()`](https://python-all.ru/3.7/library/functions.html#max), [`heapq.nlargest()`](https://python-all.ru/3.7/library/heapq.html#heapq.nlargest), [`heapq.nsmallest()`](https://python-all.ru/3.7/library/heapq.html#heapq.nsmallest), [`itertools.groupby()`](https://python-all.ru/3.7/library/itertools.html#itertools.groupby)). Эта функция в первую очередь используется как инструмент перехода для программ, переносимых с Python 2, который поддерживал использование функций сравнения.2021Функция сравнения – это любой вызываемый объект, который принимает два аргумента, сравнивает их и возвращает отрицательное число, если первый меньше второго, ноль при равенстве или положительное число, если первый больше второго. Функция ключа – это вызываемый объект, который принимает один аргумент и возвращает другое значение, используемое в качестве ключа сортировки.2223Пример:2425```python26sorted(iterable, key=cmp_to_key(locale.strcoll)) # порядок сортировки с учётом локали27```2829Примеры сортировки и краткое руководство см. в [Sorting HOW TO](https://python-all.ru/3.7/howto/sorting.html#sortinghowto).3031Новое в версии 3.2.3233#### `@functools.lru_cache(maxsize=128, typed=False)`3435Декоратор для обёртывания функции запоминающим вызываемым объектом, который сохраняет до *maxsize* последних вызовов. Это может сэкономить время, когда дорогостоящая или связанная с вводом-выводом функция периодически вызывается с одними и теми же аргументами.3637Поскольку для кеширования результатов используется словарь, позиционные и именованные аргументы функции должны быть хешируемыми.3839Различные наборы аргументов могут считаться разными вызовами с отдельными записями в кеше. Например, *f(a=1, b=2)* и *f(b=2, a=1)* различаются порядком именованных аргументов и могут иметь две отдельные записи в кеше.4041Если *maxsize* установлен в `None`, механизм LRU отключается, и размер кэша может расти без ограничений. Механизм LRU работает лучше всего, когда *maxsize* является степенью двойки.4243Если для *typed* установлено значение true, аргументы функции разных типов будут кешироваться отдельно. Например, `f(3)` и `f(3.0)` будут считаться разными вызовами с разными результатами.4445Чтобы оценить эффективность кеша и настроить параметр *maxsize*, обёрнутая функция дополняется функцией `cache_info()`, которая возвращает [именованный кортеж](https://python-all.ru/3.7/glossary.html#term-named-tuple), показывающий *hits* (попадания), *misses* (промахи), *maxsize* и *currsize*. В многопоточной среде значения попаданий и промахов являются приблизительными.4647Декоратор также предоставляет функцию `cache_clear()` для очистки или инвалидации кэша.4849Исходная базовая функция доступна через атрибут `__wrapped__`. Это полезно для интроспекции, обхода кэша или повторной обёртки функции другим кэшем.5051Кэш [LRU (least recently used – вытеснение давно неиспользуемых)](https://python-all.ru/3.7/library/functools.html) работает наилучшим образом, когда самые последние вызовы являются лучшими предикторами будущих вызовов (например, самые популярные статьи на новостном сервере имеют тенденцию меняться каждый день). Ограничение размера кэша гарантирует, что он не будет бесконечно расти в долго работающих процессах, таких как веб-серверы.5253В целом, LRU-кеш следует использовать только тогда, когда нужно повторно использовать ранее вычисленные значения. Соответственно, нет смысла кешировать функции с побочными эффектами, функции, которым нужно создавать различные изменяемые объекты при каждом вызове, или нечистые функции, такие как time() или random().5455Пример LRU-кэша для статического веб-контента:5657```python58@lru_cache(maxsize=32)59def get_pep(num):60 'Retrieve text of a Python Enhancement Proposal'61 resource = 'http://www.python.org/dev/peps/pep-%04d/' % num62 try:63 with urllib.request.urlopen(resource) as s:64 return s.read()65 except urllib.error.HTTPError:66 return 'Not Found'6768>>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:69... pep = get_pep(n)70... print(n, len(pep))7172>>> get_pep.cache_info()73CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)74```7576Пример эффективного вычисления [чисел Фибоначчи](https://python-all.ru/3.7/library/functools.html) с использованием кэша для реализации техники [динамического программирования](https://python-all.ru/3.7/library/functools.html):7778```python79@lru_cache(maxsize=None)80def fib(n):81 if n < 2:82 return n83 return fib(n-1) + fib(n-2)8485>>> [fib(n) for n in range(16)]86[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]8788>>> fib.cache_info()89CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)90```9192Новое в версии 3.2.9394Изменено в версии 3.3: Добавлена опция *typed*.9596#### `@functools.total_ordering`9798Для класса, определяющего один или несколько методов расширенного сравнения, этот декоратор класса предоставляет остальные. Это упрощает задачу определения всех возможных операций расширенного сравнения:99100Класс должен определять один из [`__lt__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__lt__), [`__le__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__le__), [`__gt__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__gt__) или [`__ge__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__ge__). Кроме того, класс должен предоставлять метод [`__eq__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__eq__).101102Например:103104```python105@total_ordering106class Student:107 def _is_valid_operand(self, other):108 return (hasattr(other, "lastname") and109 hasattr(other, "firstname"))110 def __eq__(self, other):111 if not self._is_valid_operand(other):112 return NotImplemented113 return ((self.lastname.lower(), self.firstname.lower()) ==114 (other.lastname.lower(), other.firstname.lower()))115 def __lt__(self, other):116 if not self._is_valid_operand(other):117 return NotImplemented118 return ((self.lastname.lower(), self.firstname.lower()) <119 (other.lastname.lower(), other.firstname.lower()))120```121122> **Примечание**123>124> Хотя этот декоратор упрощает создание хорошо ведущих себя полностью упорядоченных типов, он *действительно* приводит к более медленному выполнению и более сложным трассировкам стека для производных методов сравнения. Если бенчмаркинг производительности показывает, что это является узким местом для конкретного приложения, реализация всех шести методов расширенного сравнения вместо этого, вероятно, даст лёгкий прирост скорости.125126Новое в версии 3.2.127128Изменено в версии 3.4: Теперь поддерживается возврат NotImplemented из нижележащей функции сравнения для нераспознанных типов.129130#### `functools.partial(func, *args, **keywords)`131132Возвращает новый [объект partial](https://python-all.ru/3.7/library/functools.html#partial-objects), который при вызове будет вести себя как *func*, вызванная с позиционными аргументами *args* и именованными аргументами *keywords*. Если при вызове передаётся больше аргументов, они добавляются к *args*. Если передаются дополнительные именованные аргументы, они расширяют и переопределяют *keywords*. Примерно эквивалентно следующему:133134```python135def partial(func, *args, **keywords):136 def newfunc(*fargs, **fkeywords):137 newkeywords = keywords.copy()138 newkeywords.update(fkeywords)139 return func(*args, *fargs, **newkeywords)140 newfunc.func = func141 newfunc.args = args142 newfunc.keywords = keywords143 return newfunc144```145146[`partial()`](https://python-all.ru/3.7/library/functools.html#functools.partial) используется для частичного применения функции, которое «замораживает» некоторую часть аргументов и/или ключевых слов функции, создавая новый объект с упрощённой сигнатурой. Например, [`partial()`](https://python-all.ru/3.7/library/functools.html#functools.partial) можно использовать для создания вызываемого объекта, который ведёт себя как функция [`int()`](https://python-all.ru/3.7/library/functions.html#int), где аргумент *base* по умолчанию равен двум:147148```python149>>> from functools import partial150>>> basetwo = partial(int, base=2)151>>> basetwo.__doc__ = 'Convert base 2 string to an int.'152>>> basetwo('10010')15318154```155156#### `class functools.partialmethod(func, *args, **keywords)`157158Возвращает новый дескриптор [`partialmethod`](https://python-all.ru/3.7/library/functools.html#functools.partialmethod), который ведёт себя как [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial), за исключением того, что он предназначен для использования в качестве определения метода, а не для прямого вызова.159160*func* должен быть [дескриптором](https://python-all.ru/3.7/glossary.html#term-descriptor) или вызываемым объектом (объекты, являющиеся и тем и другим, как обычные функции, обрабатываются как дескрипторы).161162Когда *func* является дескриптором (например, обычная функция Python, [`classmethod()`](https://python-all.ru/3.7/library/functions.html#classmethod), [`staticmethod()`](https://python-all.ru/3.7/library/functions.html#staticmethod), `abstractmethod()` или другой экземпляр [`partialmethod`](https://python-all.ru/3.7/library/functools.html#functools.partialmethod)), вызовы `__get__` делегируются базовому дескриптору, а в качестве результата возвращается подходящий [частичный объект](https://python-all.ru/3.7/library/functools.html#partial-objects).163164Когда *func* – это вызываемый объект, не являющийся дескриптором, динамически создаётся соответствующий связанный метод. Он ведёт себя как обычная функция Python при использовании в качестве метода: аргумент *self* будет вставлен как первый позиционный аргумент, даже до *args* и *keywords*, переданных конструктору [`partialmethod`](https://python-all.ru/3.7/library/functools.html#functools.partialmethod).165166Пример:167168```python169>>> class Cell(object):170... def __init__(self):171... self._alive = False172... @property173... def alive(self):174... return self._alive175... def set_state(self, state):176... self._alive = bool(state)177... set_alive = partialmethod(set_state, True)178... set_dead = partialmethod(set_state, False)179...180>>> c = Cell()181>>> c.alive182False183>>> c.set_alive()184>>> c.alive185True186```187188Новое в версии 3.4.189190#### `functools.reduce(function, iterable[, initializer])`191192Применяет *function* с двумя аргументами последовательно к элементам *sequence*, слева направо, чтобы свести последовательность к одному значению. Например, `reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])` вычисляет `((((1+2)+3)+4)+5)`. Левый аргумент, *x*, – это накопленное значение, а правый аргумент, *y*, – это новое значение из *sequence*. Если указан необязательный *initializer*, он помещается перед элементами последовательности в вычислении и служит значением по умолчанию, если последовательность пуста. Если *initializer* не указан, а *sequence* содержит только один элемент, возвращается этот первый элемент.193194Примерно эквивалентно:195196```python197def reduce(function, iterable, initializer=None):198 it = iter(iterable)199 if initializer is None:200 value = next(it)201 else:202 value = initializer203 for element in it:204 value = function(value, element)205 return value206```207208#### `@functools.singledispatch`209210Преобразует функцию в [однодиспетчерскую](https://python-all.ru/3.7/glossary.html#term-single-dispatch) [обобщённую функцию](https://python-all.ru/3.7/glossary.html#term-generic-function).211212Чтобы определить обобщённую функцию, декорируйте её декоратором `@singledispatch`. Обратите внимание, что диспетчеризация осуществляется по типу первого аргумента, создавайте свою функцию соответственно:213214```python215>>> from functools import singledispatch216>>> @singledispatch217... def fun(arg, verbose=False):218... if verbose:219... print("Let me just say,", end=" ")220... print(arg)221```222223Чтобы добавить перегруженные реализации к функции, используйте атрибут `register()` обобщённой функции. Это декоратор. Для функций, аннотированных типами, декоратор автоматически выводит тип первого аргумента:224225```python226>>> @fun.register227... def _(arg: int, verbose=False):228... if verbose:229... print("Strength in numbers, eh?", end=" ")230... print(arg)231...232>>> @fun.register233... def _(arg: list, verbose=False):234... if verbose:235... print("Enumerate this:")236... for i, elem in enumerate(arg):237... print(i, elem)238```239240Для кода, не использующего аннотации типов, подходящий тип можно передать явно самому декоратору:241242```python243>>> @fun.register(complex)244... def _(arg, verbose=False):245... if verbose:246... print("Better than complicated.", end=" ")247... print(arg.real, arg.imag)248...249```250251Чтобы включить регистрацию лямбда-функций и уже существующих функций, атрибут `register()` можно использовать в функциональной форме:252253```python254>>> def nothing(arg, verbose=False):255... print("Nothing.")256...257>>> fun.register(type(None), nothing)258```259260Атрибут `register()` возвращает недекорированную функцию, что позволяет накладывать декораторы, выполнять сериализацию и создавать модульные тесты для каждого варианта независимо:261262```python263>>> @fun.register(float)264... @fun.register(Decimal)265... def fun_num(arg, verbose=False):266... if verbose:267... print("Half of your number:", end=" ")268... print(arg / 2)269...270>>> fun_num is fun271False272```273274При вызове обобщённая функция выполняет диспетчеризацию по типу первого аргумента:275276```python277>>> fun("Hello, world.")278Hello, world.279>>> fun("test.", verbose=True)280Let me just say, test.281>>> fun(42, verbose=True)282Strength in numbers, eh? 42283>>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)284Enumerate this:2850 spam2861 spam2872 eggs2883 spam289>>> fun(None)290Nothing.291>>> fun(1.23)2920.615293```294295Если для конкретного типа нет зарегистрированной реализации, используется порядок разрешения методов (MRO) этого типа для поиска более общей реализации. Исходная функция, декорированная `@singledispatch`, зарегистрирована для базового типа `object`, то есть она используется, если не найдено более подходящей реализации.296297Чтобы проверить, какую реализацию выберет обобщённая функция для заданного типа, используйте атрибут `dispatch()`:298299```python300>>> fun.dispatch(float)301<function fun_num at 0x1035a2840>302>>> fun.dispatch(dict) # примечание: реализация по умолчанию303<function fun at 0x103fe0000>304```305306Чтобы получить доступ ко всем зарегистрированным реализациям, используйте атрибут `registry` только для чтения:307308```python309>>> fun.registry.keys()310dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,311 <class 'decimal.Decimal'>, <class 'list'>,312 <class 'float'>])313>>> fun.registry[float]314<function fun_num at 0x1035a2840>315>>> fun.registry[object]316<function fun at 0x103fe0000>317```318319Новое в версии 3.4.320321Изменено в версии 3.7: Атрибут `register()` теперь поддерживает использование аннотаций типов.322323#### `functools.update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)`324325Обновляет функцию-*обёртку* так, чтобы она походила на *обёрнутую* функцию. Необязательные аргументы – это кортежи, определяющие, какие атрибуты исходной функции напрямую присваиваются соответствующим атрибутам функции-обёртки, а какие атрибуты функции-обёртки обновляются соответствующими атрибутами из исходной функции. Значения по умолчанию для этих аргументов – константы уровня модуля `WRAPPER_ASSIGNMENTS` (которая присваивает функции-обёртке атрибуты `__module__`, `__name__`, `__qualname__`, `__annotations__` и `__doc__`, строку документации) и `WRAPPER_UPDATES` (которая обновляет `__dict__` функции-обёртки, т.е. словарь экземпляра).326327Чтобы обеспечить доступ к исходной функции для интроспекции и других целей (например, обхода кэширующего декоратора такого как [`lru_cache()`](https://python-all.ru/3.7/library/functools.html#functools.lru_cache)), эта функция автоматически добавляет атрибут `__wrapped__` к обёртке, который ссылается на обёрнутую функцию.328329Основное назначение этой функции – использование в [decorator](https://python-all.ru/3.7/glossary.html#term-decorator)-функциях, которые оборачивают декорированную функцию и возвращают обёртку. Если функция-обёртка не обновляется, метаданные возвращаемой функции будут отражать определение обёртки, а не исходной функции, что обычно не очень полезно.330331[`update_wrapper()`](https://python-all.ru/3.7/library/functools.html#functools.update_wrapper) можно использовать с вызываемыми объектами, отличными от функций. Любые атрибуты, указанные в *assigned* или *updated*, отсутствующие в оборачиваемом объекте, игнорируются (т.е. эта функция не будет пытаться установить их в функции-обёртке). [`AttributeError`](https://python-all.ru/3.7/library/exceptions.html#AttributeError) по-прежнему возбуждается, если сама функция-обёртка не имеет каких-либо атрибутов, перечисленных в *updated*.332333Новое в версии 3.2: Автоматическое добавление атрибута `__wrapped__`.334335Новое в версии 3.2: Копирование атрибута `__annotations__` по умолчанию.336337Изменено в версии 3.2: Отсутствующие атрибуты больше не вызывают исключение [`AttributeError`](https://python-all.ru/3.7/library/exceptions.html#AttributeError).338339Изменено в версии 3.4: Атрибут `__wrapped__` теперь всегда ссылается на обёрнутую функцию, даже если эта функция определяла атрибут `__wrapped__`. (см. [bpo-17482](https://python-all.ru/3.7/library/functools.html))340341#### `@functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)`342343Это удобная функция для вызова [`update_wrapper()`](https://python-all.ru/3.7/library/functools.html#functools.update_wrapper) в качестве декоратора функции при определении функции-обёртки. Она эквивалентна `partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)`. Например:344345```python346>>> from functools import wraps347>>> def my_decorator(f):348... @wraps(f)349... def wrapper(*args, **kwds):350... print('Calling decorated function')351... return f(*args, **kwds)352... return wrapper353...354>>> @my_decorator355... def example():356... """докстринг"""357... print('Called example function')358...359>>> example()360Calling decorated function361Called example function362>>> example.__name__363'example'364>>> example.__doc__365'Docstring'366```367368Без использования этой фабрики декораторов имя примера функции было бы `'wrapper'`, а строка документации исходной `example()` была бы потеряна.369370## [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial) Объекты371372Объекты [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial) – это вызываемые объекты, создаваемые [`partial()`](https://python-all.ru/3.7/library/functools.html#functools.partial). Они имеют три атрибута только для чтения:373374#### `partial.func`375376Вызываемый объект или функция. Вызовы объекта [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial) будут перенаправлены в [`func`](https://python-all.ru/3.7/library/functools.html#functools.partial.func) с новыми аргументами и ключевыми словами.377378#### `partial.args`379380Крайние левые позиционные аргументы, которые будут добавлены перед позиционными аргументами, переданными при вызове объекта [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial).381382#### `partial.keywords`383384Ключевые аргументы, которые будут предоставлены при вызове объекта [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial).385386Объекты [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial) похожи на объекты `function` тем, что они вызываемы, могут быть слабыми ссылками и могут иметь атрибуты. Есть несколько важных отличий. Например, атрибуты [`__name__`](https://python-all.ru/3.7/library/stdtypes.html#definition.__name__) и `__doc__` не создаются автоматически. Кроме того, объекты [`partial`](https://python-all.ru/3.7/library/functools.html#functools.partial), определённые в классах, ведут себя как статические методы и не превращаются в связанные методы при поиске атрибута экземпляра.387