functools —- 高阶函数和可调用对象上的操作

源代码:Lib/functools.py

functools 模块应用于高阶函数，即——参数或（和）返回值为其他函数的函数。通常来说，此模块的功能适用于所有可调用对象。

functools 模块定义了以下函数:

• @functools.cachedproperty(_func)
• Transform a method of a class into a property whose value is computed onceand then cached as a normal attribute for the life of the instance. Similarto property(), with the addition of caching. Useful for expensivecomputed properties of instances that are otherwise effectively immutable.

示例:

class DataSet:
    def __init__(self, sequence_of_numbers):
        self._data = sequence_of_numbers
 
    @cached_property
    def stdev(self):
        return statistics.stdev(self._data)
 
    @cached_property
    def variance(self):
        return statistics.variance(self._data)

3.8 新版功能.

注解

This decorator requires that the dict attribute on each instancebe a mutable mapping. This means it will not work with some types, such asmetaclasses (since the dict attributes on type instances areread-only proxies for the class namespace), and those that specifyslots without including dict as one of the defined slots(as such classes don't provide a dict attribute at all).

• functools.cmpto_key(_func)
• 将(旧式的)比较函数转换为新式的 key function . 在类似于 sorted() ， min() ， max() ， heapq.nlargest() ， heapq.nsmallest() ， itertools.groupby() 等函数的 key 参数中使用。此函数主要用作将 Python 2 程序转换至新版的转换工具，以保持对比较函数的兼容。

比较函数意为一个可调用对象，该对象接受两个参数并比较它们，结果为小于则返回一个负数，相等则返回零，大于则返回一个正数。key function则是一个接受一个参数，并返回另一个用以排序的值的可调用对象。

示例:

sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order

有关排序示例和简要排序教程，请参阅 排序指南 。

3.2 新版功能.

• @functools.lrucache(_user_function)
• @functools.lrucache(_maxsize=128, typed=False)
• 一个为函数提供缓存功能的装饰器，缓存 maxsize 组传入参数，在下次以相同参数调用时直接返回上一次的结果。用以节约高开销或I/O函数的调用时间。

由于使用了字典存储缓存，所以该函数的固定参数和关键字参数必须是可哈希的。

不同模式的参数可能被视为不同从而产生多个缓存项，例如, f(a=1, b=2) 和 f(b=2, a=1) 因其参数顺序不同，可能会被缓存两次。

If user_function is specified, it must be a callable. This allows thelru_cache decorator to be applied directly to a user function, leavingthe maxsize at its default value of 128:

@lru_cachedef count_vowels(sentence):    sentence = sentence.casefold()    return sum(sentence.count(vowel) for vowel in 'aeiou')

如果 maxsize 设置为 None ，LRU功能将被禁用且缓存数量无上限。 maxsize 设置为2的幂时可获得最佳性能。

如果 typed 设置为true，不同类型的函数参数将被分别缓存。例如， f(3) 和 f(3.0) 将被视为不同而分别缓存。

为了衡量缓存的有效性以便调整 maxsize 形参，被装饰的函数带有一个 cacheinfo() 函数。当调用 cache_info() 函数时，返回一个具名元组，包含命中次数 _hits，未命中次数 misses ，最大缓存数量 maxsize 和 当前缓存大小 currsize。在多线程环境中，命中数与未命中数是不完全准确的。

该装饰器也提供了一个用于清理/使缓存失效的函数 cache_clear() 。

原始的未经装饰的函数可以通过 wrapped 属性访问。它可以用于检查、绕过缓存，或使用不同的缓存再次装饰原始函数。

“最久未使用算法”（LRU）缓存 在“最近的调用是即将到来的调用的最佳预测因子”时性能最好（比如，新闻服务器上最受欢迎的文章倾向于每天更改）。 “缓存大小限制”参数保证缓存不会在长时间运行的进程比如说网站服务器上无限制的增加自身的大小。

一般来说，LRU缓存只在当你想要重用之前计算的结果时使用。因此，用它缓存具有副作用的函数、需要在每次调用时创建不同、易变的对象的函数或者诸如time（）或random（）之类的不纯函数是没有意义的。

静态 Web 内容的 LRU 缓存示例:

@lru_cache(maxsize=32)def get_pep(num):    'Retrieve text of a Python Enhancement Proposal'    resource = 'http://www.python.org/dev/peps/pep-%04d/' % num    try:        with urllib.request.urlopen(resource) as s:            return s.read()    except urllib.error.HTTPError:        return 'Not Found'
>>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:…     pep = get_pep(n)…     print(n, len(pep))
>>> get_pep.cache_info()CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)

