blob: 1f1874db9b4cce510ca088bde86a5ae95bef0fce [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',
Ethan Smithc6512752018-05-26 16:38:33 -040014 'partialmethod', 'singledispatch', 'singledispatchmethod']
Georg Brandl2e7346a2010-07-31 18:09:23 +000015
Łukasz Langa6f692512013-06-05 12:20:24 +020016from abc import get_cache_token
Raymond Hettingerec0e9102012-03-16 01:16:31 -070017from collections import namedtuple
INADA Naoki9811e802017-09-30 16:13:02 +090018# import types, weakref # Deferred to single_dispatch()
Nick Coghlan457fc9a2016-09-10 20:00:02 +100019from reprlib import recursive_repr
Antoine Pitroua6a4dc82017-09-07 18:56:24 +020020from _thread import RLock
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000021
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -070022
23################################################################################
24### update_wrapper() and wraps() decorator
25################################################################################
26
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000027# update_wrapper() and wraps() are tools to help write
28# wrapper functions that can handle naive introspection
29
Meador Ingeff7f64c2011-12-11 22:37:31 -060030WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
31 '__annotations__')
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000032WRAPPER_UPDATES = ('__dict__',)
33def update_wrapper(wrapper,
34 wrapped,
35 assigned = WRAPPER_ASSIGNMENTS,
36 updated = WRAPPER_UPDATES):
37 """Update a wrapper function to look like the wrapped function
38
39 wrapper is the function to be updated
40 wrapped is the original function
41 assigned is a tuple naming the attributes assigned directly
42 from the wrapped function to the wrapper function (defaults to
43 functools.WRAPPER_ASSIGNMENTS)
Thomas Wouters89f507f2006-12-13 04:49:30 +000044 updated is a tuple naming the attributes of the wrapper that
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000045 are updated with the corresponding attribute from the wrapped
46 function (defaults to functools.WRAPPER_UPDATES)
47 """
48 for attr in assigned:
Nick Coghlan98876832010-08-17 06:17:18 +000049 try:
50 value = getattr(wrapped, attr)
51 except AttributeError:
52 pass
53 else:
54 setattr(wrapper, attr, value)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000055 for attr in updated:
Thomas Wouters89f507f2006-12-13 04:49:30 +000056 getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
Nick Coghlan24c05bc2013-07-15 21:13:08 +100057 # Issue #17482: set __wrapped__ last so we don't inadvertently copy it
58 # from the wrapped function when updating __dict__
59 wrapper.__wrapped__ = wrapped
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000060 # Return the wrapper so this can be used as a decorator via partial()
61 return wrapper
62
63def wraps(wrapped,
64 assigned = WRAPPER_ASSIGNMENTS,
65 updated = WRAPPER_UPDATES):
66 """Decorator factory to apply update_wrapper() to a wrapper function
67
68 Returns a decorator that invokes update_wrapper() with the decorated
69 function as the wrapper argument and the arguments to wraps() as the
70 remaining arguments. Default arguments are as for update_wrapper().
71 This is a convenience function to simplify applying partial() to
72 update_wrapper().
73 """
74 return partial(update_wrapper, wrapped=wrapped,
75 assigned=assigned, updated=updated)
Raymond Hettingerc50846a2010-04-05 18:56:31 +000076
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -070077
78################################################################################
79### total_ordering class decorator
80################################################################################
81
Raymond Hettinger0603d302015-01-05 21:52:10 -080082# The total ordering functions all invoke the root magic method directly
83# rather than using the corresponding operator. This avoids possible
84# infinite recursion that could occur when the operator dispatch logic
85# detects a NotImplemented result and then calls a reflected method.
Nick Coghlanf05d9812013-10-02 00:02:03 +100086
Raymond Hettingerffcd8492015-05-12 21:26:37 -070087def _gt_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -080088 'Return a > b. Computed by @total_ordering from (not a < b) and (a != b).'
89 op_result = self.__lt__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +100090 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -080091 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +100092 return not op_result and self != other
93
Raymond Hettingerffcd8492015-05-12 21:26:37 -070094def _le_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -080095 'Return a <= b. Computed by @total_ordering from (a < b) or (a == b).'
96 op_result = self.__lt__(other)
97 return op_result or self == other
98
Raymond Hettingerffcd8492015-05-12 21:26:37 -070099def _ge_from_lt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800100 'Return a >= b. Computed by @total_ordering from (not a < b).'
101 op_result = self.__lt__(other)
102 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800103 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800104 return not op_result
105
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700106def _ge_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800107 'Return a >= b. Computed by @total_ordering from (not a <= b) or (a == b).'
108 op_result = self.__le__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +1000109 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800110 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +1000111 return not op_result or self == other
112
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700113def _lt_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800114 'Return a < b. Computed by @total_ordering from (a <= b) and (a != b).'
115 op_result = self.__le__(other)
Nick Coghlanf05d9812013-10-02 00:02:03 +1000116 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800117 return op_result
Nick Coghlanf05d9812013-10-02 00:02:03 +1000118 return op_result and self != other
119
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700120def _gt_from_le(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800121 'Return a > b. Computed by @total_ordering from (not a <= b).'
122 op_result = self.__le__(other)
123 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800124 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800125 return not op_result
126
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700127def _lt_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800128 'Return a < b. Computed by @total_ordering from (not a > b) and (a != b).'
129 op_result = self.__gt__(other)
130 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800131 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800132 return not op_result and self != other
133
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700134def _ge_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800135 'Return a >= b. Computed by @total_ordering from (a > b) or (a == b).'
136 op_result = self.__gt__(other)
137 return op_result or self == other
138
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700139def _le_from_gt(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800140 'Return a <= b. Computed by @total_ordering from (not a > b).'
141 op_result = self.__gt__(other)
142 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800143 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800144 return not op_result
145
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700146def _le_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800147 'Return a <= b. Computed by @total_ordering from (not a >= b) or (a == b).'
148 op_result = self.__ge__(other)
149 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800150 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800151 return not op_result or self == other
152
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700153def _gt_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800154 'Return a > b. Computed by @total_ordering from (a >= b) and (a != b).'
155 op_result = self.__ge__(other)
156 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800157 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800158 return op_result and self != other
159
Raymond Hettingerffcd8492015-05-12 21:26:37 -0700160def _lt_from_ge(self, other, NotImplemented=NotImplemented):
Raymond Hettinger0603d302015-01-05 21:52:10 -0800161 'Return a < b. Computed by @total_ordering from (not a >= b).'
162 op_result = self.__ge__(other)
163 if op_result is NotImplemented:
Raymond Hettingere5db8632015-01-06 22:16:10 -0800164 return op_result
Raymond Hettinger0603d302015-01-05 21:52:10 -0800165 return not op_result
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000166
Raymond Hettinger1a8ada82015-01-13 22:57:35 -0800167_convert = {
168 '__lt__': [('__gt__', _gt_from_lt),
169 ('__le__', _le_from_lt),
170 ('__ge__', _ge_from_lt)],
171 '__le__': [('__ge__', _ge_from_le),
172 ('__lt__', _lt_from_le),
173 ('__gt__', _gt_from_le)],
174 '__gt__': [('__lt__', _lt_from_gt),
175 ('__ge__', _ge_from_gt),
176 ('__le__', _le_from_gt)],
177 '__ge__': [('__le__', _le_from_ge),
178 ('__gt__', _gt_from_ge),
179 ('__lt__', _lt_from_ge)]
180}
181
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000182def total_ordering(cls):
Georg Brandle5a26732010-05-19 21:06:36 +0000183 """Class decorator that fills in missing ordering methods"""
Raymond Hettinger3255c632010-09-16 00:31:21 +0000184 # Find user-defined comparisons (not those inherited from object).
Raymond Hettinger15ce0be2017-09-05 09:40:44 -0700185 roots = {op for op in _convert if getattr(cls, op, None) is not getattr(object, op, None)}
Raymond Hettinger56de7e22010-04-10 16:59:03 +0000186 if not roots:
187 raise ValueError('must define at least one ordering operation: < > <= >=')
188 root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__
Raymond Hettinger1a8ada82015-01-13 22:57:35 -0800189 for opname, opfunc in _convert[root]:
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000190 if opname not in roots:
191 opfunc.__name__ = opname
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000192 setattr(cls, opname, opfunc)
193 return cls
194
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700195
196################################################################################
197### cmp_to_key() function converter
198################################################################################
199
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000200def cmp_to_key(mycmp):
Georg Brandle5a26732010-05-19 21:06:36 +0000201 """Convert a cmp= function into a key= function"""
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000202 class K(object):
Raymond Hettingera0d1d962011-03-21 17:50:28 -0700203 __slots__ = ['obj']
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700204 def __init__(self, obj):
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000205 self.obj = obj
206 def __lt__(self, other):
207 return mycmp(self.obj, other.obj) < 0
208 def __gt__(self, other):
209 return mycmp(self.obj, other.obj) > 0
210 def __eq__(self, other):
211 return mycmp(self.obj, other.obj) == 0
212 def __le__(self, other):
213 return mycmp(self.obj, other.obj) <= 0
214 def __ge__(self, other):
215 return mycmp(self.obj, other.obj) >= 0
Raymond Hettinger003be522011-05-03 11:01:32 -0700216 __hash__ = None
Raymond Hettingerc50846a2010-04-05 18:56:31 +0000217 return K
Georg Brandl2e7346a2010-07-31 18:09:23 +0000218
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700219try:
220 from _functools import cmp_to_key
Brett Cannoncd171c82013-07-04 17:43:24 -0400221except ImportError:
Raymond Hettinger7ab9e222011-04-05 02:33:54 -0700222 pass
223
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700224
225################################################################################
madman-bobe25d5fc2018-10-25 15:02:10 +0100226### reduce() sequence to a single item
227################################################################################
228
229_initial_missing = object()
230
231def reduce(function, sequence, initial=_initial_missing):
232 """
233 reduce(function, sequence[, initial]) -> value
234
235 Apply a function of two arguments cumulatively to the items of a sequence,
236 from left to right, so as to reduce the sequence to a single value.
237 For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates
238 ((((1+2)+3)+4)+5). If initial is present, it is placed before the items
239 of the sequence in the calculation, and serves as a default when the
240 sequence is empty.
241 """
242
243 it = iter(sequence)
244
245 if initial is _initial_missing:
246 try:
247 value = next(it)
248 except StopIteration:
249 raise TypeError("reduce() of empty sequence with no initial value") from None
250 else:
251 value = initial
252
253 for element in it:
254 value = function(value, element)
255
256 return value
257
258try:
259 from _functools import reduce
260except ImportError:
261 pass
262
263
264################################################################################
Antoine Pitroub5b37142012-11-13 21:35:40 +0100265### partial() argument application
266################################################################################
267
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000268# Purely functional, no descriptor behaviour
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000269class partial:
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000270 """New function with partial application of the given arguments
Antoine Pitroub5b37142012-11-13 21:35:40 +0100271 and keywords.
272 """
Alexander Belopolskye49af342015-03-01 15:08:17 -0500273
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000274 __slots__ = "func", "args", "keywords", "__dict__", "__weakref__"
275
276 def __new__(*args, **keywords):
277 if not args:
278 raise TypeError("descriptor '__new__' of partial needs an argument")
279 if len(args) < 2:
280 raise TypeError("type 'partial' takes at least one argument")
281 cls, func, *args = args
282 if not callable(func):
283 raise TypeError("the first argument must be callable")
284 args = tuple(args)
285
286 if hasattr(func, "func"):
287 args = func.args + args
Serhiy Storchakada084702019-03-27 08:02:28 +0200288 keywords = {**func.keywords, **keywords}
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000289 func = func.func
290
291 self = super(partial, cls).__new__(cls)
292
293 self.func = func
294 self.args = args
295 self.keywords = keywords
296 return self
297
298 def __call__(*args, **keywords):
299 if not args:
300 raise TypeError("descriptor '__call__' of partial needs an argument")
301 self, *args = args
Serhiy Storchakada084702019-03-27 08:02:28 +0200302 keywords = {**self.keywords, **keywords}
303 return self.func(*self.args, *args, **keywords)
Nick Coghlan457fc9a2016-09-10 20:00:02 +1000304
305 @recursive_repr()
306 def __repr__(self):
307 qualname = type(self).__qualname__
308 args = [repr(self.func)]
309 args.extend(repr(x) for x in self.args)
310 args.extend(f"{k}={v!r}" for (k, v) in self.keywords.items())
311 if type(self).__module__ == "functools":
312 return f"functools.{qualname}({', '.join(args)})"
313 return f"{qualname}({', '.join(args)})"
314
315 def __reduce__(self):
316 return type(self), (self.func,), (self.func, self.args,
317 self.keywords or None, self.__dict__ or None)
318
319 def __setstate__(self, state):
320 if not isinstance(state, tuple):
321 raise TypeError("argument to __setstate__ must be a tuple")
322 if len(state) != 4:
323 raise TypeError(f"expected 4 items in state, got {len(state)}")
324 func, args, kwds, namespace = state
325 if (not callable(func) or not isinstance(args, tuple) or
326 (kwds is not None and not isinstance(kwds, dict)) or
327 (namespace is not None and not isinstance(namespace, dict))):
328 raise TypeError("invalid partial state")
329
330 args = tuple(args) # just in case it's a subclass
331 if kwds is None:
332 kwds = {}
333 elif type(kwds) is not dict: # XXX does it need to be *exactly* dict?
334 kwds = dict(kwds)
335 if namespace is None:
336 namespace = {}
337
338 self.__dict__ = namespace
339 self.func = func
340 self.args = args
341 self.keywords = kwds
Antoine Pitroub5b37142012-11-13 21:35:40 +0100342
343try:
344 from _functools import partial
Brett Cannoncd171c82013-07-04 17:43:24 -0400345except ImportError:
Antoine Pitroub5b37142012-11-13 21:35:40 +0100346 pass
347
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000348# Descriptor version
349class partialmethod(object):
350 """Method descriptor with partial application of the given arguments
351 and keywords.
352
353 Supports wrapping existing descriptors and handles non-descriptor
354 callables as instance methods.
355 """
356
Serhiy Storchaka42a139e2019-04-01 09:16:35 +0300357 def __init__(*args, **keywords):
358 if len(args) >= 2:
359 self, func, *args = args
360 elif not args:
361 raise TypeError("descriptor '__init__' of partialmethod "
362 "needs an argument")
363 elif 'func' in keywords:
364 func = keywords.pop('func')
365 self, *args = args
366 import warnings
367 warnings.warn("Passing 'func' as keyword argument is deprecated",
368 DeprecationWarning, stacklevel=2)
369 else:
370 raise TypeError("type 'partialmethod' takes at least one argument, "
371 "got %d" % (len(args)-1))
372 args = tuple(args)
373
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000374 if not callable(func) and not hasattr(func, "__get__"):
375 raise TypeError("{!r} is not callable or a descriptor"
376 .format(func))
377
378 # func could be a descriptor like classmethod which isn't callable,
379 # so we can't inherit from partial (it verifies func is callable)
380 if isinstance(func, partialmethod):
381 # flattening is mandatory in order to place cls/self before all
382 # other arguments
383 # it's also more efficient since only one function will be called
384 self.func = func.func
385 self.args = func.args + args
Serhiy Storchakada084702019-03-27 08:02:28 +0200386 self.keywords = {**func.keywords, **keywords}
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000387 else:
388 self.func = func
389 self.args = args
390 self.keywords = keywords
391
392 def __repr__(self):
393 args = ", ".join(map(repr, self.args))
394 keywords = ", ".join("{}={!r}".format(k, v)
395 for k, v in self.keywords.items())
396 format_string = "{module}.{cls}({func}, {args}, {keywords})"
397 return format_string.format(module=self.__class__.__module__,
Serhiy Storchaka521e5862014-07-22 15:00:37 +0300398 cls=self.__class__.__qualname__,
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000399 func=self.func,
400 args=args,
401 keywords=keywords)
402
403 def _make_unbound_method(self):
404 def _method(*args, **keywords):
Serhiy Storchakada084702019-03-27 08:02:28 +0200405 cls_or_self, *args = args
406 keywords = {**self.keywords, **keywords}
407 return self.func(cls_or_self, *self.args, *args, **keywords)
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000408 _method.__isabstractmethod__ = self.__isabstractmethod__
Yury Selivanovda5fe4f2014-01-27 17:28:37 -0500409 _method._partialmethod = self
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000410 return _method
411
412 def __get__(self, obj, cls):
413 get = getattr(self.func, "__get__", None)
414 result = None
415 if get is not None:
416 new_func = get(obj, cls)
417 if new_func is not self.func:
418 # Assume __get__ returning something new indicates the
419 # creation of an appropriate callable
420 result = partial(new_func, *self.args, **self.keywords)
421 try:
422 result.__self__ = new_func.__self__
423 except AttributeError:
424 pass
425 if result is None:
426 # If the underlying descriptor didn't do anything, treat this
427 # like an instance method
428 result = self._make_unbound_method().__get__(obj, cls)
429 return result
430
431 @property
432 def __isabstractmethod__(self):
433 return getattr(self.func, "__isabstractmethod__", False)
434
Pablo Galindo7cd25432018-10-26 12:19:14 +0100435# Helper functions
436
437def _unwrap_partial(func):
438 while isinstance(func, partial):
439 func = func.func
440 return func
Antoine Pitroub5b37142012-11-13 21:35:40 +0100441
442################################################################################
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700443### LRU Cache function decorator
444################################################################################
445
Raymond Hettingerdce583e2012-03-16 22:12:20 -0700446_CacheInfo = namedtuple("CacheInfo", ["hits", "misses", "maxsize", "currsize"])
Nick Coghlan234515a2010-11-30 06:19:46 +0000447
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700448class _HashedSeq(list):
Raymond Hettingerf96b2b02013-03-08 21:11:55 -0700449 """ This class guarantees that hash() will be called no more than once
450 per element. This is important because the lru_cache() will hash
451 the key multiple times on a cache miss.
452
453 """
454
Raymond Hettinger9acbb602012-04-30 22:32:16 -0700455 __slots__ = 'hashvalue'
456
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700457 def __init__(self, tup, hash=hash):
458 self[:] = tup
459 self.hashvalue = hash(tup)
Raymond Hettinger9acbb602012-04-30 22:32:16 -0700460
461 def __hash__(self):
462 return self.hashvalue
463
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700464def _make_key(args, kwds, typed,
465 kwd_mark = (object(),),
Raymond Hettingerd8080c02019-01-26 03:02:00 -0500466 fasttypes = {int, str},
Raymond Hettinger4ee39142017-01-08 17:28:20 -0800467 tuple=tuple, type=type, len=len):
Raymond Hettingerf96b2b02013-03-08 21:11:55 -0700468 """Make a cache key from optionally typed positional and keyword arguments
469
470 The key is constructed in a way that is flat as possible rather than
471 as a nested structure that would take more memory.
472
473 If there is only a single argument and its data type is known to cache
474 its hash value, then that argument is returned without a wrapper. This
475 saves space and improves lookup speed.
476
477 """
Raymond Hettinger55037092017-09-04 17:47:53 -0700478 # All of code below relies on kwds preserving the order input by the user.
479 # Formerly, we sorted() the kwds before looping. The new way is *much*
480 # faster; however, it means that f(x=1, y=2) will now be treated as a
481 # distinct call from f(y=2, x=1) which will be cached separately.
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700482 key = args
483 if kwds:
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700484 key += kwd_mark
Raymond Hettinger4ee39142017-01-08 17:28:20 -0800485 for item in kwds.items():
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700486 key += item
487 if typed:
488 key += tuple(type(v) for v in args)
489 if kwds:
Raymond Hettinger4ee39142017-01-08 17:28:20 -0800490 key += tuple(type(v) for v in kwds.values())
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700491 elif len(key) == 1 and type(key[0]) in fasttypes:
492 return key[0]
493 return _HashedSeq(key)
494
Raymond Hettinger010ce322012-05-19 21:20:48 -0700495def lru_cache(maxsize=128, typed=False):
Benjamin Peterson1f594ad2010-08-08 13:17:07 +0000496 """Least-recently-used cache decorator.
Georg Brandl2e7346a2010-07-31 18:09:23 +0000497
Raymond Hettingerc79fb0e2010-12-01 03:45:41 +0000498 If *maxsize* is set to None, the LRU features are disabled and the cache
499 can grow without bound.
500
Raymond Hettingercd9fdfd2011-10-20 08:57:45 -0700501 If *typed* is True, arguments of different types will be cached separately.
502 For example, f(3.0) and f(3) will be treated as distinct calls with
503 distinct results.
504
Georg Brandl2e7346a2010-07-31 18:09:23 +0000505 Arguments to the cached function must be hashable.
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000506
Raymond Hettinger7f7a5a72012-03-30 21:50:40 -0700507 View the cache statistics named tuple (hits, misses, maxsize, currsize)
508 with f.cache_info(). Clear the cache and statistics with f.cache_clear().
Raymond Hettinger00f2f972010-12-01 00:47:56 +0000509 Access the underlying function with f.__wrapped__.
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000510
511 See: http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used
Georg Brandl2e7346a2010-07-31 18:09:23 +0000512
Benjamin Peterson1f594ad2010-08-08 13:17:07 +0000513 """
Raymond Hettinger1ff50df2012-03-30 13:15:48 -0700514
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000515 # Users should only access the lru_cache through its public API:
Raymond Hettinger5e20bab2010-11-30 07:13:04 +0000516 # cache_info, cache_clear, and f.__wrapped__
Raymond Hettinger5fa40c02010-11-25 08:11:57 +0000517 # The internals of the lru_cache are encapsulated for thread safety and
518 # to allow the implementation to change (including a possible C version).
519
Raymond Hettinger4d588972014-08-12 12:44:52 -0700520 # Early detection of an erroneous call to @lru_cache without any arguments
521 # resulting in the inner function being passed to maxsize instead of an
Raymond Hettingerd8080c02019-01-26 03:02:00 -0500522 # integer or None. Negative maxsize is treated as 0.
523 if isinstance(maxsize, int):
524 if maxsize < 0:
525 maxsize = 0
526 elif maxsize is not None:
Raymond Hettinger4d588972014-08-12 12:44:52 -0700527 raise TypeError('Expected maxsize to be an integer or None')
528
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300529 def decorating_function(user_function):
530 wrapper = _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo)
531 return update_wrapper(wrapper, user_function)
532
533 return decorating_function
534
535def _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo):
Raymond Hettinger9f0ab9f2012-04-29 14:55:27 -0700536 # Constants shared by all lru cache instances:
Raymond Hettingerb6b98c02012-04-29 18:09:02 -0700537 sentinel = object() # unique object used to signal cache misses
Raymond Hettinger0c9050c2012-06-04 00:21:14 -0700538 make_key = _make_key # build a key from the function arguments
Raymond Hettinger9f0ab9f2012-04-29 14:55:27 -0700539 PREV, NEXT, KEY, RESULT = 0, 1, 2, 3 # names for the link fields
540
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300541 cache = {}
542 hits = misses = 0
543 full = False
544 cache_get = cache.get # bound method to lookup a key or return None
Raymond Hettingerb2d4b3d2016-12-16 14:59:37 -0800545 cache_len = cache.__len__ # get cache size without calling len()
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300546 lock = RLock() # because linkedlist updates aren't threadsafe
547 root = [] # root of the circular doubly linked list
548 root[:] = [root, root, None, None] # initialize by pointing to self
Raymond Hettinger6e8c8172012-03-16 16:53:05 -0700549
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300550 if maxsize == 0:
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700551
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300552 def wrapper(*args, **kwds):
Raymond Hettingerffdf1c32019-01-31 15:03:38 -0800553 # No caching -- just a statistics update
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300554 nonlocal misses
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300555 misses += 1
Raymond Hettingerffdf1c32019-01-31 15:03:38 -0800556 result = user_function(*args, **kwds)
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300557 return result
558
559 elif maxsize is None:
560
561 def wrapper(*args, **kwds):
562 # Simple caching without ordering or size limit
563 nonlocal hits, misses
564 key = make_key(args, kwds, typed)
565 result = cache_get(key, sentinel)
566 if result is not sentinel:
567 hits += 1
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700568 return result
Raymond Hettingerffdf1c32019-01-31 15:03:38 -0800569 misses += 1
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300570 result = user_function(*args, **kwds)
571 cache[key] = result
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300572 return result
Raymond Hettinger7e0c5812012-03-17 15:10:24 -0700573
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300574 else:
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700575
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300576 def wrapper(*args, **kwds):
577 # Size limited caching that tracks accesses by recency
578 nonlocal root, hits, misses, full
579 key = make_key(args, kwds, typed)
580 with lock:
581 link = cache_get(key)
582 if link is not None:
583 # Move the link to the front of the circular queue
584 link_prev, link_next, _key, result = link
585 link_prev[NEXT] = link_next
586 link_next[PREV] = link_prev
587 last = root[PREV]
588 last[NEXT] = root[PREV] = link
589 link[PREV] = last
590 link[NEXT] = root
Nick Coghlan234515a2010-11-30 06:19:46 +0000591 hits += 1
Raymond Hettinger4b779b32011-10-15 23:50:42 -0700592 return result
Raymond Hettingerd8080c02019-01-26 03:02:00 -0500593 misses += 1
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300594 result = user_function(*args, **kwds)
595 with lock:
596 if key in cache:
597 # Getting here means that this same key was added to the
598 # cache while the lock was released. Since the link
599 # update is already done, we need only return the
600 # computed result and update the count of misses.
601 pass
602 elif full:
603 # Use the old root to store the new key and result.
604 oldroot = root
605 oldroot[KEY] = key
606 oldroot[RESULT] = result
607 # Empty the oldest link and make it the new root.
608 # Keep a reference to the old key and old result to
609 # prevent their ref counts from going to zero during the
610 # update. That will prevent potentially arbitrary object
611 # clean-up code (i.e. __del__) from running while we're
612 # still adjusting the links.
613 root = oldroot[NEXT]
614 oldkey = root[KEY]
615 oldresult = root[RESULT]
616 root[KEY] = root[RESULT] = None
617 # Now update the cache dictionary.
618 del cache[oldkey]
619 # Save the potentially reentrant cache[key] assignment
620 # for last, after the root and links have been put in
621 # a consistent state.
622 cache[key] = oldroot
623 else:
624 # Put result in a new link at the front of the queue.
625 last = root[PREV]
626 link = [last, root, key, result]
627 last[NEXT] = root[PREV] = cache[key] = link
Raymond Hettingerb2d4b3d2016-12-16 14:59:37 -0800628 # Use the cache_len bound method instead of the len() function
Raymond Hettingeraf56e0e2016-12-16 13:57:40 -0800629 # which could potentially be wrapped in an lru_cache itself.
Raymond Hettingerb2d4b3d2016-12-16 14:59:37 -0800630 full = (cache_len() >= maxsize)
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300631 return result
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700632
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300633 def cache_info():
634 """Report cache statistics"""
635 with lock:
Raymond Hettingerb2d4b3d2016-12-16 14:59:37 -0800636 return _CacheInfo(hits, misses, maxsize, cache_len())
Raymond Hettingerbc8e81d2012-03-17 00:24:09 -0700637
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300638 def cache_clear():
639 """Clear the cache and cache statistics"""
640 nonlocal hits, misses, full
641 with lock:
642 cache.clear()
643 root[:] = [root, root, None, None]
644 hits = misses = 0
645 full = False
Georg Brandl2e7346a2010-07-31 18:09:23 +0000646
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300647 wrapper.cache_info = cache_info
648 wrapper.cache_clear = cache_clear
Serhiy Storchakace2295d2015-10-24 09:51:53 +0300649 return wrapper
Nick Coghlan234515a2010-11-30 06:19:46 +0000650
Serhiy Storchaka46c56112015-05-24 21:53:49 +0300651try:
652 from _functools import _lru_cache_wrapper
653except ImportError:
654 pass
Łukasz Langa6f692512013-06-05 12:20:24 +0200655
656
657################################################################################
658### singledispatch() - single-dispatch generic function decorator
659################################################################################
660
Łukasz Langa3720c772013-07-01 16:00:38 +0200661def _c3_merge(sequences):
662 """Merges MROs in *sequences* to a single MRO using the C3 algorithm.
663
664 Adapted from http://www.python.org/download/releases/2.3/mro/.
665
666 """
667 result = []
668 while True:
669 sequences = [s for s in sequences if s] # purge empty sequences
670 if not sequences:
671 return result
672 for s1 in sequences: # find merge candidates among seq heads
673 candidate = s1[0]
674 for s2 in sequences:
675 if candidate in s2[1:]:
676 candidate = None
677 break # reject the current head, it appears later
678 else:
679 break
Yury Selivanov77a8cd62015-08-18 14:20:00 -0400680 if candidate is None:
Łukasz Langa3720c772013-07-01 16:00:38 +0200681 raise RuntimeError("Inconsistent hierarchy")
682 result.append(candidate)
683 # remove the chosen candidate
684 for seq in sequences:
685 if seq[0] == candidate:
686 del seq[0]
687
688def _c3_mro(cls, abcs=None):
689 """Computes the method resolution order using extended C3 linearization.
690
691 If no *abcs* are given, the algorithm works exactly like the built-in C3
692 linearization used for method resolution.
693
694 If given, *abcs* is a list of abstract base classes that should be inserted
695 into the resulting MRO. Unrelated ABCs are ignored and don't end up in the
696 result. The algorithm inserts ABCs where their functionality is introduced,
697 i.e. issubclass(cls, abc) returns True for the class itself but returns
698 False for all its direct base classes. Implicit ABCs for a given class
699 (either registered or inferred from the presence of a special method like
700 __len__) are inserted directly after the last ABC explicitly listed in the
701 MRO of said class. If two implicit ABCs end up next to each other in the
702 resulting MRO, their ordering depends on the order of types in *abcs*.
703
704 """
705 for i, base in enumerate(reversed(cls.__bases__)):
706 if hasattr(base, '__abstractmethods__'):
707 boundary = len(cls.__bases__) - i
708 break # Bases up to the last explicit ABC are considered first.
709 else:
710 boundary = 0
711 abcs = list(abcs) if abcs else []
712 explicit_bases = list(cls.__bases__[:boundary])
713 abstract_bases = []
714 other_bases = list(cls.__bases__[boundary:])
715 for base in abcs:
716 if issubclass(cls, base) and not any(
717 issubclass(b, base) for b in cls.__bases__
718 ):
719 # If *cls* is the class that introduces behaviour described by
720 # an ABC *base*, insert said ABC to its MRO.
721 abstract_bases.append(base)
722 for base in abstract_bases:
723 abcs.remove(base)
724 explicit_c3_mros = [_c3_mro(base, abcs=abcs) for base in explicit_bases]
725 abstract_c3_mros = [_c3_mro(base, abcs=abcs) for base in abstract_bases]
726 other_c3_mros = [_c3_mro(base, abcs=abcs) for base in other_bases]
727 return _c3_merge(
728 [[cls]] +
729 explicit_c3_mros + abstract_c3_mros + other_c3_mros +
730 [explicit_bases] + [abstract_bases] + [other_bases]
731 )
732
733def _compose_mro(cls, types):
734 """Calculates the method resolution order for a given class *cls*.
735
736 Includes relevant abstract base classes (with their respective bases) from
737 the *types* iterable. Uses a modified C3 linearization algorithm.
Łukasz Langa6f692512013-06-05 12:20:24 +0200738
739 """
740 bases = set(cls.__mro__)
Łukasz Langa3720c772013-07-01 16:00:38 +0200741 # Remove entries which are already present in the __mro__ or unrelated.
742 def is_related(typ):
743 return (typ not in bases and hasattr(typ, '__mro__')
744 and issubclass(cls, typ))
745 types = [n for n in types if is_related(n)]
746 # Remove entries which are strict bases of other entries (they will end up
747 # in the MRO anyway.
748 def is_strict_base(typ):
749 for other in types:
750 if typ != other and typ in other.__mro__:
751 return True
752 return False
753 types = [n for n in types if not is_strict_base(n)]
754 # Subclasses of the ABCs in *types* which are also implemented by
755 # *cls* can be used to stabilize ABC ordering.
756 type_set = set(types)
757 mro = []
758 for typ in types:
759 found = []
760 for sub in typ.__subclasses__():
761 if sub not in bases and issubclass(cls, sub):
762 found.append([s for s in sub.__mro__ if s in type_set])
763 if not found:
764 mro.append(typ)
765 continue
766 # Favor subclasses with the biggest number of useful bases
767 found.sort(key=len, reverse=True)
768 for sub in found:
769 for subcls in sub:
770 if subcls not in mro:
771 mro.append(subcls)
772 return _c3_mro(cls, abcs=mro)
Łukasz Langa6f692512013-06-05 12:20:24 +0200773
774def _find_impl(cls, registry):
Łukasz Langa3720c772013-07-01 16:00:38 +0200775 """Returns the best matching implementation from *registry* for type *cls*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200776
Łukasz Langa3720c772013-07-01 16:00:38 +0200777 Where there is no registered implementation for a specific type, its method
778 resolution order is used to find a more generic implementation.
779
780 Note: if *registry* does not contain an implementation for the base
781 *object* type, this function may return None.
Łukasz Langa6f692512013-06-05 12:20:24 +0200782
783 """
784 mro = _compose_mro(cls, registry.keys())
785 match = None
786 for t in mro:
787 if match is not None:
Łukasz Langa3720c772013-07-01 16:00:38 +0200788 # If *match* is an implicit ABC but there is another unrelated,
789 # equally matching implicit ABC, refuse the temptation to guess.
790 if (t in registry and t not in cls.__mro__
791 and match not in cls.__mro__
792 and not issubclass(match, t)):
Łukasz Langa6f692512013-06-05 12:20:24 +0200793 raise RuntimeError("Ambiguous dispatch: {} or {}".format(
794 match, t))
795 break
796 if t in registry:
797 match = t
798 return registry.get(match)
799
800def singledispatch(func):
801 """Single-dispatch generic function decorator.
802
803 Transforms a function into a generic function, which can have different
804 behaviours depending upon the type of its first argument. The decorated
805 function acts as the default implementation, and additional
Łukasz Langa3720c772013-07-01 16:00:38 +0200806 implementations can be registered using the register() attribute of the
807 generic function.
Łukasz Langa6f692512013-06-05 12:20:24 +0200808 """
INADA Naoki9811e802017-09-30 16:13:02 +0900809 # There are many programs that use functools without singledispatch, so we
810 # trade-off making singledispatch marginally slower for the benefit of
811 # making start-up of such applications slightly faster.
812 import types, weakref
813
Łukasz Langa6f692512013-06-05 12:20:24 +0200814 registry = {}
INADA Naoki9811e802017-09-30 16:13:02 +0900815 dispatch_cache = weakref.WeakKeyDictionary()
Łukasz Langa6f692512013-06-05 12:20:24 +0200816 cache_token = None
817
Łukasz Langa3720c772013-07-01 16:00:38 +0200818 def dispatch(cls):
819 """generic_func.dispatch(cls) -> <function implementation>
Łukasz Langa6f692512013-06-05 12:20:24 +0200820
821 Runs the dispatch algorithm to return the best available implementation
Łukasz Langa3720c772013-07-01 16:00:38 +0200822 for the given *cls* registered on *generic_func*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200823
824 """
825 nonlocal cache_token
826 if cache_token is not None:
827 current_token = get_cache_token()
828 if cache_token != current_token:
829 dispatch_cache.clear()
830 cache_token = current_token
831 try:
Łukasz Langa3720c772013-07-01 16:00:38 +0200832 impl = dispatch_cache[cls]
Łukasz Langa6f692512013-06-05 12:20:24 +0200833 except KeyError:
834 try:
Łukasz Langa3720c772013-07-01 16:00:38 +0200835 impl = registry[cls]
Łukasz Langa6f692512013-06-05 12:20:24 +0200836 except KeyError:
Łukasz Langa3720c772013-07-01 16:00:38 +0200837 impl = _find_impl(cls, registry)
838 dispatch_cache[cls] = impl
Łukasz Langa6f692512013-06-05 12:20:24 +0200839 return impl
840
Łukasz Langa3720c772013-07-01 16:00:38 +0200841 def register(cls, func=None):
842 """generic_func.register(cls, func) -> func
Łukasz Langa6f692512013-06-05 12:20:24 +0200843
Łukasz Langa3720c772013-07-01 16:00:38 +0200844 Registers a new implementation for the given *cls* on a *generic_func*.
Łukasz Langa6f692512013-06-05 12:20:24 +0200845
846 """
847 nonlocal cache_token
848 if func is None:
Łukasz Langae5697532017-12-11 13:56:31 -0800849 if isinstance(cls, type):
850 return lambda f: register(cls, f)
851 ann = getattr(cls, '__annotations__', {})
852 if not ann:
853 raise TypeError(
854 f"Invalid first argument to `register()`: {cls!r}. "
855 f"Use either `@register(some_class)` or plain `@register` "
856 f"on an annotated function."
857 )
858 func = cls
859
860 # only import typing if annotation parsing is necessary
861 from typing import get_type_hints
862 argname, cls = next(iter(get_type_hints(func).items()))
863 assert isinstance(cls, type), (
864 f"Invalid annotation for {argname!r}. {cls!r} is not a class."
865 )
Łukasz Langa3720c772013-07-01 16:00:38 +0200866 registry[cls] = func
867 if cache_token is None and hasattr(cls, '__abstractmethods__'):
Łukasz Langa6f692512013-06-05 12:20:24 +0200868 cache_token = get_cache_token()
869 dispatch_cache.clear()
870 return func
871
872 def wrapper(*args, **kw):
Dong-hee Na445f1b32018-07-10 16:26:36 +0900873 if not args:
874 raise TypeError(f'{funcname} requires at least '
875 '1 positional argument')
876
Łukasz Langa6f692512013-06-05 12:20:24 +0200877 return dispatch(args[0].__class__)(*args, **kw)
878
Dong-hee Na445f1b32018-07-10 16:26:36 +0900879 funcname = getattr(func, '__name__', 'singledispatch function')
Łukasz Langa6f692512013-06-05 12:20:24 +0200880 registry[object] = func
881 wrapper.register = register
882 wrapper.dispatch = dispatch
INADA Naoki9811e802017-09-30 16:13:02 +0900883 wrapper.registry = types.MappingProxyType(registry)
Łukasz Langa6f692512013-06-05 12:20:24 +0200884 wrapper._clear_cache = dispatch_cache.clear
885 update_wrapper(wrapper, func)
886 return wrapper
Ethan Smithc6512752018-05-26 16:38:33 -0400887
888
889# Descriptor version
890class singledispatchmethod:
891 """Single-dispatch generic method descriptor.
892
893 Supports wrapping existing descriptors and handles non-descriptor
894 callables as instance methods.
895 """
896
897 def __init__(self, func):
898 if not callable(func) and not hasattr(func, "__get__"):
899 raise TypeError(f"{func!r} is not callable or a descriptor")
900
901 self.dispatcher = singledispatch(func)
902 self.func = func
903
904 def register(self, cls, method=None):
905 """generic_method.register(cls, func) -> func
906
907 Registers a new implementation for the given *cls* on a *generic_method*.
908 """
909 return self.dispatcher.register(cls, func=method)
910
911 def __get__(self, obj, cls):
912 def _method(*args, **kwargs):
913 method = self.dispatcher.dispatch(args[0].__class__)
914 return method.__get__(obj, cls)(*args, **kwargs)
915
916 _method.__isabstractmethod__ = self.__isabstractmethod__
917 _method.register = self.register
918 update_wrapper(_method, self.func)
919 return _method
920
921 @property
922 def __isabstractmethod__(self):
923 return getattr(self.func, '__isabstractmethod__', False)
Carl Meyerd658dea2018-08-28 01:11:56 -0600924
925
926################################################################################
927### cached_property() - computed once per instance, cached as attribute
928################################################################################
929
930_NOT_FOUND = object()
931
932
933class cached_property:
934 def __init__(self, func):
935 self.func = func
936 self.attrname = None
937 self.__doc__ = func.__doc__
938 self.lock = RLock()
939
940 def __set_name__(self, owner, name):
941 if self.attrname is None:
942 self.attrname = name
943 elif name != self.attrname:
944 raise TypeError(
945 "Cannot assign the same cached_property to two different names "
946 f"({self.attrname!r} and {name!r})."
947 )
948
949 def __get__(self, instance, owner):
950 if instance is None:
951 return self
952 if self.attrname is None:
953 raise TypeError(
954 "Cannot use cached_property instance without calling __set_name__ on it.")
955 try:
956 cache = instance.__dict__
957 except AttributeError: # not all objects have __dict__ (e.g. class defines slots)
958 msg = (
959 f"No '__dict__' attribute on {type(instance).__name__!r} "
960 f"instance to cache {self.attrname!r} property."
961 )
962 raise TypeError(msg) from None
963 val = cache.get(self.attrname, _NOT_FOUND)
964 if val is _NOT_FOUND:
965 with self.lock:
966 # check if another thread filled cache while we awaited lock
967 val = cache.get(self.attrname, _NOT_FOUND)
968 if val is _NOT_FOUND:
969 val = self.func(instance)
970 try:
971 cache[self.attrname] = val
972 except TypeError:
973 msg = (
974 f"The '__dict__' attribute on {type(instance).__name__!r} instance "
975 f"does not support item assignment for caching {self.attrname!r} property."
976 )
977 raise TypeError(msg) from None
978 return val