on_query_completions fails to return custom completions when some characters are used

[joshgoebel]

Mac build 3083 here.

First lets make a simple completion:

{
    "scope": "source.coffee",
    "completions":[
        { "trigger": "constructor:\twow",
        "contents": "constructor: (${1:@instance}) ->\n\t$0"}
    ]
}

So when I type "c" I see "constructor:" in the completion list. Now lets create a plugin:

class MagicCompletions(sublime_plugin.EventListener):
    def on_query_completions(self, view, prefix, locations):
        return [("colon","i'm another completion")]

No issues... now autocomplete includes both "colon" and "constructor:"... but lets add a few other characters to the trigger:

class MagicCompletions(sublime_plugin.EventListener):
    def on_query_completions(self, view, prefix, locations):
        return [("colon(a, b)","i'm another completion")]

Now auto-complete ONLY shows "colon(a, b)" [which seems to work just fine] but "constructor:" has completely disappeared...

Problem characters seem to be parens, commas, spaces, but it may actually be any non [a-z]... Not sure since I don't have the actual Sublime source to figure out why the heck this might be behaving this way.

[joshgoebel]

It also seems to break completing words from the current file although I swore that was working earlier. The example above is 100% consistently broken for me though.

[FichteFoll]

Can confirm in source.python scope (where is also shows the "class" snippet).

What's also odd is that the API-injected completion is not cleared when I comment the code out and save → reload the file. I have to restart ST to unload it properly.

Word completion is broken for me too while the event listener is active. While usually the word completions do not show up from just typing c they do once I write com. Either way, this does not happen when the listener is loaded.

Everything I know about on_query_completions is available here.

[joshgoebel]

While usually the word completions do not show up from just typing c they do once I write com.

I think that's just an autocomplete preference somewhere.

What's also odd is that the API-injected completion is not cleared when I comment the code out and save → reload the file.

Is that the expected behavior (from ST's perspective)?

I would assume there is just a Python interpreter running in another thread... change the class works because the file is reloaded (redefining the class) but just removing the class - the file is reloaded, but there is no "magic" to tell Python it should undefined the class that was previously defined by the file.

Is ST intended to handle that case?

[FichteFoll]

Yes. When a module is loaded sublime_plugin.py instantiates all EventListeners it finds (subclasses of the class) and assigns it to a new module global named plugins. They are then added to a mapping of all callbacks if they define such a method (e.g. on_query_completions).

When the plugin is then unloaded (which happens before it is reloaded), it accesses the plugins attribute it assigned earler and removes all instantiated (or non-instantiated for commands) classes from the mappings.

[iamfredng]

I have a same issue. When I try to use "sublime.INHIBIT_WORD_COMPLETIONS". the result is different.

When I use "_" to replace "( ) . ,". It works.

[evandrocoan]

@iamfredng, I used a Unicode Character similar to replace them like:

import sublime
import sublime_plugin

class FileNameComplete(sublime_plugin.EventListener):

    def on_query_completions(self, view, prefix, locations):
        completion_string = "auto.complete"

        # replaces dot `.` by a `ꓸ` (Lisu Letter Tone Mya Ti)
        return [[completion_string.replace(".", "ꓸ"), completion_string]]

It works. I tested a little, the bad symbols are:

1. (
2. !
3. ,
4. .
5. |
6. <
7. ;
8. :
9. &
10. *
11. $
12. ...
13. Man, it is everything. I will stop trying to.

Seems better just use ''.join(e for e in completion_string if e.isalnum()):

import sublime
import sublime_plugin

class FileNameComplete(sublime_plugin.EventListener):

    def on_query_completions(self, view, prefix, locations):
        completion_string = "auto.complete"

        # removes all special characters
        return [[''.join(e for e in completion_string if e.isalnum()), completion_string]]

1. https://stackoverflow.com/questions/5843518/ Remove all special characters, punctuation and spaces from string

[randy3k]

this bug is annoying when working with https://github.com/tomv564/LSP and language servers return completions with non-alphanum chars.

[randy3k]

I believe I manage to fix it by temporarily masking word_separators

import sublime
import sublime_plugin

class TestComplete(sublime_plugin.EventListener):

    def on_query_completions(self, view, prefix, locations):
        completion_string = "auto.complete"

        # temporarily masking word_separators
        word_separators = view.settings().get("word_separators")
        view.settings().set("word_separators", "")
        sublime.set_timeout(lambda: view.settings().set("word_separators", word_separators), 0)
        return [(completion_string, completion_string)]

PS: this trick doesn't work with completions which contain spaces.
PS2: it seems that it would break some WORD_COMPLETIONS detection.