Skip to content

Fix rename edits inserting before single-line files #732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
00200200 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix rename edits inserting before single-line files #732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions pylsp/plugins/jedi_rename.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,15 @@ def pylsp_rename(config, workspace, document, position, new_name):
for file_path, changed_file in changed_files.items():
uri = uris.from_fs_path(str(file_path))
doc = workspace.get_maybe_document(uri)
source = workspace.get_document(uri).source
changes.append(
{
"textDocument": {"uri": uri, "version": doc.version if doc else None},
"edits": [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {
"line": _num_lines(changed_file.get_new_code()),
"character": 0,
},
"end": _end_position(source),
},
"newText": changed_file.get_new_code(),
}
Expand All @@ -49,8 +47,9 @@ def pylsp_rename(config, workspace, document, position, new_name):
return {"documentChanges": changes}


def _num_lines(file_contents):
"Count the number of lines in the given string."
if _utils.get_eol_chars(file_contents):
return len(file_contents.splitlines())
return 0
def _end_position(file_contents):
lines = file_contents.replace("\r\n", "\n").replace("\r", "\n").split("\n")
return {
"line": len(lines) - 1,
"character": len(lines[-1].encode("utf-16-le")) // 2,
}
29 changes: 28 additions & 1 deletion test/plugins/test_jedi_rename.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

from pylsp import uris
from pylsp.plugins.jedi_rename import pylsp_rename
from pylsp.text_edit import apply_text_edits
from pylsp.workspace import Document

DOC_NAME = "test1.py"
Expand All @@ -33,6 +34,32 @@ def tmp_workspace(temp_workspace_factory):
)


@pytest.mark.parametrize(
("source", "end"),
[
("foo = 12", {"line": 0, "character": 8}),
("foo = 12\nfoo", {"line": 1, "character": 3}),
("foo = 12\r\nfoo", {"line": 1, "character": 3}),
("foo = 12\n", {"line": 1, "character": 0}),
('foo = "\U0001f600\u2028"', {"line": 0, "character": 11}),
],
)
def test_jedi_rename_replaces_entire_document(
temp_workspace_factory, config, source, end
):
workspace = temp_workspace_factory({"rename.py": source})
uri = uris.from_fs_path(os.path.join(workspace.root_path, "rename.py"))
doc = workspace.get_document(uri)

result = pylsp_rename(
config, workspace, doc, {"line": 0, "character": 0}, "renamed"
)

edits = result["documentChanges"][0]["edits"]
assert apply_text_edits(doc, edits) == source.replace("foo", "renamed")
assert edits[0]["range"]["end"] == end


def test_jedi_rename(tmp_workspace, config) -> None:
# rename the `Test1` class
position = {"line": 0, "character": 6}
Expand Down Expand Up @@ -98,7 +125,7 @@ def test_jedi_rename(tmp_workspace, config) -> None:
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 0, "character": 0},
"end": {"line": 0, "character": 8},
},
"newText": "bar = 12",
}
Expand Down