Some [source] links in the documentation point to _decorators.py

[vkk800]

In the Pandas documentation pages, some [source] links of the functions don't point to the actual implementation of the function, but to pandas/util/_decorators.py, presumably because some of the decorators there have been used on the function in question and this messes up the doc generation somehow.

For an example, see the documentation of DataFrame.astype. I'm not sure if this is a systematic problem or if it applies to just this one case.

[TomAugspurger]

Looks like in

pandas/doc/source/conf.py

Line 572 in e510b1a

fn = inspect.getsourcefile(obj)

we call inspect.getsourcefile(pd.DataFrame.astype), which goes to _decorators.py.

I'm not sure whether the fix is to update linkcode_resolve or whether we need to update the decorator to use something like functools.wraps to pass along the correct information.

[vkk800]

Now that I understand the problem, using functools.wraps definitely seems like a way to go. I'm not familiar with pandas codebase, but I will still try to take a look in the next few days.

[WillAyd]

Now that I understand the problem, using functools.wraps definitely seems like a way to go.

This may have some other benefits as well like improved tracebacks. Not sure if we've ever done an audit of decorators in the code base to see what is using wraps or not but would be interesting

[TomAugspurger]

I vaguely recalled a discussion about functools.wraps breaking something. Perhaps I'm thinking of #13875 (something doesn't work properly on Python 2, which we don't care about much these days).

…

On Mon, Oct 8, 2018 at 1:32 PM William Ayd ***@***.***> wrote: Now that I understand the problem, using functools.wraps definitely seems like a way to go. This may have some other benefits as well like improved tracebacks. Not sure if we've ever done an audit of decorators in the code base to see what is using wraps or not but would be interesting — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#23046 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABQHIpoU5_q5Ja9Mve5GAokKQ7YxWaxNks5ui5pSgaJpZM4XNQK2> .

[vkk800]

Just a comment on this and my PR: the case was that the decorator used in this case was already using @functools.wraps(), but since the filename that getsourcefile() finds comes from fun.__code__.co_filename which does not get transferred from the decorated function by wraps(), the filename returned was also the filename of the wrapper function. This is probably something that should be kept in mind in the future when using functions from inspect module in conjunction with wrapped/partial/etc function.