Extra blank lines appear when I rename symbols

[HwangWentian]

Type: Bug

As the title suggests.
Man, what can I say?
This question has been bothering me for long.

VS Code version: Code 1.87.2 (863d2581ecda6849923a2118d93a088b0745d9d6, 2024-03-08T15:20:17.278Z)
OS version: Windows_NT x64 10.0.22631
Modes:

[vscodenpa]

Thanks for creating this issue! We figured it's missing some basic information or in some other way doesn't follow our issue reporting guidelines. Please take the time to review these and update the issue.

Happy Coding!

[HwangWentian]

Sorry for the trouble caused by not providing enough information. I am a programming amateur，so I don't know the rules. Excuse me.

VS Code version: Code 1.87.2
OS version: Windows_NT x64 10.0.22631
Extensions Installed: Python(by Microsoft), Python Debugger(by Microsoft)

Problem description

Suppose I edit the following Python3 code:

a = 123
d = 321
c = "abc"

If I choose the variable b and perform the Rename Symbol operation, it will look like this:

a = 123

d = 321

c = "abc"

As the title suggests, extra blank lines appear inexplicably. I guess it's a problem with the Python Debugger extension.

[HwangWentian]

I made a typo..The first block of code is:

a = 123
b = 321
c = "abc"

[karthiknadig]

@HwangWentian What do you have for the python.languageServer setting? if it is set to Jedi please set it to Default.

[NunUrDamBizness]

@HwangWentian What do you have for the python.languageServer setting? if it is set to Jedi please set it to Default.

[HwangWentian]

@karthiknadig @NunUrDamBizness
I confirmed that python.languageServer is set to Default.

This issue still persists. I'm not sure if the same issue exists on other platforms.

[debonte]

I confirmed that python.languageServer is set to Default.

@HwangWentian, can you also check if you have the Pylance extension installed and enabled? Default means that Pylance will be used, but only if it is installed and enabled. Otherwise Jedi is used.

When we've seen this sort of behavior in the past it was due to either:

1. Jedi was being used as the language server instead of Pylance. There's a Jedi bug that can cause extra lines to be inserted -- Renaming a module adds additional new lines pappasam/jedi-language-server#159. Also see Visual Studio Code F2 rename symbol key is adding newlines in Python vscode-python#17123.
2. Pylance was the language server, but there was another Python-related extension installed that was also handling the rename request -- see Rename symbol (F2) to rename one variable name fully mess your whole script #2367 (comment)

So if you have Pylance installed, can you please try disabling all of your extensions except Python and Pylance and see if the issue still happens?

[HwangWentian]

@debonte , I have not installed Pylance. But the problem was fixed when I installed Pylance and set it to languageServer. Thanks for the tip.