Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
Description
Bug report
inspect.unwrap()
follows the chain by links__wrapped__
and returns the last item in a chain or the original object if it does not have a__wrapped__
attribute (there is also additional stop predicate and protection against loops, but it is unrelated). It works well in most cases, except with a type that has the__wrapped__
data descriptor.
For example the following code
classW:def__init__(self,x):self._wrapped=x@propertydef__wrapped__(self):returnself._wrappedimportinspectprint(inspect.unwrap(W(chr)))print(inspect.unwrap(W))
prints
<built-in function chr><property object at 0x7f334092dc50>
The former output is correct,W(chr)
wrapschr
. But the latter is wrong: theW
type does not wrap aproperty
object.
It is not hypothetical issue.staticmethod
andclassmethod
have now (bpo-43682/#87848) the__wrapped__
attribute.inspect.signature()
usesinspect.unwrap()
, and it cannot supportstaticmethod
andclassmethod
even if they get correct__text_signature__
.inspect.getsourcelines()
also usesinspect.unwrap()
indirectly and can fail with Python classes with the__wrapped__
attribute.
inspect.unwrap()
should stop before such attribute. But how to detect such case? There are several ways:
- Stop if
func
is a class.pickle
does it for its special methods, this is why classes are handled separately from instances. But it means thatfunctools.wraps()
,staticmethod
andclassmethod
cannot be used to decorate classes. Although if they are currently used, the result can be weird, because instances will have the same__wrapped__
attribute as a class. I do not know how often wrapped classes are used in the real code, but there is a test for this. It may be the right way at the end, although it can break some questionable code. - Stop if
func.__wrapped__
is a data descriptor. I afraid that it will affect multidecorated properties. - Stop if
func.__wrapped__
is not callable. Do not know what can be consequences.
Maybe there are other ways?
Linked PRs
- gh-112006: Fix inspect.unwrap() for types where __wrapped__ is a data descriptor #115540
- [3.11] gh-112006: Fix inspect.unwrap() for types where __wrapped__ is a data descriptor (GH-115540) #115965
- [3.12] gh-112006: Fix inspect.unwrap() for types where __wrapped__ is a data descriptor (GH-115540) #115966