fix(langserver): correct handling of imports containing backslashes, in RobotFramework you have to escape them

Author: d-biehl

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -1454,7 +1454,7 @@ def _find_library_internal(
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
     try:
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+        name = robot_variables.replace_string(name, ignore_errors=False)
     except DataError as error:
         raise DataError(f"Replacing variables from setting 'Library' failed: {error}")
 
@@ -1518,6 +1518,7 @@ def get_library_doc(
 ) -> LibraryDoc:
     import robot.running.testlibraries
     from robot.libdocpkg.robotbuilder import KeywordDocBuilder
+    from robot.libraries import STDLIBS
     from robot.output import LOGGER
     from robot.output.loggerhelper import AbstractLogger
     from robot.running.outputcapture import OutputCapturer
@@ -1604,7 +1605,14 @@ def get_test_library(
                 python_path=sys.path,
             )
 
-        library_name = name
+        if name in STDLIBS and import_name.startswith(ROBOT_LIBRARY_PACKAGE + "."):
+            library_name = name
+        else:
+            if import_name.startswith(ROBOT_LIBRARY_PACKAGE + "."):
+                library_name = import_name[len(ROBOT_LIBRARY_PACKAGE + ".") :]
+            else:
+                library_name = import_name
+
         library_name_path = Path(import_name)
         if library_name_path.exists():
             library_name = library_name_path.stem
@@ -1821,7 +1829,7 @@ def _find_variables_internal(
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
     try:
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+        name = robot_variables.replace_string(name, ignore_errors=False)
     except DataError as error:
         raise DataError(f"Replacing variables from setting 'Variables' failed: {error}")
 
@@ -2094,7 +2102,7 @@ def find_file(
 
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
     try:
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+        name = robot_variables.replace_string(name, ignore_errors=False)
     except DataError as error:
         raise DataError(f"Replacing variables from setting '{file_type}' failed: {error}")
 
@@ -2118,7 +2126,11 @@ class CompleteResult(NamedTuple):
 
 
 def is_file_like(name: Optional[str]) -> bool:
-    return name is not None and (name.startswith((".", "/", os.sep)) or "/" in name or os.sep in name)
+    if name is None:
+        return False
+
+    base, filename = os.path.split(name)
+    return name.startswith(".") or bool(base) and filename != name
 
 
 def iter_module_names(name: Optional[str] = None) -> Iterator[str]:
@@ -2154,13 +2166,18 @@ def iter_modules_from_python_path(
 
     path = path.replace(".", os.sep) if path is not None and not path.startswith((".", "/", os.sep)) else path
 
+    needs_init = False
     if path is None:
         paths = sys.path
     else:
         paths = [str(Path(s, path)) for s in sys.path]
+        needs_init = True
 
     for e in [Path(p) for p in set(paths)]:
         if e.is_dir():
+            if needs_init and not (e / "__init__.py").is_file():
+                continue
+
             for f in e.iterdir():
                 if not f.name.startswith(("_", ".")) and (
                     f.is_file()
@@ -2199,12 +2216,14 @@ def complete_library_import(
     if name is not None:
         robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+        name = robot_variables.replace_string(name, ignore_errors=True)
+
+    file_like = is_file_like(name)
 
-    if name is None or not name.startswith((".", "/", os.sep)):
+    if name is None or not file_like:
         result += list(iter_modules_from_python_path(name))
 
-    if name is None or (is_file_like(name) and (name.endswith(("/", os.sep)))):
+    if name is None or file_like:
         name_path = Path(name if name else base_dir)
         if name_path.is_absolute():
             path = name_path
@@ -2264,7 +2283,7 @@ def complete_resource_import(
     if name is not None:
         robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+        name = robot_variables.replace_string(name, ignore_errors=True)
 
     if name is None or not name.startswith(".") and not name.startswith("/") and not name.startswith(os.sep):
         result += list(iter_resources_from_python_path(name))
@@ -2299,14 +2318,18 @@ def iter_variables_from_python_path(
 
         path = path.replace(".", os.sep) if path is not None and not path.startswith((".", "/", os.sep)) else path
 
+        needs_init = False
         if path is None:
             paths = sys.path
         else:
             paths = [str(Path(s, path)) for s in sys.path]
+            needs_init = True
 
         for e in [Path(p) for p in set(paths)]:
             if e.is_dir():
                 for f in e.iterdir():
+                    if needs_init and not (e / "__init__.py").is_file():
+                        continue
                     if not f.name.startswith(("_", ".")) and (
                         f.is_file()
                         and f.suffix in ALLOWED_VARIABLES_FILE_EXTENSIONS
@@ -2360,12 +2383,14 @@ def complete_variables_import(
     if name is not None:
         robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
-        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+        name = robot_variables.replace_string(name, ignore_errors=True)
 
-    if name is None or not name.startswith(".") and not name.startswith("/") and not name.startswith(os.sep):
+    file_like = is_file_like(name)
+
+    if name is None or not file_like:
         result += list(iter_variables_from_python_path(name))
 
-    if name is None or name.startswith((".", "/", os.sep)):
+    if name is None or file_like:
         name_path = Path(name if name else base_dir)
         if name_path.is_absolute():
             path = name_path.resolve()

packages/language_server/src/robotcode/language_server/robotframework/parts/code_action_documentation.py

@@ -412,9 +412,9 @@ async def build_url(
             variables=await namespace.get_resolvable_variables(),
         )
         try:
-            name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+            name = robot_variables.replace_string(name, ignore_errors=False)
 
-            args = tuple(robot_variables.replace_string(v.replace("\\", "\\\\"), ignore_errors=False) for v in args)
+            args = tuple(robot_variables.replace_string(v, ignore_errors=False) for v in args)
 
         except (SystemExit, KeyboardInterrupt):
             raise

packages/language_server/src/robotcode/language_server/robotframework/parts/completion.py

@@ -1520,16 +1520,36 @@ async def complete_import() -> Optional[List[CompletionItem]]:
             if text_before_position != "" and all(c == "." for c in text_before_position):
                 return None
 
+            if "/" in name_token.value or os.sep in name_token.value:
+                part_splitter = ["/", os.sep]
+            else:
+                part_splitter = ["."]
+
+            reversed_text_before_position = list(reversed(text_before_position))
             last_separator_index = (
                 len(text_before_position)
-                - next((i for i, c in enumerate(reversed(text_before_position)) if c in [".", "/", os.sep]), -1)
+                - next(
+                    (
+                        i
+                        for i, c in enumerate(reversed_text_before_position)
+                        if c in part_splitter
+                        and (
+                            c != "\\"
+                            or (
+                                c == "\\"
+                                and len(reversed_text_before_position) > i + 1
+                                and reversed_text_before_position[i + 1] == "\\"
+                            )
+                        )
+                    ),
+                    -1,
+                )
                 - 1
             )
 
             first_part = (
                 text_before_position[
-                    : last_separator_index
-                    + (1 if text_before_position[last_separator_index] in [".", "/", os.sep] else 0)
+                    : last_separator_index + (1 if text_before_position[last_separator_index] in part_splitter else 0)
                 ]
                 if last_separator_index < len(text_before_position)
                 else None
@@ -1693,9 +1713,25 @@ async def complete_ResourceImport(  # noqa: N802
         if text_before_position != "" and all(c == "." for c in text_before_position):
             return None
 
+        reversed_text_before_position = list(reversed(text_before_position))
         last_separator_index = (
             len(text_before_position)
-            - next((i for i, c in enumerate(reversed(text_before_position)) if c in ["/", os.sep]), -1)
+            - next(
+                (
+                    i
+                    for i, c in enumerate(reversed_text_before_position)
+                    if c in ["/", os.sep]
+                    and (
+                        c != "\\"
+                        or (
+                            c == "\\"
+                            and len(reversed_text_before_position) > i + 1
+                            and reversed_text_before_position[i + 1] == "\\"
+                        )
+                    )
+                ),
+                -1,
+            )
             - 1
         )
 
@@ -1795,9 +1831,30 @@ async def complete_import() -> Optional[List[CompletionItem]]:
             if text_before_position != "" and all(c == "." for c in text_before_position):
                 return None
 
+            if "/" in name_token.value or os.sep in name_token.value:
+                part_splitter = ["/", os.sep]
+            else:
+                part_splitter = ["."]
+
+            reversed_text_before_position = list(reversed(text_before_position))
             last_separator_index = (
                 len(text_before_position)
-                - next((i for i, c in enumerate(reversed(text_before_position)) if c in ["/", os.sep]), -1)
+                - next(
+                    (
+                        i
+                        for i, c in enumerate(reversed_text_before_position)
+                        if c in part_splitter
+                        and (
+                            c != "\\"
+                            or (
+                                c == "\\"
+                                and len(reversed_text_before_position) > i + 1
+                                and reversed_text_before_position[i + 1] == "\\"
+                            )
+                        )
+                    ),
+                    -1,
+                )
                 - 1
             )