"from module import t" completion: include __all__

[mikez]

Feature request:
Upon completing from module import t, add values in module.__all__ to names.

Background:
With the introduction of module __getattr__ and __dir__ in PEP562, I've found situations while coding where the autocompletion names can only be inferred from __all__ or __dir__.

Existing implementations in other contexts:

• iPython completion code. (This is not using static analysis.)

Past discussions:

• https://stackoverflow.com/a/37500563 (May 2016)

Looking through the Jedi source code, I see no immediate simple way of solving this. If there's a way to write a custom extension or plugin for Jedi for my IDE that works for me too.

Viile dank für Jedi, Dave. 🙏

[davidhalter]

With the introduction of module getattr and dir in PEP562, I've found situations while coding where the autocompletion names can only be inferred from all or dir.

Can you give me examples of concrete open source code bases where this is the case?

Viile dank für Jedi, Dave.

:)

[mikez]

My use case is a private repository involving lazy-loading modules which are costly to load. I use this auto-complete a lot, so it's very beneficial for me.

Searching on larger repositories on Github, I did not find that many matches. It doesn't seem to be a common use case at this time.

I noticed three patterns in general:

1. lazy loading
2. deprecation situations (I filtered those out)
3. cleaner API

Here's a list:

• https://github.com/python/cpython/blob/master/Lib/concurrent/futures/__init__.py
• https://github.com/python/cpython/blob/master/Lib/zoneinfo/__init__.py
• https://github.com/python/cpython/blob/master/Lib/unittest/__init__.py
• https://github.com/apache/airflow/blob/master/airflow/__init__.py
• https://github.com/googleapis/gapic-generator-python/blob/master/gapic/ads-templates/%25namespace/%25name/__init__.py.j2 (note that __all__ is defined towards the end here)

[davidhalter]

I see. Thanks for the examples! IMO it would be fine to add it.

However: I won't do it. I have other priorities. So if nobody steps up I will close this feature request again. It's probably also not easy to do. :)

[mikez]

I appreciate the fast response and I understand; I also value prioritization

Maybe you have some pointers on custom modification for my IDE? I don't know Jedi that well yet. I've found out that In the Anaconda code for example it seems to call Script(...).completions(). If I can easily intercept the current line here with the from module import t<tab>, then I could use iPython's strategy here for completion.

[davidhalter]

then I could use iPython's strategy here for completion.

What is that?

[mikez]

@davidhalter It's here. This is not using static analysis. (BTW happy holidays 🎄, I'm heading to 🇨🇭 soon—home of the Jedi.)

[davidhalter]

Well, the truth is that they mostly use Jedi for that. This is just a fallback for people that don't want to use Jedi.

You could obviously do something like that, but it's not going to be easy to cover all the edge cases.

Maybe you have some pointers on custom modification for my IDE?

You could probably use Jedi on the last module between from <...> import and then check in that module how __all__ is defined. That's definitely a quickfix that will work mostly fine.

[mikez]

This is just a fallback for people that don't want to use Jedi.

Ah, interesting! Maybe I was looking at the wrong code. Fact is that if I type in from my_custom_module import <tab> in a vanilla iPython or Jupyter Notebook, then I see all the completions including __all__. This is not the case in Sublime using pure Jedi.

[davidhalter]

Fact is that if I type in from my_custom_module import in a vanilla iPython or Jupyter Notebook, then I see all the completions including __all__. This is not the case in Sublime using pure Jedi.

This is probably because one is purely static analysis and the other one has access to dir and other runtime inspections.