以下是使用缓存通过 动态规划 计算 斐波那契数列 的例子。

@lru_cache(maxsize=None)def fib(n):    if n < 2:        return n    return fib(n-1) + fib(n-2)
>>> [fib(n) for n in range(16)][0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]
>>> fib.cache_info()CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)

3.2 新版功能.

在 3.3 版更改: 添加 typed 选项。

在 3.8 版更改: Added the user_function option.

• @functools.total_ordering
• 给定一个声明一个或多个全比较排序方法的类，这个类装饰器实现剩余的方法。这减轻了指定所有可能的全比较操作的工作。

此类必须包含以下方法之一：lt() 、le()、gt() 或 ge()。另外，此类必须支持 eq() 方法。

例如:

@totalorderingclass Student:    def isvalidoperand(self, other):        return (hasattr(other, "lastname") and                hasattr(other, "firstname"))    def __eq(self, other):        if not self._is_valid_operand(other):            return NotImplemented        return ((self.lastname.lower(), self.firstname.lower()) ==                (other.lastname.lower(), other.firstname.lower()))    def __lt(self, other):        if not self._is_valid_operand(other):            return NotImplemented        return ((self.lastname.lower(), self.firstname.lower()) <                (other.lastname.lower(), other.firstname.lower()))

注解

While this decorator makes it easy to create well behaved totallyordered types, it does come at the cost of slower execution andmore complex stack traces for the derived comparison methods. Ifperformance benchmarking indicates this is a bottleneck for a givenapplication, implementing all six rich comparison methods instead islikely to provide an easy speed boost.

3.2 新版功能.

在 3.4 版更改: Returning NotImplemented from the underlying comparison function forunrecognised types is now supported.

• functools.partial(func, /, *args, **keywords)
• Return a new partial object which when calledwill behave like func called with the positional arguments args_and keyword arguments _keywords. If more arguments are supplied to thecall, they are appended to args. If additional keyword arguments aresupplied, they extend and override keywords.Roughly equivalent to:

def partial(func, /, *args, **keywords):
    def newfunc(*fargs, **fkeywords):
        newkeywords = {**keywords, **fkeywords}
        return func(*args, *fargs, **newkeywords)
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc

The partial() is used for partial function application which "freezes"some portion of a function's arguments and/or keywords resulting in a new objectwith a simplified signature. For example, partial() can be used to createa callable that behaves like the int() function where the base argumentdefaults to two:

>>> from functools import partial
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18

• class functools.partialmethod(func, /, *args, **keywords)
• Return a new partialmethod descriptor which behaveslike partial except that it is designed to be used as a methoddefinition rather than being directly callable.

func must be a descriptor or a callable (objects which are both,like normal functions, are handled as descriptors).

When func is a descriptor (such as a normal Python function,classmethod(), staticmethod(), abstractmethod() oranother instance of partialmethod), calls to get aredelegated to the underlying descriptor, and an appropriatepartial object returned as the result.

When func is a non-descriptor callable, an appropriate bound method iscreated dynamically. This behaves like a normal Python function whenused as a method: the self argument will be inserted as the firstpositional argument, even before the args and keywords supplied tothe partialmethod constructor.

示例:

