Skip to content
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

Jump to bottom

PR: Reload symbols when saving a file through the Save as menu entry (Outline) #19360

Merged
merged 4 commits into from
Sep 9, 2022
Merged

PR: Reload symbols when saving a file through the Save as menu entry (Outline) #19360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
936ea5b
Outline: Clear and rebuild tree when renaming files
ccordoba12 Sep 7, 2022
25a2202
Outline: Remove unused class and test
ccordoba12 Sep 7, 2022
d2be943
Testing: Check that symbols are updated when renaming a file
ccordoba12 Sep 7, 2022
b1d1b4b
Testing: Check that the Outline can display special comments and cells
ccordoba12 Sep 9, 2022
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
83 changes: 66 additions & 17 deletions spyder/plugins/editor/widgets/tests/test_save.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

# Standard library imports
import os.path as osp
from textwrap import dedent
from unittest.mock import Mock

# Third party imports
Expand Down Expand Up @@ -297,38 +298,86 @@ def test_save_as(editor_bot, mocker):


@pytest.mark.show_save_dialog
def test_save_as_with_outline(editor_bot, mocker, tmpdir):
def test_save_as_with_outline(completions_editor, mocker, qtbot, tmpdir):
"""
Test EditorStack.save_as() when the outline explorer is not None.
Test EditorStack.save_as() when the outline explorer is active.

Regression test for spyder-ide/spyder#7754.
Regression test for issues spyder-ide/spyder#7754 and
spyder-ide/spyder#15517.
"""
editorstack, qtbot = editor_bot

# Set and assert the initial state.
editorstack.tabs.setCurrentIndex(1)
assert editorstack.get_current_filename() == 'secondtab.py'

# Add an outline explorer to the editor stack and refresh it.
editorstack.set_outlineexplorer(OutlineExplorerWidget(None, None, None))
file_path, editorstack, code_editor, completion_plugin = completions_editor
proxy = code_editor.oe_proxy

# Set outline explorer to editor stack and refresh it.
outline_explorer = OutlineExplorerWidget(None, None, None)
treewidget = outline_explorer.treewidget
outline_explorer.show()
editorstack.set_outlineexplorer(outline_explorer)
qtbot.addWidget(editorstack.outlineexplorer)
for finfo in editorstack.data:
editorstack.outlineexplorer.register_editor(finfo.editor.oe_proxy)
editorstack.outlineexplorer.register_editor(proxy)

outline_explorer.start_symbol_services('python')
editorstack.refresh()

# Add some code to the test file and save it
code = dedent("""
def foo(x):
return x

def bar(y):
return y
""")

code_editor.set_text(code)
editorstack.save(force=True)

# Notify changes
with qtbot.waitSignal(
code_editor.completions_response_signal, timeout=30000
):
code_editor.document_did_change()

# Wait until the outline is filled
qtbot.waitUntil(
lambda: len(treewidget.editor_tree_cache[proxy.get_id()]) > 0,
timeout=5000
)

# No save name.
mocker.patch.object(editorstack, 'select_savename', return_value=None)
assert editorstack.save_as() is False
assert editorstack.get_filenames() == ['foo.py', 'secondtab.py', __file__]

# Save secondtab.py as foo2.py in a tmpdir
# Save file as foo2.py in tmpdir
new_filename = osp.join(tmpdir.strpath, 'foo2.py')
editorstack.select_savename.return_value = new_filename
assert not osp.exists(new_filename)
assert editorstack.save_as() is True
assert editorstack.get_filenames() == ['foo.py', new_filename, __file__]

# Symbols should have been requested for the renamed file, which emits the
# signals below.
with qtbot.waitSignals(
[proxy.sig_start_outline_spinner,
proxy.sig_outline_explorer_data_changed],
timeout=30000
):
assert editorstack.save_as() is True

assert editorstack.get_filenames() == [new_filename]
assert osp.exists(new_filename)

# Wait until the outline is filled
qtbot.waitUntil(
lambda: len(treewidget.editor_tree_cache[proxy.get_id()]) > 0,
timeout=5000
)

# Assert root and symbol items have the right path.
items = treewidget.editor_items[proxy.get_id()]
root_item = items.node

assert root_item.path == new_filename
assert items.path == new_filename
assert all([item.path == new_filename for item in items.children])


def test_save_copy_as(editor_bot, mocker):
"""Test EditorStack.save_copy as()."""
Expand Down
3 changes: 0 additions & 3 deletions spyder/plugins/outlineexplorer/editor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@

"""Outline explorer editor server"""

# Third-party imports
from intervaltree import IntervalTree

# Local imports
from spyder.plugins.outlineexplorer.api import OutlineExplorerProxy

Expand Down
120 changes: 88 additions & 32 deletions spyder/plugins/outlineexplorer/tests/assets/text_exp_test_widgets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,106 @@
{
"text_test_widgets.py": [
{
"d": [
"functions": [
{
"inner": []
}
]
},
{
"func1": [
"d": [
{
"inner": [],
"kind": 12
}
],
"kind": 12
},
{
"i": []
}
]
},
{
"func2": []
},
{
"a": []
},
{
"b": []
},
{
"c": []
},
{
"Class1": [
"func 1 and 2": [],
"kind": 224
},
{
"__init__": [
"func1": [
{
"x": []
"i": [],
"kind": 13
}
]
],
"kind": 12
},
{
"method3": []
"func2": [],
"kind": 12
},
{
"method2": []
"other functions": [],
"kind": 224
},
{
"method1": []
"cell level 2": [
{
"a": [],
"kind": 12
},
{
"cell level 3": [
{
"b": [],
"kind": 12
},
{
"cell level 4": [
{
"c": [],
"kind": 12
}
],
"kind": 225
}
],
"kind": 225
},
{
"cell level 3-1": [
{
"func3": [],
"kind": 12
}
],
"kind": 225
}
],
"kind": 225
}
],
"kind": 225
},
{
"classes": [
{
"Class1": [
{
"__init__": [
{
"x": [],
"kind": 8
}
],
"kind": 6
},
{
"method3": [],
"kind": 6
},
{
"method2": [],
"kind": 6
},
{
"method1": [],
"kind": 6
}
],
"kind": 5
}
]
],
"kind": 225
}
]
}
Loading