blob: 9845df224df4f2c7e4550f3a0b0c5d805036d138 [file] [log] [blame]
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001"""functools.py - Tools for working with functions and callable objects
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002"""
3# Python module wrapper for _functools C module
4# to allow utilities written in Python to be added
5# to the functools module.
Łukasz Langa6f692512013-06-05 12:20:24 +02006# Written by Nick Coghlan <ncoghlan at gmail.com>,
7# Raymond Hettinger <python at rcn.com>,
8# and Łukasz Langa <lukasz at langa.pl>.
9# Copyright (C) 2006-2013 Python Software Foundation.
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000010# See C source code for _functools credits/copyright
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000011
Georg Brandl2e7346a2010-07-31 18:09:23 +000012__all__ = ['update_wrapper', 'wraps', 'WRAPPER_ASSIGNMENTS', 'WRAPPER_UPDATES',
Łukasz Langa6f692512013-06-05 12:20:24 +020013 'total_ordering', 'cmp_to_key', 'lru_cache', 'reduce', 'partial',
Nick Coghlan3daaf5f2013-11-04 23:32:16 +100014 'partialmethod', 'singledispatch']
Georg Brandl2e7346a2010-07-31 18:09:23 +000015
Antoine Pitroub5b37142012-11-13 21:35:40 +010016try:
17 from _functools import reduce
Brett Cannoncd171c82013-07-04 17:43:24 -040018except ImportError:
Antoine Pitroub5b37142012-11-13 21:35:40 +010019 pass
Łukasz Langa6f692512013-06-05 12:20:24 +020020from abc import get_cache_token
Raymond Hettingerec0e9102012-03-16 01:16:31 -070021from collections import namedtuple
Victor Stinner7fa767e2014-03-20 09:16:38 +010022from types import MappingProxyType
Łukasz Langa6f692512013-06-05 12:20:24 +020023from weakref import WeakKeyDictionary
Nick Coghlan457fc9a2016-09-10 20:00:02 +100024from reprlib import recursive_repr
Raymond Hettingercbe88132010-08-14 22:22:10 +000025try:
Raymond Hettingerfd541172013-03-01 03:47:57 -080026 from _thread import RLock
Serhiy Storchakaba9ac5b2015-05-20 10:33:40 +030027except ImportError:
Raymond Hettinger409f6632013-03-01 23:20:13 -080028 class RLock:
Raymond Hettingerf96b2b02013-03-08 21:11:55 -070029 'Dummy reentrant lock for builds without threads'
Raymond Hettinger409f6632013-03-01 23:20:13 -080030 def __enter__(self): pass
31 def __exit__(self, exctype, excinst, exctb): pass
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000032
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -070033
34################################################################################
35### update_wrapper() and wraps() decorator
36################################################################################
37
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000038# update_wrapper() and wraps() are tools to help write
39# wrapper functions that can handle naive introspection
40
Meador Ingeff7f64c2011-12-11 22:37:31 -060041WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
42 '__annotations__')
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000043WRAPPER_UPDATES = ('__dict__',)
44def update_wrapper(wrapper,
45 wrapped,
46 assigned = WRAPPER_ASSIGNMENTS,
47 updated = WRAPPER_UPDATES):
48 """Update a wrapper function to look like the wrapped function
49
50 wrapper is the function to be updated
51 wrapped is the original function
52 assigned is a tuple naming the attributes assigned directly
53 from the wrapped function to the wrapper function (defaults to
54 functools.WRAPPER_ASSIGNMENTS)
Thomas Wouters89f507f2006-12-13 04:49:30 +000055 updated is a tuple naming the attributes of the wrapper that
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000056 are updated with the corresponding attribute from the wrapped
57 function (defaults to functools.WRAPPER_UPDATES)
58 """
59 for attr in assigned:
Nick Coghlan98876832010-08-17 06:17:18 +000060 try:
61 value = getattr(wrapped, attr)
62 except AttributeError:
63 pass
64 else:
65 setattr(wrapper, attr, value)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000066 for attr in updated:
Thomas Wouters89f507f2006-12-13 04:49:30 +000067 getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
Nick Coghlan24c05bc2013-07-15 21:13:08 +100068 # Issue #17482: set __wrapped__ last so we don't inadvertently copy it
69 # from the wrapped function when updating __dict__
70 wrapper.__wrapped__ = wrapped
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000071 # Return the wrapper so this can be used as a decorator via partial()
72 return wrapper
73
74def wraps(wrapped,
75 assigned = WRAPPER_ASSIGNMENTS,
76 updated = WRAPPER_UPDATES):
77 """Decorator factory to apply update_wrapper() to a wrapper function
78
79 Returns a decorator that invokes update_wrapper() with the decorated
80 function as the wrapper argument and the arguments to wraps() as the
81 remaining arguments. Default arguments are as for update_wrapper().
82 This is a convenience function to simplify applying partial() to
83 update_wrapper().
84 """
85 return partial(update_wrapper, wrapped=wrapped,
86 assigned=assigned, updated=updated)
Raymond Hettingerc50846a2010-04-05 18:56:31 +000087
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -070088
89################################################################################
90### total_ordering class decorator
91################################################################################
92
Raymond Hettinger0603d302015-01-05 21:52:10 -080093# The total ordering functions all invoke the root magic method directly
94# rather than using the corresponding operator. This avoids possible
95# infinite recursion that could occur when the operator dispatch logic
96# detects a NotImplemented result and then calls a reflected method.
Nick Coghlanf05d9812013-10-02 00:02:03 +100097
Raymond Hettingerffcd8492015-05-12 21:26:37 -070098def _gt_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -080099 'Return a > b. Computed by @total_ordering from (not a < b) and (a != b).'
100 op_result = self.__lt__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +1000101 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800102 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +1000103 return not op_result and self != other
104
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700105def _le_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800106 'Return a <= b. Computed by @total_ordering from (a < b) or (a == b).'
107 op_result = self.__lt__(other)
108 return op_result or self == other
109
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700110def _ge_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800111 'Return a >= b. Computed by @total_ordering from (not a < b).'
112 op_result = self.__lt__(other)
113 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800114 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800115 return not op_result
116
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700117def _ge_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800118 'Return a >= b. Computed by @total_ordering from (not a <= b) or (a == b).'
119 op_result = self.__le__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +1000120 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800121 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +1000122 return not op_result or self == other
123
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700124def _lt_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800125 'Return a < b. Computed by @total_ordering from (a <= b) and (a != b).'
126 op_result = self.__le__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +1000127 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800128 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +1000129 return op_result and self != other
130
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700131def _gt_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800132 'Return a > b. Computed by @total_ordering from (not a <= b).'
133 op_result = self.__le__(other)
134 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800135 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800136 return not op_result
137
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700138def _lt_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800139 'Return a < b. Computed by @total_ordering from (not a > b) and (a != b).'
140 op_result = self.__gt__(other)
141 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800142 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800143 return not op_result and self != other
144
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700145def _ge_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800146 'Return a >= b. Computed by @total_ordering from (a > b) or (a == b).'
147 op_result = self.__gt__(other)
148 return op_result or self == other
149
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700150def _le_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800151 'Return a <= b. Computed by @total_ordering from (not a > b).'
152 op_result = self.__gt__(other)
153 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800154 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800155 return not op_result
156
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700157def _le_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800158 'Return a <= b. Computed by @total_ordering from (not a >= b) or (a == b).'
159 op_result = self.__ge__(other)
160 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800161 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800162 return not op_result or self == other
163
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700164def _gt_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800165 'Return a > b. Computed by @total_ordering from (a >= b) and (a != b).'
166 op_result = self.__ge__(other)
167 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800168 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800169 return op_result and self != other
170
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700171def _lt_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800172 'Return a < b. Computed by @total_ordering from (not a >= b).'
173 op_result = self.__ge__(other)
174 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800175 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800176 return not op_result
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000177
Raymond Hettinger1a8ada82015-01-13 22:57:35 -0800178_convert = {
179 '__lt__': [('__gt__', _gt_from_lt),
180 ('__le__', _le_from_lt),
181 ('__ge__', _ge_from_lt)],
182 '__le__': [('__ge__', _ge_from_le),
183 ('__lt__', _lt_from_le),
184 ('__gt__', _gt_from_le)],
185 '__gt__': [('__lt__', _lt_from_gt),
186 ('__ge__', _ge_from_gt),
187 ('__le__', _le_from_gt)],
188 '__ge__': [('__le__', _le_from_ge),
189 ('__gt__', _gt_from_ge),
190 ('__lt__', _lt_from_ge)]
191}
192
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000193def total_ordering(cls):
Georg Brandle5a26732010-05-19 21:06:36 +0000194 """Class decorator that fills in missing ordering methods"""
Raymond Hettinger3255c632010-09-16 00:31:21 +0000195 # Find user-defined comparisons (not those inherited from object).
Raymond Hettinger1a8ada82015-01-13 22:57:35 -0800196 roots = [op for op in _convert if getattr(cls, op, None) is not getattr(object, op, None)]
Raymond Hettinger56de7e22010-04-10 16:59:03 +0000197 if not roots:
198 raise ValueError('must define at least one ordering operation: < > <= >=')
199 root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__
Raymond Hettinger1a8ada82015-01-13 22:57:35 -0800200 for opname, opfunc in _convert[root]:
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000201 if opname not in roots:
202 opfunc.__name__ = opname
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000203 setattr(cls, opname, opfunc)
204 return cls
205
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700206
207################################################################################
208### cmp_to_key() function converter
209################################################################################
210
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000211def cmp_to_key(mycmp):
Georg Brandle5a26732010-05-19 21:06:36 +0000212 """Convert a cmp= function into a key= function"""
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000213 class K(object):
Raymond Hettingera0d1d962011-03-21 17:50:28 -0700214 __slots__ = ['obj']
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700215 def __init__(self, obj):
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000216 self.obj = obj
217 def __lt__(self, other):
218 return mycmp(self.obj, other.obj) < 0
219 def __gt__(self, other):
220 return mycmp(self.obj, other.obj) > 0
221 def __eq__(self, other):
222 return mycmp(self.obj, other.obj) == 0
223 def __le__(self, other):
224 return mycmp(self.obj, other.obj) <= 0
225 def __ge__(self, other):
226 return mycmp(self.obj, other.obj) >= 0
Raymond Hettinger003be522011-05-03 11:01:32 -0700227 __hash__ = None
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000228 return K
Georg Brandl2e7346a2010-07-31 18:09:23 +0000229
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700230try:
231 from _functools import cmp_to_key
Brett Cannoncd171c82013-07-04 17:43:24 -0400232except ImportError:
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700233 pass
234
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700235
236################################################################################
Antoine Pitroub5b37142012-11-13 21:35:40 +0100237### partial() argument application
238################################################################################
239
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000240# Purely functional, no descriptor behaviour
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000241class partial:
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000242 """New function with partial application of the given arguments
Antoine Pitroub5b37142012-11-13 21:35:40 +0100243 and keywords.
244 """
Alexander Belopolskye49af342015-03-01 15:08:17 -0500245
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000246 __slots__ = "func", "args", "keywords", "__dict__", "__weakref__"
247
248 def __new__(*args, **keywords):
249 if not args:
250 raise TypeError("descriptor '__new__' of partial needs an argument")
251 if len(args) < 2:
252 raise TypeError("type 'partial' takes at least one argument")
253 cls, func, *args = args
254 if not callable(func):
255 raise TypeError("the first argument must be callable")
256 args = tuple(args)
257
258 if hasattr(func, "func"):
259 args = func.args + args
260 tmpkw = func.keywords.copy()
261 tmpkw.update(keywords)
262 keywords = tmpkw
263 del tmpkw
264 func = func.func
265
266 self = super(partial, cls).__new__(cls)
267
268 self.func = func
269 self.args = args
270 self.keywords = keywords
271 return self
272
273 def __call__(*args, **keywords):
274 if not args:
275 raise TypeError("descriptor '__call__' of partial needs an argument")
276 self, *args = args
277 newkeywords = self.keywords.copy()
278 newkeywords.update(keywords)
279 return self.func(*self.args, *args, **newkeywords)
280
281 @recursive_repr()
282 def __repr__(self):
283 qualname = type(self).__qualname__
284 args = [repr(self.func)]
285 args.extend(repr(x) for x in self.args)
286 args.extend(f"{k}={v!r}" for (k, v) in self.keywords.items())
287 if type(self).__module__ == "functools":
288 return f"functools.{qualname}({', '.join(args)})"
289 return f"{qualname}({', '.join(args)})"
290
291 def __reduce__(self):
292 return type(self), (self.func,), (self.func, self.args,
293 self.keywords or None, self.__dict__ or None)
294
295 def __setstate__(self, state):
296 if not isinstance(state, tuple):
297 raise TypeError("argument to __setstate__ must be a tuple")
298 if len(state) != 4:
299 raise TypeError(f"expected 4 items in state, got {len(state)}")
300 func, args, kwds, namespace = state
301 if (not callable(func) or not isinstance(args, tuple) or
302 (kwds is not None and not isinstance(kwds, dict)) or
303 (namespace is not None and not isinstance(namespace, dict))):
304 raise TypeError("invalid partial state")
305
306 args = tuple(args) # just in case it's a subclass
307 if kwds is None:
308 kwds = {}
309 elif type(kwds) is not dict: # XXX does it need to be *exactly* dict?
310 kwds = dict(kwds)
311 if namespace is None:
312 namespace = {}
313
314 self.__dict__ = namespace
315 self.func = func
316 self.args = args
317 self.keywords = kwds
Antoine Pitroub5b37142012-11-13 21:35:40 +0100318
319try:
320 from _functools import partial
Brett Cannoncd171c82013-07-04 17:43:24 -0400321except ImportError:
Antoine Pitroub5b37142012-11-13 21:35:40 +0100322 pass
323
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000324# Descriptor version
325class partialmethod(object):
326 """Method descriptor with partial application of the given arguments
327 and keywords.
328
329 Supports wrapping existing descriptors and handles non-descriptor
330 callables as instance methods.
331 """
332
333 def __init__(self, func, *args, **keywords):
334 if not callable(func) and not hasattr(func, "__get__"):
335 raise TypeError("{!r} is not callable or a descriptor"
336 .format(func))
337
338 # func could be a descriptor like classmethod which isn't callable,
339 # so we can't inherit from partial (it verifies func is callable)
340 if isinstance(func, partialmethod):
341 # flattening is mandatory in order to place cls/self before all
342 # other arguments
343 # it's also more efficient since only one function will be called
344 self.func = func.func
345 self.args = func.args + args
346 self.keywords = func.keywords.copy()
347 self.keywords.update(keywords)
348 else:
349 self.func = func
350 self.args = args
351 self.keywords = keywords
352
353 def __repr__(self):
354 args = ", ".join(map(repr, self.args))
355 keywords = ", ".join("{}={!r}".format(k, v)
356 for k, v in self.keywords.items())
357 format_string = "{module}.{cls}({func}, {args}, {keywords})"
358 return format_string.format(module=self.__class__.__module__,
Serhiy Storchaka521e5862014-07-22 15:00:37 +0300359 cls=self.__class__.__qualname__,
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000360 func=self.func,
361 args=args,
362 keywords=keywords)
363
364 def _make_unbound_method(self):
365 def _method(*args, **keywords):
366 call_keywords = self.keywords.copy()
367 call_keywords.update(keywords)
368 cls_or_self, *rest = args
369 call_args = (cls_or_self,) + self.args + tuple(rest)
370 return self.func(*call_args, **call_keywords)
371 _method.__isabstractmethod__ = self.__isabstractmethod__
Yury Selivanovda5fe4f2014-01-27 17:28:37 -0500372 _method._partialmethod = self
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000373 return _method
374
375 def __get__(self, obj, cls):
376 get = getattr(self.func, "__get__", None)
377 result = None
378 if get is not None:
379 new_func = get(obj, cls)
380 if new_func is not self.func:
381 # Assume __get__ returning something new indicates the
382 # creation of an appropriate callable
383 result = partial(new_func, *self.args, **self.keywords)
384 try:
385 result.__self__ = new_func.__self__
386 except AttributeError:
387 pass
388 if result is None:
389 # If the underlying descriptor didn't do anything, treat this
390 # like an instance method
391 result = self._make_unbound_method().__get__(obj, cls)
392 return result
393
394 @property
395 def __isabstractmethod__(self):
396 return getattr(self.func, "__isabstractmethod__", False)
397
Antoine Pitroub5b37142012-11-13 21:35:40 +0100398
399################################################################################
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700400### LRU Cache function decorator
401################################################################################
402
Raymond Hettingerdce583e2012-03-16 22:12:20 -0700403_CacheInfo = namedtuple("CacheInfo", ["hits", "misses", "maxsize", "currsize"])
Nick Coghlan234515a2010-11-30 06:19:46 +0000404
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700405class _HashedSeq(list):
Raymond Hettingerf96b2b02013-03-08 21:11:55 -0700406 """ This class guarantees that hash() will be called no more than once
407 per element. This is important because the lru_cache() will hash
408 the key multiple times on a cache miss.
409
410 """
411
Raymond Hettinger9acbb602012-04-30 22:32:16 -0700412 __slots__ = 'hashvalue'
413
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700414 def __init__(self, tup, hash=hash):
415 self[:] = tup
416 self.hashvalue = hash(tup)
Raymond Hettinger9acbb602012-04-30 22:32:16 -0700417
418 def __hash__(self):
419 return self.hashvalue
420
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700421def _make_key(args, kwds, typed,
422 kwd_mark = (object(),),
423 fasttypes = {int, str, frozenset, type(None)},
424 sorted=sorted, tuple=tuple, type=type, len=len):
Raymond Hettingerf96b2b02013-03-08 21:11:55 -0700425 """Make a cache key from optionally typed positional and keyword arguments
426
427 The key is constructed in a way that is flat as possible rather than
428 as a nested structure that would take more memory.
429
430 If there is only a single argument and its data type is known to cache
431 its hash value, then that argument is returned without a wrapper. This
432 saves space and improves lookup speed.
433
434 """
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700435 key = args
436 if kwds:
437 sorted_items = sorted(kwds.items())
438 key += kwd_mark
439 for item in sorted_items:
440 key += item
441 if typed:
442 key += tuple(type(v) for v in args)
443 if kwds:
444 key += tuple(type(v) for k, v in sorted_items)
445 elif len(key) == 1 and type(key[0]) in fasttypes:
446 return key[0]
447 return _HashedSeq(key)
448
Raymond Hettinger010ce322012-05-19 21:20:48 -0700449def lru_cache(maxsize=128, typed=False):
Benjamin Peterson1f594ad2010-08-08 13:17:07 +0000450 """Least-recently-used cache decorator.
Georg Brandl2e7346a2010-07-31 18:09:23 +0000451
Raymond Hettingerc79fb0e2010-12-01 03:45:41 +0000452 If *maxsize* is set to None, the LRU features are disabled and the cache
453 can grow without bound.
454
Raymond Hettingercd9fdfd2011-10-20 08:57:45 -0700455 If *typed* is True, arguments of different types will be cached separately.
456 For example, f(3.0) and f(3) will be treated as distinct calls with
457 distinct results.
458
Georg Brandl2e7346a2010-07-31 18:09:23 +0000459 Arguments to the cached function must be hashable.
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000460
Raymond Hettinger7f7a5a72012-03-30 21:50:40 -0700461 View the cache statistics named tuple (hits, misses, maxsize, currsize)
462 with f.cache_info(). Clear the cache and statistics with f.cache_clear().
Raymond Hettinger00f2f972010-12-01 00:47:56 +0000463 Access the underlying function with f.__wrapped__.
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000464
465 See: http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used
Georg Brandl2e7346a2010-07-31 18:09:23 +0000466
Benjamin Peterson1f594ad2010-08-08 13:17:07 +0000467 """
Raymond Hettinger1ff50df2012-03-30 13:15:48 -0700468
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000469 # Users should only access the lru_cache through its public API:
Raymond Hettinger5e20bab2010-11-30 07:13:04 +0000470 # cache_info, cache_clear, and f.__wrapped__
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000471 # The internals of the lru_cache are encapsulated for thread safety and
472 # to allow the implementation to change (including a possible C version).
473
Raymond Hettinger4d588972014-08-12 12:44:52 -0700474 # Early detection of an erroneous call to @lru_cache without any arguments
475 # resulting in the inner function being passed to maxsize instead of an
476 # integer or None.
477 if maxsize is not None and not isinstance(maxsize, int):
478 raise TypeError('Expected maxsize to be an integer or None')
479
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300480 def decorating_function(user_function):
481 wrapper = _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo)
482 return update_wrapper(wrapper, user_function)
483
484 return decorating_function
485
486def _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo):
Raymond Hettinger9f0ab9f2012-04-29 14:55:27 -0700487 # Constants shared by all lru cache instances:
Raymond Hettingerb6b98c02012-04-29 18:09:02 -0700488 sentinel = object() # unique object used to signal cache misses
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700489 make_key = _make_key # build a key from the function arguments
Raymond Hettinger9f0ab9f2012-04-29 14:55:27 -0700490 PREV, NEXT, KEY, RESULT = 0, 1, 2, 3 # names for the link fields
491
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300492 cache = {}
493 hits = misses = 0
494 full = False
495 cache_get = cache.get # bound method to lookup a key or return None
496 lock = RLock() # because linkedlist updates aren't threadsafe
497 root = [] # root of the circular doubly linked list
498 root[:] = [root, root, None, None] # initialize by pointing to self
Raymond Hettinger6e8c8172012-03-16 16:53:05 -0700499
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300500 if maxsize == 0:
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700501
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300502 def wrapper(*args, **kwds):
503 # No caching -- just a statistics update after a successful call
504 nonlocal misses
505 result = user_function(*args, **kwds)
506 misses += 1
507 return result
508
509 elif maxsize is None:
510
511 def wrapper(*args, **kwds):
512 # Simple caching without ordering or size limit
513 nonlocal hits, misses
514 key = make_key(args, kwds, typed)
515 result = cache_get(key, sentinel)
516 if result is not sentinel:
517 hits += 1
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700518 return result
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300519 result = user_function(*args, **kwds)
520 cache[key] = result
521 misses += 1
522 return result
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700523
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300524 else:
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700525
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300526 def wrapper(*args, **kwds):
527 # Size limited caching that tracks accesses by recency
528 nonlocal root, hits, misses, full
529 key = make_key(args, kwds, typed)
530 with lock:
531 link = cache_get(key)
532 if link is not None:
533 # Move the link to the front of the circular queue
534 link_prev, link_next, _key, result = link
535 link_prev[NEXT] = link_next
536 link_next[PREV] = link_prev
537 last = root[PREV]
538 last[NEXT] = root[PREV] = link
539 link[PREV] = last
540 link[NEXT] = root
Nick Coghlan234515a2010-11-30 06:19:46 +0000541 hits += 1
Raymond Hettinger4b779b32011-10-15 23:50:42 -0700542 return result
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300543 result = user_function(*args, **kwds)
544 with lock:
545 if key in cache:
546 # Getting here means that this same key was added to the
547 # cache while the lock was released. Since the link
548 # update is already done, we need only return the
549 # computed result and update the count of misses.
550 pass
551 elif full:
552 # Use the old root to store the new key and result.
553 oldroot = root
554 oldroot[KEY] = key
555 oldroot[RESULT] = result
556 # Empty the oldest link and make it the new root.
557 # Keep a reference to the old key and old result to
558 # prevent their ref counts from going to zero during the
559 # update. That will prevent potentially arbitrary object
560 # clean-up code (i.e. __del__) from running while we're
561 # still adjusting the links.
562 root = oldroot[NEXT]
563 oldkey = root[KEY]
564 oldresult = root[RESULT]
565 root[KEY] = root[RESULT] = None
566 # Now update the cache dictionary.
567 del cache[oldkey]
568 # Save the potentially reentrant cache[key] assignment
569 # for last, after the root and links have been put in
570 # a consistent state.
571 cache[key] = oldroot
572 else:
573 # Put result in a new link at the front of the queue.
574 last = root[PREV]
575 link = [last, root, key, result]
576 last[NEXT] = root[PREV] = cache[key] = link
577 full = (len(cache) >= maxsize)
Raymond Hettinger4b779b32011-10-15 23:50:42 -0700578 misses += 1
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300579 return result
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700580
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300581 def cache_info():
582 """Report cache statistics"""
583 with lock:
584 return _CacheInfo(hits, misses, maxsize, len(cache))
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700585
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300586 def cache_clear():
587 """Clear the cache and cache statistics"""
588 nonlocal hits, misses, full
589 with lock:
590 cache.clear()
591 root[:] = [root, root, None, None]
592 hits = misses = 0
593 full = False
Georg Brandl2e7346a2010-07-31 18:09:23 +0000594
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300595 wrapper.cache_info = cache_info
596 wrapper.cache_clear = cache_clear
Serhiy Storchakace2295d2015-10-24 09:51:53 +0300597 return wrapper
Nick Coghlan234515a2010-11-30 06:19:46 +0000598
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300599try:
600 from _functools import _lru_cache_wrapper
601except ImportError:
602 pass
Łukasz Langa6f692512013-06-05 12:20:24 +0200603
604
605################################################################################
606### singledispatch() - single-dispatch generic function decorator
607################################################################################
608
Łukasz Langa3720c772013-07-01 16:00:38 +0200609def _c3_merge(sequences):
610 """Merges MROs in *sequences* to a single MRO using the C3 algorithm.
611
612 Adapted from http://www.python.org/download/releases/2.3/mro/.
613
614 """
615 result = []
616 while True:
617 sequences = [s for s in sequences if s] # purge empty sequences
618 if not sequences:
619 return result
620 for s1 in sequences: # find merge candidates among seq heads
621 candidate = s1[0]
622 for s2 in sequences:
623 if candidate in s2[1:]:
624 candidate = None
625 break # reject the current head, it appears later
626 else:
627 break
Yury Selivanov77a8cd62015-08-18 14:20:00 -0400628 if candidate is None:
Łukasz Langa3720c772013-07-01 16:00:38 +0200629 raise RuntimeError("Inconsistent hierarchy")
630 result.append(candidate)
631 # remove the chosen candidate
632 for seq in sequences:
633 if seq[0] == candidate:
634 del seq[0]
635
636def _c3_mro(cls, abcs=None):
637 """Computes the method resolution order using extended C3 linearization.
638
639 If no *abcs* are given, the algorithm works exactly like the built-in C3
640 linearization used for method resolution.
641
642 If given, *abcs* is a list of abstract base classes that should be inserted
643 into the resulting MRO. Unrelated ABCs are ignored and don't end up in the
644 result. The algorithm inserts ABCs where their functionality is introduced,
645 i.e. issubclass(cls, abc) returns True for the class itself but returns
646 False for all its direct base classes. Implicit ABCs for a given class
647 (either registered or inferred from the presence of a special method like
648 __len__) are inserted directly after the last ABC explicitly listed in the
649 MRO of said class. If two implicit ABCs end up next to each other in the
650 resulting MRO, their ordering depends on the order of types in *abcs*.
651
652 """
653 for i, base in enumerate(reversed(cls.__bases__)):
654 if hasattr(base, '__abstractmethods__'):
655 boundary = len(cls.__bases__) - i
656 break # Bases up to the last explicit ABC are considered first.
657 else:
658 boundary = 0
659 abcs = list(abcs) if abcs else []
660 explicit_bases = list(cls.__bases__[:boundary])
661 abstract_bases = []
662 other_bases = list(cls.__bases__[boundary:])
663 for base in abcs:
664 if issubclass(cls, base) and not any(
665 issubclass(b, base) for b in cls.__bases__
666 ):
667 # If *cls* is the class that introduces behaviour described by
668 # an ABC *base*, insert said ABC to its MRO.
669 abstract_bases.append(base)
670 for base in abstract_bases:
671 abcs.remove(base)
672 explicit_c3_mros = [_c3_mro(base, abcs=abcs) for base in explicit_bases]
673 abstract_c3_mros = [_c3_mro(base, abcs=abcs) for base in abstract_bases]
674 other_c3_mros = [_c3_mro(base, abcs=abcs) for base in other_bases]
675 return _c3_merge(
676 [[cls]] +
677 explicit_c3_mros + abstract_c3_mros + other_c3_mros +
678 [explicit_bases] + [abstract_bases] + [other_bases]
679 )
680
681def _compose_mro(cls, types):
682 """Calculates the method resolution order for a given class *cls*.
683
684 Includes relevant abstract base classes (with their respective bases) from
685 the *types* iterable. Uses a modified C3 linearization algorithm.
Łukasz Langa6f692512013-06-05 12:20:24 +0200686
687 """
688 bases = set(cls.__mro__)
Łukasz Langa3720c772013-07-01 16:00:38 +0200689 # Remove entries which are already present in the __mro__ or unrelated.
690 def is_related(typ):
691 return (typ not in bases and hasattr(typ, '__mro__')
692 and issubclass(cls, typ))
693 types = [n for n in types if is_related(n)]
694 # Remove entries which are strict bases of other entries (they will end up
695 # in the MRO anyway.
696 def is_strict_base(typ):
697 for other in types:
698 if typ != other and typ in other.__mro__:
699 return True
700 return False
701 types = [n for n in types if not is_strict_base(n)]
702 # Subclasses of the ABCs in *types* which are also implemented by
703 # *cls* can be used to stabilize ABC ordering.
704 type_set = set(types)
705 mro = []
706 for typ in types:
707 found = []
708 for sub in typ.__subclasses__():
709 if sub not in bases and issubclass(cls, sub):
710 found.append([s for s in sub.__mro__ if s in type_set])
711 if not found:
712 mro.append(typ)
713 continue
714 # Favor subclasses with the biggest number of useful bases
715 found.sort(key=len, reverse=True)
716 for sub in found:
717 for subcls in sub:
718 if subcls not in mro:
719 mro.append(subcls)
720 return _c3_mro(cls, abcs=mro)
Łukasz Langa6f692512013-06-05 12:20:24 +0200721
722def _find_impl(cls, registry):
Łukasz Langa3720c772013-07-01 16:00:38 +0200723 """Returns the best matching implementation from *registry* for type *cls*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200724
Łukasz Langa3720c772013-07-01 16:00:38 +0200725 Where there is no registered implementation for a specific type, its method
726 resolution order is used to find a more generic implementation.
727
728 Note: if *registry* does not contain an implementation for the base
729 *object* type, this function may return None.
Łukasz Langa6f692512013-06-05 12:20:24 +0200730
731 """
732 mro = _compose_mro(cls, registry.keys())
733 match = None
734 for t in mro:
735 if match is not None:
Łukasz Langa3720c772013-07-01 16:00:38 +0200736 # If *match* is an implicit ABC but there is another unrelated,
737 # equally matching implicit ABC, refuse the temptation to guess.
738 if (t in registry and t not in cls.__mro__
739 and match not in cls.__mro__
740 and not issubclass(match, t)):
Łukasz Langa6f692512013-06-05 12:20:24 +0200741 raise RuntimeError("Ambiguous dispatch: {} or {}".format(
742 match, t))
743 break
744 if t in registry:
745 match = t
746 return registry.get(match)
747
748def singledispatch(func):
749 """Single-dispatch generic function decorator.
750
751 Transforms a function into a generic function, which can have different
752 behaviours depending upon the type of its first argument. The decorated
753 function acts as the default implementation, and additional
Łukasz Langa3720c772013-07-01 16:00:38 +0200754 implementations can be registered using the register() attribute of the
755 generic function.
Łukasz Langa6f692512013-06-05 12:20:24 +0200756
757 """
758 registry = {}
759 dispatch_cache = WeakKeyDictionary()
760 cache_token = None
761
Łukasz Langa3720c772013-07-01 16:00:38 +0200762 def dispatch(cls):
763 """generic_func.dispatch(cls) -> <function implementation>
Łukasz Langa6f692512013-06-05 12:20:24 +0200764
765 Runs the dispatch algorithm to return the best available implementation
Łukasz Langa3720c772013-07-01 16:00:38 +0200766 for the given *cls* registered on *generic_func*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200767
768 """
769 nonlocal cache_token
770 if cache_token is not None:
771 current_token = get_cache_token()
772 if cache_token != current_token:
773 dispatch_cache.clear()
774 cache_token = current_token
775 try:
Łukasz Langa3720c772013-07-01 16:00:38 +0200776 impl = dispatch_cache[cls]
Łukasz Langa6f692512013-06-05 12:20:24 +0200777 except KeyError:
778 try:
Łukasz Langa3720c772013-07-01 16:00:38 +0200779 impl = registry[cls]
Łukasz Langa6f692512013-06-05 12:20:24 +0200780 except KeyError:
Łukasz Langa3720c772013-07-01 16:00:38 +0200781 impl = _find_impl(cls, registry)
782 dispatch_cache[cls] = impl
Łukasz Langa6f692512013-06-05 12:20:24 +0200783 return impl
784
Łukasz Langa3720c772013-07-01 16:00:38 +0200785 def register(cls, func=None):
786 """generic_func.register(cls, func) -> func
Łukasz Langa6f692512013-06-05 12:20:24 +0200787
Łukasz Langa3720c772013-07-01 16:00:38 +0200788 Registers a new implementation for the given *cls* on a *generic_func*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200789
790 """
791 nonlocal cache_token
792 if func is None:
Łukasz Langa3720c772013-07-01 16:00:38 +0200793 return lambda f: register(cls, f)
794 registry[cls] = func
795 if cache_token is None and hasattr(cls, '__abstractmethods__'):
Łukasz Langa6f692512013-06-05 12:20:24 +0200796 cache_token = get_cache_token()
797 dispatch_cache.clear()
798 return func
799
800 def wrapper(*args, **kw):
801 return dispatch(args[0].__class__)(*args, **kw)
802
803 registry[object] = func
804 wrapper.register = register
805 wrapper.dispatch = dispatch
806 wrapper.registry = MappingProxyType(registry)
807 wrapper._clear_cache = dispatch_cache.clear
808 update_wrapper(wrapper, func)
809 return wrapper