>>> class Cell(object):
...     def __init__(self):
...         self._alive = False
...     @property
...     def alive(self):
...         return self._alive
...     def set_state(self, state):
...         self._alive = bool(state)
...     set_alive = partialmethod(set_state, True)
...     set_dead = partialmethod(set_state, False)
...
>>> c = Cell()
>>> c.alive
False
>>> c.set_alive()
>>> c.alive
True

3.4 新版功能.

• functools.reduce(function, iterable[, initializer])
• Apply function of two arguments cumulatively to the items of iterable, fromleft to right, so as to reduce the iterable to a single value. For example,reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5).The left argument, x, is the accumulated value and the right argument, y, isthe update value from the iterable. If the optional initializer is present,it is placed before the items of the iterable in the calculation, and serves asa default when the iterable is empty. If initializer is not given anditerable contains only one item, the first item is returned.

大致相当于：

def reduce(function, iterable, initializer=None):
    it = iter(iterable)
    if initializer is None:
        value = next(it)
    else:
        value = initializer
    for element in it:
        value = function(value, element)
    return value

See itertools.accumulate() for an iterator that yields all intermediatevalues.

• @functools.singledispatch
• Transform a function into a single-dispatchgeneric function.

To define a generic function, decorate it with the @singledispatchdecorator. Note that the dispatch happens on the type of the first argument,create your function accordingly:

>>> from functools import singledispatch
>>> @singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)

To add overloaded implementations to the function, use the register()attribute of the generic function. It is a decorator. For functionsannotated with types, the decorator will infer the type of the firstargument automatically:

>>> @fun.register
... def _(arg: int, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> @fun.register
... def _(arg: list, verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)

For code which doesn't use type annotations, the appropriate typeargument can be passed explicitly to the decorator itself:

>>> @fun.register(complex)
... def _(arg, verbose=False):
...     if verbose:
...         print("Better than complicated.", end=" ")
...     print(arg.real, arg.imag)
...

To enable registering lambdas and pre-existing functions, theregister() attribute can be used in a functional form:

>>> def nothing(arg, verbose=False):
...     print("Nothing.")
...
>>> fun.register(type(None), nothing)

The register() attribute returns the undecorated function whichenables decorator stacking, pickling, as well as creating unit tests foreach variant independently:

>>> @fun.register(float)
... @fun.register(Decimal)
... def fun_num(arg, verbose=False):
...     if verbose:
...         print("Half of your number:", end=" ")
...     print(arg / 2)
...
>>> fun_num is fun
False

When called, the generic function dispatches on the type of the firstargument:

>>> fun("Hello, world.")
Hello, world.
>>> fun("test.", verbose=True)
Let me just say, test.
>>> fun(42, verbose=True)
Strength in numbers, eh? 42
>>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)
Enumerate this:
0 spam
1 spam
2 eggs
3 spam
>>> fun(None)
Nothing.
>>> fun(1.23)
0.615

Where there is no registered implementation for a specific type, itsmethod resolution order is used to find a more generic implementation.The original function decorated with @singledispatch is registeredfor the base object type, which means it is used if no betterimplementation is found.

To check which implementation will the generic function choose fora given type, use the dispatch() attribute:

>>> fun.dispatch(float)
<function fun_num at 0x1035a2840>
>>> fun.dispatch(dict)    # note: default implementation
<function fun at 0x103fe0000>

To access all registered implementations, use the read-only registryattribute:

>>> fun.registry.keys()
dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,
          <class 'decimal.Decimal'>, <class 'list'>,
          <class 'float'>])
>>> fun.registry[float]
<function fun_num at 0x1035a2840>
>>> fun.registry[object]
<function fun at 0x103fe0000>

3.4 新版功能.

在 3.7 版更改: The register() attribute supports using type annotations.

• class functools.singledispatchmethod(func)
• Transform a method into a single-dispatchgeneric function.

