Extend Jython auto-completion to instantiated classes

[tferr]

@acardona , @haesleinhuepf , This implements the following changes by extending Albert's recent work:

• Adds auto-completion to non-static methods
• Auto-completion does not 'crash' if import statements are wrong (with typos, etc.)
• Improves the description of suggestions by including type of parameters and return values

[imagesc-bot]

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/auto-code-completion-for-python-and-groovy-in-imagej-fiji/20515/22

[tferr]

@acardona , there are still two things that are missing in this PR:

1. Import with parenthesis are not recognized. E.g. in from ij import (ImagePlus, ImageProcessor), neither ImagePlus nor ImageProcessor get recognized as being imported
2. the description of the auto-completion is missing the URL for the class's Javadoc. This would be straightforward to include the a tag here. I think ClassUtil, has already all that information cached?
3. Another issue: currently completion works only with instantiated classes. It does not work with instances retrieved from static calls. I.e.: this works well:

   from ij import ImagePlus
   imp = ImagePlus()

   But no completions are retrieved if you use:

   from ij import IJ
   imp = IJ.getImage()

   The latter would be the most important issue. I will wait for your feedback on this.

[imagesc-bot]

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/auto-code-completion-for-python-and-groovy-in-imagej-fiji/20515/25

[acardona]

Thanks a lot @tferr, this is great.

On from ij import (ImagePlus, ImageProcessor): are these even valid? If so, I had no idea. In python, one can use multi-imports like:

from ij import ImagePlus, ImageProcessor

or even:

from ij import ImagePlus,\
                 ImageProcessor

[acardona]

On this use case:

from ij import IJ
imp = IJ.getImage()

If it's from a static method, the object class can be retrieved from the return type of the static method.

If it's from a function, like:

from ij import IJ
def getImage():
  return IJ.getImage()

imp = getImage()

... then no cookie: it's the perennial problem in non-strongly typed languages. Python is fixing this with annotations, which seem to be a part of the language in 3.8. There is currently an effort to bring jython to python 3+, but it's very understaffed (one very part-time developer).

[tferr]

For clarity, here is what this PR implements:

• Adds preliminary support for non-static methods. This is fragile and will be revamped by @acardona's ParserFacade approach)
• Shows an error in the popup list if import is not found (rather than exception)
• Does approximate string matching (exact matches are still displayed on top of list)
• Revamps auto-completion descriptions:
  • provides functional URLs to the class's JavaDoc
  • lists type of parameters, fields and return values and includes them in the replacement String
• Includes' @acardona revisions and comments
• Moves some common code to ClassUtil, so that it can be reused by future Completion providers

Here are some snapshots:

Field:

Fuzzy string search (methods):

Invalid import:

I have to say, I find it quite functional even at this stage. NB:

• I haven't implemented the retrieval of class from the return type of the static method, as I expect @acardona work will move things around
• Scijava #@ parameters type of imports are not yet supported
• Hyperlinks could likely be improved by attaching the anchor for the field/method to the html address of the class
• @haesleinhuepf , i had to revert your commit 9a584dff0b36f56bf4d3b503fca1615cbbb3e645. Not so sure why, but it broke some of the downstream auto-completion. This means lower case aliases in import statements are still not supported. (all these are probably things that can be addressed later on)

[acardona]

Hi @tferr, the code may have changed significantly. Would appreciate if you could revise your commits and see which can be applied. The branch I pushed forward is "fix-autocompletion-listener".

And @haesleinhuepf: notice I've had to change the AutoCompletionListener interface significantly. Please have a look, should be straightforward to adapt for CLIJ to insert expansions for commonly used variable names.

[tferr]

@acardona, to include JavaDoc URLs and list types in the completions, I would have to modify DotAutoCompletions#get() to return both the completion String and the completion description (also a String). Are you OK with it?

[acardona]

Hi @tferr, sounds good, should then return a new object that has both as fields rather than just a String.

[acardona]

By the way @tferr, when done, after review/test, I'd appreciate very much if you could release it all: the jython-autocompletion and the script-editor, so that it all appears in the Fiji updater.

[tferr]

@acardona, sincere apologies for the delay. 'Real work' got in the way. I think I have it working, but still need to test it more seriously. Hyperlinks seem to be working, and the completion lists the type for both fields and methods. If there are no major issues I will push and release tonight.

There are still some (minor) issues like the .acess$000 entry below, but we can always tackle this at a later time point), otherwise it will never be ready

[acardona]

Sounds great! On the subclasses: a one-liner filtering for dollar signs '$', indicative of subclasses, would do, at the level of the returned stream or list of autocompletions.

[tferr]

@acardona, I don't seem to have write access to this repository. Could you please merge this AND release version 5.0.10 of the script editor? Otherwise, give me write permissions and I will do so. Thanks!