Editor: Fix introducing file completions

- This correctly introduces completions for files that start with a dot
and when completions are requested at the beginning of a string.
- Expand tests to cover those cases.

Author: ccordoba12

spyder/plugins/editor/widgets/base.py

@@ -25,14 +25,16 @@
 # Local imports
 from spyder.config.gui import get_font
 from spyder.config.manager import CONF
-from spyder.py3compat import PY3, to_text_string
-from spyder.widgets.calltip import CallTipWidget, ToolTipWidget
-from spyder.widgets.mixins import BaseEditMixin
 from spyder.plugins.editor.api.decoration import TextDecoration, DRAW_ORDERS
 from spyder.plugins.editor.utils.decoration import TextDecorationsManager
 from spyder.plugins.editor.widgets.completion import CompletionWidget
+from spyder.plugins.completion.api import CompletionItemKind
 from spyder.plugins.outlineexplorer.api import is_cell_header, document_cells
+from spyder.py3compat import PY3, to_text_string
 from spyder.utils.palette import SpyderPalette
+from spyder.widgets.calltip import CallTipWidget, ToolTipWidget
+from spyder.widgets.mixins import BaseEditMixin
+
 
 class TextEditBaseWidget(QPlainTextEdit, BaseEditMixin):
     """Text edit base widget"""
@@ -941,8 +943,10 @@ def insert_completion(self, completion, completion_position):
             text = str(completion['textEdit']['newText'])
         else:
             text = completion
+            kind = None
             if isinstance(completion, dict):
                 text = completion['insertText']
+                kind = completion['kind']
             text = str(text)
 
             # Get word to the left of the cursor.
@@ -962,6 +966,20 @@ def insert_completion(self, completion, completion_position):
                     if current_text in self.auto_completion_characters:
                         is_auto_completion_character = True
 
+                # Adjustments for file completions
+                if kind == CompletionItemKind.FILE:
+                    # This is necessary to inseert file completions when
+                    # requesting them next to a colon
+                    if current_text in ['"', "'"]:
+                        current_text = ''
+                        start_position += 1
+
+                    # And this insert completions for files or directories that
+                    # start with a dot
+                    if current_text in ['".', "'."]:
+                        current_text = '.'
+                        start_position += 1
+
                 if not is_auto_completion_character:
                     # Check if the completion position is in the expected range
                     if not (
@@ -971,7 +989,10 @@ def insert_completion(self, completion, completion_position):
                     cursor.setPosition(start_position)
 
                     # Remove the word under the cursor
-                    cursor.setPosition(end_position, QTextCursor.KeepAnchor)
+                    if current_text:
+                        cursor.setPosition(
+                            end_position, QTextCursor.KeepAnchor
+                        )
                 else:
                     # Check if we are in the correct position
                     if cursor.position() != completion_position:

spyder/plugins/editor/widgets/tests/test_introspection.py

@@ -1223,34 +1223,37 @@ def test_dot_completions(completions_codeeditor, qtbot):
 
 @pytest.mark.slow
 @pytest.mark.order(1)
-def test_completions_for_files_that_start_with_numbers(
-        mock_completions_codeeditor, qtbot):
+@pytest.mark.parametrize("filename", ['000_test.txt', '.hidden', 'any_file'])
+def test_file_completions(filename, mock_completions_codeeditor, qtbot):
     """
-    Test that completions for files that start with numbers are handled as
-    expected.
+    Test that completions for files are handled as expected.
 
-    This is a regression test for issue spyder-ide/spyder#20156
+    This includes a regression test for issue spyder-ide/spyder#20156
     """
     code_editor, mock_response = mock_completions_codeeditor
     completion = code_editor.completion_widget
-    file_name = '000_testing.txt'
 
     # Set text to complete and move cursor to the position we want to ask for
     # completions.
-    qtbot.keyClicks(code_editor, "'0'")
+    if filename == 'any_file':
+        # This checks if we're able to introduce file completions as expected
+        # for any file when requesting them inside a string.
+        qtbot.keyClicks(code_editor, "''")
+    else:
+        qtbot.keyClicks(code_editor, f"'{filename[0]}'")
     code_editor.moveCursor(QTextCursor.PreviousCharacter)
     qtbot.wait(500)
 
     # Complete '0' -> '000_testing.txt'
     mock_response.side_effect = lambda lang, method, params: {'params': [{
-        'label': f'{file_name}',
+        'label': f'{filename}',
         'kind': CompletionItemKind.FILE,
-        'sortText': (0, f'a{file_name}'),
-        'insertText': f'{file_name}',
+        'sortText': (0, f'a{filename}'),
+        'insertText': f'{filename}',
         'data': {'doc_uri': path_as_uri(__file__)},
         'detail': '',
         'documentation': '',
-        'filterText': f'{file_name}',
+        'filterText': f'{filename}',
         'insertTextFormat': 1,
         'provider': 'LSP',
         'resolve': True
@@ -1261,7 +1264,7 @@ def test_completions_for_files_that_start_with_numbers(
         qtbot.keyPress(code_editor, Qt.Key_Tab, delay=300)
 
     qtbot.wait(500)
-    assert code_editor.get_text_with_eol() == f"'{file_name}'"
+    assert code_editor.get_text_with_eol() == f"'{filename}'"
 
 
 if __name__ == '__main__':