mirror of
https://github.com/python/cpython.git
synced 2024-12-22 08:14:22 +08:00
229 lines
9.1 KiB
Python
229 lines
9.1 KiB
Python
"""functools.py - Tools for working with functions and callable objects
|
|
"""
|
|
# Python module wrapper for _functools C module
|
|
# to allow utilities written in Python to be added
|
|
# to the functools module.
|
|
# Written by Nick Coghlan <ncoghlan at gmail.com>
|
|
# and Raymond Hettinger <python at rcn.com>
|
|
# Copyright (C) 2006-2010 Python Software Foundation.
|
|
# See C source code for _functools credits/copyright
|
|
|
|
__all__ = ['update_wrapper', 'wraps', 'WRAPPER_ASSIGNMENTS', 'WRAPPER_UPDATES',
|
|
'total_ordering', 'cmp_to_key', 'lru_cache', 'reduce', 'partial']
|
|
|
|
from _functools import partial, reduce
|
|
from collections import OrderedDict, namedtuple
|
|
try:
|
|
from _thread import allocate_lock as Lock
|
|
except:
|
|
from _dummy_thread import allocate_lock as Lock
|
|
|
|
# update_wrapper() and wraps() are tools to help write
|
|
# wrapper functions that can handle naive introspection
|
|
|
|
WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
|
|
'__annotations__')
|
|
WRAPPER_UPDATES = ('__dict__',)
|
|
def update_wrapper(wrapper,
|
|
wrapped,
|
|
assigned = WRAPPER_ASSIGNMENTS,
|
|
updated = WRAPPER_UPDATES):
|
|
"""Update a wrapper function to look like the wrapped function
|
|
|
|
wrapper is the function to be updated
|
|
wrapped is the original function
|
|
assigned is a tuple naming the attributes assigned directly
|
|
from the wrapped function to the wrapper function (defaults to
|
|
functools.WRAPPER_ASSIGNMENTS)
|
|
updated is a tuple naming the attributes of the wrapper that
|
|
are updated with the corresponding attribute from the wrapped
|
|
function (defaults to functools.WRAPPER_UPDATES)
|
|
"""
|
|
wrapper.__wrapped__ = wrapped
|
|
for attr in assigned:
|
|
try:
|
|
value = getattr(wrapped, attr)
|
|
except AttributeError:
|
|
pass
|
|
else:
|
|
setattr(wrapper, attr, value)
|
|
for attr in updated:
|
|
getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
|
|
# Return the wrapper so this can be used as a decorator via partial()
|
|
return wrapper
|
|
|
|
def wraps(wrapped,
|
|
assigned = WRAPPER_ASSIGNMENTS,
|
|
updated = WRAPPER_UPDATES):
|
|
"""Decorator factory to apply update_wrapper() to a wrapper function
|
|
|
|
Returns a decorator that invokes update_wrapper() with the decorated
|
|
function as the wrapper argument and the arguments to wraps() as the
|
|
remaining arguments. Default arguments are as for update_wrapper().
|
|
This is a convenience function to simplify applying partial() to
|
|
update_wrapper().
|
|
"""
|
|
return partial(update_wrapper, wrapped=wrapped,
|
|
assigned=assigned, updated=updated)
|
|
|
|
def total_ordering(cls):
|
|
"""Class decorator that fills in missing ordering methods"""
|
|
convert = {
|
|
'__lt__': [('__gt__', lambda self, other: not (self < other or self == other)),
|
|
('__le__', lambda self, other: self < other or self == other),
|
|
('__ge__', lambda self, other: not self < other)],
|
|
'__le__': [('__ge__', lambda self, other: not self <= other or self == other),
|
|
('__lt__', lambda self, other: self <= other and not self == other),
|
|
('__gt__', lambda self, other: not self <= other)],
|
|
'__gt__': [('__lt__', lambda self, other: not (self > other or self == other)),
|
|
('__ge__', lambda self, other: self > other or self == other),
|
|
('__le__', lambda self, other: not self > other)],
|
|
'__ge__': [('__le__', lambda self, other: (not self >= other) or self == other),
|
|
('__gt__', lambda self, other: self >= other and not self == other),
|
|
('__lt__', lambda self, other: not self >= other)]
|
|
}
|
|
# Find user-defined comparisons (not those inherited from object).
|
|
roots = [op for op in convert if getattr(cls, op, None) is not getattr(object, op, None)]
|
|
if not roots:
|
|
raise ValueError('must define at least one ordering operation: < > <= >=')
|
|
root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__
|
|
for opname, opfunc in convert[root]:
|
|
if opname not in roots:
|
|
opfunc.__name__ = opname
|
|
opfunc.__doc__ = getattr(int, opname).__doc__
|
|
setattr(cls, opname, opfunc)
|
|
return cls
|
|
|
|
def cmp_to_key(mycmp):
|
|
"""Convert a cmp= function into a key= function"""
|
|
class K(object):
|
|
__slots__ = ['obj']
|
|
def __init__(self, obj):
|
|
self.obj = obj
|
|
def __lt__(self, other):
|
|
return mycmp(self.obj, other.obj) < 0
|
|
def __gt__(self, other):
|
|
return mycmp(self.obj, other.obj) > 0
|
|
def __eq__(self, other):
|
|
return mycmp(self.obj, other.obj) == 0
|
|
def __le__(self, other):
|
|
return mycmp(self.obj, other.obj) <= 0
|
|
def __ge__(self, other):
|
|
return mycmp(self.obj, other.obj) >= 0
|
|
def __ne__(self, other):
|
|
return mycmp(self.obj, other.obj) != 0
|
|
__hash__ = None
|
|
return K
|
|
|
|
try:
|
|
from _functools import cmp_to_key
|
|
except ImportError:
|
|
pass
|
|
|
|
_CacheInfo = namedtuple("CacheInfo", "hits misses maxsize currsize")
|
|
|
|
def lru_cache(maxsize=100, typed=False):
|
|
"""Least-recently-used cache decorator.
|
|
|
|
If *maxsize* is set to None, the LRU features are disabled and the cache
|
|
can grow without bound.
|
|
|
|
If *typed* is True, arguments of different types will be cached separately.
|
|
For example, f(3.0) and f(3) will be treated as distinct calls with
|
|
distinct results.
|
|
|
|
Arguments to the cached function must be hashable.
|
|
|
|
View the cache statistics named tuple (hits, misses, maxsize, currsize) with
|
|
f.cache_info(). Clear the cache and statistics with f.cache_clear().
|
|
Access the underlying function with f.__wrapped__.
|
|
|
|
See: http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used
|
|
|
|
"""
|
|
# Users should only access the lru_cache through its public API:
|
|
# cache_info, cache_clear, and f.__wrapped__
|
|
# The internals of the lru_cache are encapsulated for thread safety and
|
|
# to allow the implementation to change (including a possible C version).
|
|
|
|
def decorating_function(user_function,
|
|
*, tuple=tuple, sorted=sorted, map=map, len=len, type=type, KeyError=KeyError):
|
|
|
|
hits = misses = 0
|
|
kwd_mark = (object(),) # separates positional and keyword args
|
|
lock = Lock() # needed because OrderedDict isn't threadsafe
|
|
|
|
if maxsize is None:
|
|
cache = dict() # simple cache without ordering or size limit
|
|
|
|
@wraps(user_function)
|
|
def wrapper(*args, **kwds):
|
|
nonlocal hits, misses
|
|
key = args
|
|
if kwds:
|
|
sorted_items = tuple(sorted(kwds.items()))
|
|
key += kwd_mark + sorted_items
|
|
if typed:
|
|
key += tuple(map(type, args))
|
|
if kwds:
|
|
key += tuple(type(v) for k, v in sorted_items)
|
|
try:
|
|
result = cache[key]
|
|
hits += 1
|
|
return result
|
|
except KeyError:
|
|
pass
|
|
result = user_function(*args, **kwds)
|
|
cache[key] = result
|
|
misses += 1
|
|
return result
|
|
else:
|
|
cache = OrderedDict() # ordered least recent to most recent
|
|
cache_popitem = cache.popitem
|
|
cache_renew = cache.move_to_end
|
|
|
|
@wraps(user_function)
|
|
def wrapper(*args, **kwds):
|
|
nonlocal hits, misses
|
|
key = args
|
|
if kwds:
|
|
sorted_items = tuple(sorted(kwds.items()))
|
|
key += kwd_mark + sorted_items
|
|
if typed:
|
|
key += tuple(map(type, args))
|
|
if kwds:
|
|
key += tuple(type(v) for k, v in sorted_items)
|
|
with lock:
|
|
try:
|
|
result = cache[key]
|
|
cache_renew(key) # record recent use of this key
|
|
hits += 1
|
|
return result
|
|
except KeyError:
|
|
pass
|
|
result = user_function(*args, **kwds)
|
|
with lock:
|
|
cache[key] = result # record recent use of this key
|
|
misses += 1
|
|
if len(cache) > maxsize:
|
|
cache_popitem(0) # purge least recently used cache entry
|
|
return result
|
|
|
|
def cache_info():
|
|
"""Report cache statistics"""
|
|
with lock:
|
|
return _CacheInfo(hits, misses, maxsize, len(cache))
|
|
|
|
def cache_clear():
|
|
"""Clear the cache and cache statistics"""
|
|
nonlocal hits, misses
|
|
with lock:
|
|
cache.clear()
|
|
hits = misses = 0
|
|
|
|
wrapper.cache_info = cache_info
|
|
wrapper.cache_clear = cache_clear
|
|
return wrapper
|
|
|
|
return decorating_function
|