Skip to content

Commit

Permalink
Fix for unable to read map issue with CodeActions
Browse files Browse the repository at this point in the history
  • Loading branch information
@karthiknadig
karthiknadig committed Nov 8, 2022
1 parent aaf65a0 commit 1ada139
Show file tree
Hide file tree
Showing 2 changed files with 244 additions and 18 deletions.
51 changes: 33 additions & 18 deletions bundled/tool/server.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -217,27 +217,42 @@ def code_action_organize_imports(params: lsp.CodeActionParams):
kind=lsp.CodeActionKind.SourceOrganizeImports,
data=params.text_document.uri,
edit=_create_workspace_edits(text_document, results),
diagnostics=[],
)
]

diagnostics = [
d for d in params.context.diagnostics if d.source == "isort" and d.code == "E"
]
return [
lsp.CodeAction(
title="isort: Organize Imports",
kind=lsp.CodeActionKind.SourceOrganizeImports,
data=params.text_document.uri,
edit=None,
),
lsp.CodeAction(
title="isort: Fix import sorting and/or formatting",
kind=lsp.CodeActionKind.QuickFix,
data=params.text_document.uri,
edit=None,
diagnostics=diagnostics if diagnostics else None,
),
]
actions = []
if (
not params.context.only
or lsp.CodeActionKind.SourceOrganizeImports in params.context.only
):
actions.append(
lsp.CodeAction(
title="isort: Organize Imports",
kind=lsp.CodeActionKind.SourceOrganizeImports,
data=params.text_document.uri,
edit=None,
diagnostics=[],
),
)

if not params.context.only or lsp.CodeActionKind.QuickFix in params.context.only:
diagnostics = [
d
for d in params.context.diagnostics
if d.source == "isort" and d.code == "E"
]
actions.append(
lsp.CodeAction(
title="isort: Fix import sorting and/or formatting",
kind=lsp.CodeActionKind.QuickFix,
data=params.text_document.uri,
edit=None,
diagnostics=diagnostics,
),
)

return actions if actions else None


@LSP_SERVER.feature(lsp.CODE_ACTION_RESOLVE)
Expand Down
211 changes: 211 additions & 0 deletions src/test/python_tests/test_sort.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,213 @@
TIMEOUT = 10 # 10 seconds


@pytest.mark.parametrize(
"action_type",
[
"quickfix",
"source.organizeImports",
("quickfix", "source.organizeImports"),
None,
"",
],
)
def test_code_actions(action_type):
"""Test code actions."""
init_params = copy.deepcopy(defaults.VSCODE_DEFAULT_INITIALIZE)
init_params["initializationOptions"]["settings"][0]["check"] = True

FORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample1" / "sample.py"
UNFORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample1" / "sample.unformatted"

contents = UNFORMATTED_TEST_FILE_PATH.read_text()
expected = FORMATTED_TEST_FILE_PATH.read_text()

actual_diagnostics = []

with utils.python_file(contents, UNFORMATTED_TEST_FILE_PATH.parent) as pf:
uri = utils.as_uri(str(pf))

with session.LspSession() as ls_session:
ls_session.initialize(init_params)

done = Event()

def _handler(params):
nonlocal actual_diagnostics
actual_diagnostics = params
done.set()

ls_session.set_notification_callback(session.PUBLISH_DIAGNOSTICS, _handler)

ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": contents,
}
}
)

# wait for some time to receive all notifications
done.wait(TIMEOUT)

assert_that(
actual_diagnostics,
is_(
{
"uri": uri,
"diagnostics": [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 1, "character": 0},
},
"message": "Imports are incorrectly sorted and/or formatted.",
"severity": 1,
"code": "E",
"source": "isort",
}
],
}
),
)

only = None
if action_type in ("quickfix", "source.organizeImports", ""):
only = [action_type]
else:
only = action_type
actual_code_actions = ls_session.text_document_code_action(
{
"textDocument": {"uri": uri},
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 0, "character": 0},
},
"context": {
"diagnostics": [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 1, "character": 0},
},
"message": "Imports are incorrectly sorted and/or formatted.",
"severity": 1,
"code": "E",
"source": "isort",
}
],
"only": only,
},
},
)

if action_type is None or action_type == (
"quickfix",
"source.organizeImports",
):
assert_that(
actual_code_actions,
is_(
[
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": None,
"data": uri,
},
{
"title": "isort: Fix import sorting and/or formatting",
"kind": "quickfix",
"diagnostics": [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 1, "character": 0},
},
"message": "Imports are incorrectly sorted and/or formatted.",
"severity": 1,
"code": "E",
"source": "isort",
}
],
"edit": None,
"data": uri,
},
]
),
)
elif action_type == "":
assert_that(actual_code_actions, is_(None))
elif action_type == "quickfix":
assert_that(
actual_code_actions,
is_(
[
{
"title": "isort: Fix import sorting and/or formatting",
"kind": "quickfix",
"diagnostics": [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 1, "character": 0},
},
"message": "Imports are incorrectly sorted and/or formatted.",
"severity": 1,
"code": "E",
"source": "isort",
}
],
"edit": None,
"data": uri,
},
]
),
)
elif action_type == "source.organizeImports":
assert_that(
actual_code_actions,
is_(
[
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": {
"documentChanges": [
{
"textDocument": {"uri": uri, "version": 1},
"edits": [
{
"range": {
"start": {
"line": 0,
"character": 0,
},
"end": {
"line": 3,
"character": 0,
},
},
"newText": expected,
}
],
}
]
},
"data": uri,
}
]
),
)
else:
assert False, "Invalid action type"


@pytest.mark.parametrize("line_ending", ["\n", "\r\n"])
def test_organize_import(line_ending):
"""Test formatting a python file."""
Expand Down Expand Up @@ -116,6 +323,7 @@ def _handler(params):
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": None,
"data": uri,
},
Expand Down Expand Up @@ -150,6 +358,7 @@ def _handler(params):
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": {
"documentChanges": [
{
Expand Down Expand Up @@ -274,6 +483,7 @@ def _handler(params):
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": None,
"data": uri,
},
Expand Down Expand Up @@ -308,6 +518,7 @@ def _handler(params):
{
"title": "isort: Organize Imports",
"kind": "source.organizeImports",
"diagnostics": [],
"edit": {
"documentChanges": [
{
Expand Down

0 comments on commit 1ada139

Please sign in to comment.