Turn off snippets for jedi LSP

[PeterJCLaw]

Environment data

• VS Code version: 1.55.0
• Extension version (available under the Extensions sidebar): 2021.3.680753044
• OS and version: Ubuntu 20.04 LTS
• Python version: 3.7, deadsnakes
• Type of virtual environment used: virtualenv
• Value of the python.languageServer setting: JediLSP

Expected behaviour

class Thing: pass

Th<tab> # should complete to:
Thing|     # cursor after completed word

Actual behaviour

class Thing: pass

Th<tab> # should complete to:
Thing(|)  # cursor between completed parens

As far as I can tell this is specific to the JediLSP integration -- changing my language server to Jedi results in the expected completion.

I can maybe see why this is maybe useful if you're planning to construct an instance or calling a function, though there are many other places where callable symbols are used in which you don't want this to happen -- passing them as callbacks and type annotations for example.

[karthiknadig]

@PeterJCLaw This should be filed on https://github.com/pappasam/jedi-language-server. We don't control this behavior in the extension.

[PeterJCLaw]

Ah, thanks, I'd assumed that the insertion text and cursor position was controlled by the extension.

[karthiknadig]

@luabud we have snippets on be default in jediLSP. This seems to be caused by that. Should we turn it off. It is off for the other language server. But we don't have a setting to control this behavior. Need your opinion on should we turn this off by default or provide a setting.

[luabud]

If we decide to provide a setting, we should do so for the other language servers too. I don't think Pylance has any plans to have this configuration added, so I'd suggest for us to just turn it off. Would love to hear other opinions too, though!

[pappasam]

@luabud I'm not a vscode user, but for me personally, I enjoy having snippets enabled with my editor configured to manually expand them with a keybinding, when desired. This way I can benefit from snippets when I want them, but I'm not forced to use them if I don't want to. I do this for all languages / configured language servers for my LSP client (coc.nvim).

[br3ndonland]

I'm also bothered by the behavior described in the original issue report, particularly when adding type annotations.

#15858 (comment):

If we decide to provide a setting, we should do so for the other language servers too.

There is a python.analysis.completeFunctionParens setting. If used for Jedi, setting this to false would address the original issue report specifically.

I do see, though, that the Python settings reference says:

The language server settings apply when python.languageServer is Pylance or Default.

@luabud would you be open to using the python.analysis.completeFunctionParens setting for Jedi as well? Or is the python.analysis setting namespace considered completely off-limits to other language servers, and would something like python.jediCompleteFunctionParens or python.jediSnippetsEnabled make more sense?

I'd be happy to contribute either way. Thanks.

[luabud]

Hey @br3ndonland! Thanks for being up to contributing 😊 I want to talk to the team about this a bit more as we don't have any jedi specific settings anymore, and the python.analysis.completeFunctionParens one is defined in Pylance's side, not the Python extension. But a lot of folks are out on vacation until the new year, so this may take some time 😓 as soon as everyone's back I will talk to them and get back to you, though!

[br3ndonland]

Sounds good, thanks! Happy Holidays!

[r-owen]

It would probably be simplest to just turn this off. When it doubt, don't add additional stuff the user might not want.

But if you can figure out a way to make it a setting, that'd be fine. I really like luabud's idea of only adding the extra text when the user asks for it. That would make the extra intelligence more useful and less intrusive.

[brettcannon]

We talked this over and we don't want to complicate our Jedi support by adding a new feature. But we are willing to change the hard-coded setting to turn off snippets in Jedi if that's what people want.

As such, we are going to ask you all and the community to vote on what you want the setting to be. We are going to give the community 60 days to provide 👍 upvotes on the opening comment to gauge general interest in this idea of changing the default (and 👎 if people want to keep the current setting). If there's enough upvotes then we will consider this feature request in our future planning. If there's unfortunately not enough upvotes then we will close this issue and keep the current setting.

[brettcannon]

Since there were no downvotes we will keep this issue around as something we would be willing to discuss how to implement.

[bulatb]

It looks like Jedi has this behavior disabled by default, which makes sense: it's guaranteed to be wrong at least some of the time, in practice pretty often, and it can't be worked around with muscle memory because its correctness depends on the context. Inconsistent unwanted behavior is the worst UX.

When bracket completion is off, completions are always correct but sometimes less convenient than possible. In all those cases you already know you're typing a call, so typing ( completes to (|) and gets you most of the convenience back. Never adding brackets never makes you think; always adding brackets always does.

If customizing Jedi settings isn't on the table, I vote to turn this feature off.

[jpkemp]

No resolution on this yet? Just came back to coding after a few months break, and it's really irritating not being able to disable this. Happy to help out if needed

[karthiknadig]

@jpkemp If you want to change the default it is here: https://github.com/microsoft/vscode-python/blob/main/src/client/activation/jedi/analysisOptions.ts#L62

[GalaxySnail]

According to the information in pappasam/jedi-language-server#124, I'm using this patch as a workaround:

--- jedi_language_server/jedi_utils.py.bak-20211025     2021-10-23 08:04:41.975473600 +0000
+++ jedi_language_server/jedi_utils.py  2021-10-24 16:57:31.162533100 +0000
@@ -297,26 +297,7 @@

 def get_snippet_signature(signature: Signature) -> str:
     """Return the snippet signature."""
-    params: List[ParamName] = signature.params
-    if not params:
-        return "()$0"
-    signature_list = []
-    count = 1
-    for param in params:
-        param_name = param.name
-        if param_name in _PARAM_NAME_IGNORE:
-            continue
-        if param.kind in _POSITION_PARAMETERS:
-            param_str = param.to_string()
-            if "=" in param_str:  # hacky default argument check
-                break
-            result = "${" + f"{count}:{param_name}" + "}"
-            signature_list.append(result)
-            count += 1
-            continue
-    if not signature_list:
-        return "($0)"
-    return "(" + ", ".join(signature_list) + ")$0"
+    return ""


 def is_import(script_: Script, line: int, column: int) -> bool:

$ patch -i jedi_utils.py.patch ~/.vscode/extensions/ms-python.python-*/pythonFiles/lib/jedilsp/jedi_language_server/jedi_utils.py

[jpkemp]

@GalaxySnail patch works perfectly, thank you

[PeterJCLaw]

@karthiknadig would you be open to a PR which flipped the default?

[feffy380]

@GalaxySnail perhaps a simpler workaround:

sed -i 's/disableSnippets:!1/disableSnippets:!0/g' ~/.vscode/extensions/ms-python.python-*/out/client/extension.js

This flips the setting that karthiknadig mentioned.

[brettcannon]

@PeterJCLaw yep, we would be up for a PR to turn off snippets.

[br3ndonland]

Thanks @PeterJCLaw for both reporting and fixing this issue! 👏