StopIteration has wrong __init__ doc

[jeffreyyjp]

Environment data

• Language Server version: v2020.11.2
• OS and version: 10.15.7
• Python version (& distribution if applicable, e.g. Anaconda): 3.8.2

Expected behaviour

Show each specific info for Exception

Actual behaviour

Logs

XXX

Code Snippet / Additional information

XXX

[jakebailey]

There's some inconsistency here. When just the type is present:

But when it's called, the __init__ function's doc is used:

But, I can see in the generated file for the builtin docstrings that it should be working:

So, very likely a bug in the docstring fetching code for init methods.

[erictraut]

The problem here is that these subclassed exceptions don't have an __init__ method override, so we're finding the __init__ in the base class, and we're picking up the docstring from that class.

[jakebailey]

Ah, yeah. That's what I thought. I'm thinking that there would need to be an alternate traversal that checks the shadow files for docs rather than the regular type lookup that doesn't consider it.

[yvvt0379]

Excuse me, but when will this problem be solved? It's been quite a long time since this issue was opened. JediLSP is doing the correct behavior. So when will Pylance？

[jakebailey]

The next version should fix this particular case (inheriting object's docs), though the whole source mapping when typeshed and our scraped output mismatch is another problem.

[jakebailey]

This issue has been fixed in version 2021.9.1, which we've just released. You can find the changelog here: https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md#202191-8-september-2021