feat: new setting robotcode.analysis.cache.ignoredLibraries to define which libraries should never be cached

Author: d-biehl

package.json

@@ -486,6 +486,17 @@
             "default": "workspaceStorage",
             "scope": "resource"
           },
+          "robotcode.analysis.cache.ignoredLibraries": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": [
+              "Specifies the library names that should not be cached. This is useful if you have a dynamic or hybrid library that has different keywords depending on the arguments. You can specify a glob pattern that matches the library name or the source file. \n\nExamples:\n- `**/mylibfolder/mylib.py`\n- `MyLib`\n- `mylibfolder.mylib.subpackage` \n\nFor robot framework internal libraries, you have to specify the full module name like `robot.libraries.Remote`.\n\nIf you change this setting, you may need to run the command `Robot Code: Clear Cache and Restart Language Servers`."
+            ],
+            "scope": "resource"
+          },
           "robotcode.run.openOutputAfterRun": {
             "type": "string",
             "enum": [

robotcode/language_server/robotframework/configuration.py

@@ -82,6 +82,7 @@ class WorkspaceConfig(ConfigBase):
 @dataclass
 class Cache(ConfigBase):
     save_location: CacheSaveLocation = CacheSaveLocation.WORKSPACE_STORAGE
+    ignored_libraries: List[str] = field(default_factory=list)
 
 
 @config_section("robotcode.analysis")

robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -31,7 +31,7 @@
 from ....utils.async_cache import AsyncSimpleLRUCache
 from ....utils.async_tools import Lock, async_tasking_event, create_sub_task, threaded
 from ....utils.dataclasses import as_json, from_json
-from ....utils.glob_path import iter_files
+from ....utils.glob_path import Pattern, iter_files
 from ....utils.logging import LoggingDescriptor
 from ....utils.path import path_is_relative_to
 from ....utils.uri import Uri
@@ -59,7 +59,6 @@
     KeywordDoc,
     KeywordStore,
     LibraryDoc,
-    LibraryType,
     ModuleSpec,
     VariablesDoc,
     complete_library_import,
@@ -521,6 +520,8 @@ def __init__(self, parent_protocol: RobotLanguageServerProtocol, folder: Uri, co
             / "libdoc"
         )
         self.config = config
+
+        self.ignored_libraries_patters = [Pattern(s) for s in config.analysis.cache.ignored_libraries]
         self._libaries_lock = Lock()
         self._libaries: OrderedDict[_LibrariesEntryKey, _LibrariesEntry] = OrderedDict()
         self._resources_lock = Lock()
@@ -788,7 +789,18 @@ async def get_library_meta(
                         module_spec.submodule_search_locations,
                         False,
                     )
+
             if result is not None:
+                if any(
+                    (p.matches(result.name) if result.name is not None else False)
+                    or (p.matches(result.origin) if result.origin is not None else False)
+                    for p in self.ignored_libraries_patters
+                ):
+                    self._logger.critical(
+                        lambda: f"Ignore library {result.name or ''} {result.origin or ''} for caching."  # type: ignore
+                    )
+                    return None, import_name
+
                 if result.origin is not None:
                     result.mtimes = {result.origin: Path(result.origin).resolve().stat().st_mtime_ns}
 
@@ -954,7 +966,7 @@ async def _get_libdoc(name: str, args: Tuple[Any, ...], working_dir: str, base_d
                         lambda: f"stdout captured at loading library {name}{repr(args)}:\n{result.stdout}"
                     )
                 try:
-                    if meta is not None and result.library_type in [LibraryType.CLASS, LibraryType.MODULE]:
+                    if meta is not None:
                         meta_file = Path(self.lib_doc_cache_path, meta.filepath_base.with_suffix(".meta.json"))
                         meta_file.parent.mkdir(parents=True, exist_ok=True)
                         meta_file.write_text(as_json(meta), "utf-8")

tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json

@@ -13,7 +13,7 @@
         }
     },
     "robotcode.languageServer.args": [
-        "--debugpy",
+        //"--debugpy",
         // "--log",
         // "--log-all",
         // "--log-level",
@@ -32,5 +32,10 @@
     //"python.analysis.diagnosticMode": "workspace"
     //"robotcode.robot.paths": ["./tests", "./tests1"]
     "robotcode.analysis.diagnosticMode": "workspace",
-    "robotcode.analysis.progressMode": "detailed"
+    "robotcode.analysis.progressMode": "detailed",
+    "robotcode.analysis.cache.saveLocation": "workspaceFolder",
+    "robotcode.analysis.cache.ignoredLibraries": [
+        //"robot.libraries.Remote",
+        "**/lib/alibrary.py"
+    ]
 }

tests/robotcode/language_server/robotframework/parts/data/tests/remotetest.robot

@@ -1,5 +1,5 @@
 *** Settings ***
-# Library    Remote    uri=http://127.0.0.1:8270
+Library    Remote    uri=http://127.0.0.1:8270
 
 
 *** Test Cases ***