To define a generic method, decorate it with the @singledispatchmethoddecorator. Note that the dispatch happens on the type of the first non-selfor non-cls argument, create your function accordingly:

class Negator:
    @singledispatchmethod
    def neg(self, arg):
        raise NotImplementedError("Cannot negate a")
 
    @neg.register
    def _(self, arg: int):
        return -arg
 
    @neg.register
    def _(self, arg: bool):
        return not arg

@singledispatchmethod supports nesting with other decorators such as@classmethod. Note that to allow for dispatcher.register,singledispatchmethod must be the outer most decorator. Here is theNegator class with the neg methods being class bound:

class Negator:
    @singledispatchmethod
    @classmethod
    def neg(cls, arg):
        raise NotImplementedError("Cannot negate a")
 
    @neg.register
    @classmethod
    def _(cls, arg: int):
        return -arg
 
    @neg.register
    @classmethod
    def _(cls, arg: bool):
        return not arg

The same pattern can be used for other similar decorators: staticmethod,abstractmethod, and others.

3.8 新版功能.

• functools.updatewrapper(_wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
• Update a wrapper function to look like the wrapped function. The optionalarguments are tuples to specify which attributes of the original function areassigned directly to the matching attributes on the wrapper function and whichattributes of the wrapper function are updated with the corresponding attributesfrom the original function. The default values for these arguments are themodule level constants WRAPPERASSIGNMENTS (which assigns to the wrapperfunction's module, name, qualname, annotationsand doc, the documentation string) and WRAPPERUPDATES (whichupdates the wrapper function's __dict, i.e. the instance dictionary).

To allow access to the original function for introspection and other purposes(e.g. bypassing a caching decorator such as lru_cache()), this functionautomatically adds a wrapped attribute to the wrapper that refers tothe function being wrapped.

The main intended use for this function is in decorator functions whichwrap the decorated function and return the wrapper. If the wrapper function isnot updated, the metadata of the returned function will reflect the wrapperdefinition rather than the original function definition, which is typically lessthan helpful.

update_wrapper() may be used with callables other than functions. Anyattributes named in assigned or updated that are missing from the objectbeing wrapped are ignored (i.e. this function will not attempt to set themon the wrapper function). AttributeError is still raised if thewrapper function itself is missing any attributes named in updated.

3.2 新版功能: Automatic addition of the wrapped attribute.

3.2 新版功能: Copying of the annotations attribute by default.

在 3.2 版更改: Missing attributes no longer trigger an AttributeError.

在 3.4 版更改: The wrapped attribute now always refers to the wrappedfunction, even if that function defined a wrapped attribute.(see bpo-17482)

• @functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
• This is a convenience function for invoking update_wrapper() as afunction decorator when defining a wrapper function. It is equivalent topartial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated).For example:

>>> from functools import wraps
>>> def my_decorator(f):
...     @wraps(f)
...     def wrapper(*args, **kwds):
...         print('Calling decorated function')
...         return f(*args, **kwds)
...     return wrapper
...
>>> @my_decorator
... def example():
...     """Docstring"""
...     print('Called example function')
...
>>> example()
Calling decorated function
Called example function
>>> example.__name__
'example'
>>> example.__doc__
'Docstring'

Without the use of this decorator factory, the name of the example functionwould have been 'wrapper', and the docstring of the original example()would have been lost.

partial Objects

partial objects are callable objects created by partial(). Theyhave three read-only attributes:

• partial.func

• A callable object or function. Calls to the partial object will beforwarded to func with new arguments and keywords.

• partial.args

• The leftmost positional arguments that will be prepended to the positionalarguments provided to a partial object call.

• partial.keywords

• The keyword arguments that will be supplied when the partial object iscalled.

partial objects are like function objects in that they arecallable, weak referencable, and can have attributes. There are some importantdifferences. For instance, the name and doc attributesare not created automatically. Also, partial objects defined inclasses behave like static methods and do not transform into bound methodsduring instance attribute look-up.