feat(langserver): introduce new setting robotcode.analysis.cache.ignoreArgumentsForLibrary

This is usefull if you have library that get's variables from a python file that contains complex data like big dictionaries or complex objects that robotcode can't handle.

Author: d-biehl

package.json

@@ -666,13 +666,22 @@
             "markdownDescription": "Specifies the variable files that should not be cached. This is useful if you have a dynamic or hybrid variable files that has different variables depending on the arguments. You can specify a glob pattern that matches the variable module name or the source file. \n\nExamples:\n- `**/variables/myvars.py`\n- `MyVariables`\n- `myvars.subpackage.subpackage` \n\nIf you change this setting, you may need to run the command `RobotCode: Clear Cache and Restart Language Servers`.",
             "scope": "resource"
           },
+          "robotcode.analysis.cache.ignoreArgumentsForLibrary": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": "Specifies a list of libraries for which arguments will be ignored during analysis. This is usefull if you have library that gets variables from a python file as arguments that contains complex data like big dictionaries or complex objects that **RobotCode** can't handle. You can specify a glob pattern that matches the library name or the source file. \n\nExamples:\n- `**/mylibfolder/mylib.py`\n- `MyLib`\n- `mylib.subpackage.subpackage` \n\nIf you change this setting, you may need to run the command `RobotCode: Clear Cache and Restart Language Servers`.\n\n _Ensure your library functions correctly without arguments e.g. by defining default values for all arguments._",
+            "scope": "resource"
+          },
           "robotcode.analysis.robot.globalLibrarySearchOrder": {
             "type": "array",
             "default": [],
             "items": {
               "type": "string"
             },
-            "markdownDescription": "Specifies a global [search order](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#specifying-explicit-priority-between-libraries-and-resources) for libraries and resources. This is handy when you have libraries containing keywords with the same name. RobotCode is unable to analyze the library search order in a file specified with [`Set Library Search Order`](https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Set%20Library%20Search%20Order), so you can define a global order here. Just make sure to call the `Set Library Search Order` keyword somewhere in your robot file or internally in your library.",
+            "markdownDescription": "Specifies a global [search order](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#specifying-explicit-priority-between-libraries-and-resources) for libraries and resources. This is usefull when you have libraries containing keywords with the same name. **RobotCode** is unable to analyze the library search order in a file specified with [`Set Library Search Order`](https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Set%20Library%20Search%20Order), so you can define a global order here. Just make sure to call the `Set Library Search Order` keyword somewhere in your robot file or internally in your library.",
             "scope": "resource"
           },
           "robotcode.analysis.findUnusedReferences": {

packages/robot/src/robotcode/robot/diagnostics/document_cache_helper.py

@@ -505,6 +505,7 @@ def create_imports_manager(self, root_uri: Uri) -> ImportsManager:
             environment,
             cache_config.ignored_libraries,
             cache_config.ignored_variables,
+            cache_config.ignore_arguments_for_library,
             analysis_config.global_library_search_order,
             cache_base_path,
         )

packages/robot/src/robotcode/robot/diagnostics/imports_manager.py

@@ -496,6 +496,7 @@ def __init__(
         environment: Optional[Dict[str, str]],
         ignored_libraries: List[str],
         ignored_variables: List[str],
+        ignore_arguments_for_library: List[str],
         global_library_search_order: List[str],
         cache_base_path: Optional[Path],
     ) -> None:
@@ -538,6 +539,7 @@ def __init__(
 
         self.ignored_libraries_patters = [Pattern(s) for s in ignored_libraries]
         self.ignored_variables_patters = [Pattern(s) for s in ignored_variables]
+        self.ignore_arguments_for_library_patters = [Pattern(s) for s in ignore_arguments_for_library]
 
         self.global_library_search_order = global_library_search_order
 
@@ -864,7 +866,8 @@ def get_library_meta(
         name: str,
         base_dir: str = ".",
         variables: Optional[Dict[str, Optional[Any]]] = None,
-    ) -> Tuple[Optional[LibraryMetaData], str]:
+    ) -> Tuple[Optional[LibraryMetaData], str, bool]:
+        ignore_arguments = False
         try:
             import_name = self.find_library(name, base_dir=base_dir, variables=variables)
 
@@ -886,6 +889,12 @@ def get_library_meta(
                     )
 
             if result is not None:
+                ignore_arguments = 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.ignore_arguments_for_library_patters
+                )
+
                 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)
@@ -895,7 +904,7 @@ def get_library_meta(
                         lambda: f"Ignore library {result.name or '' if result is not None else ''}"
                         f" {result.origin or '' if result is not None else ''} for caching."
                     )
-                    return None, import_name
+                    return None, import_name, ignore_arguments
 
                 if result.origin is not None:
                     result.mtimes = {result.origin: Path(result.origin).stat().st_mtime_ns}
@@ -912,13 +921,13 @@ def get_library_meta(
                         }
                     )
 
-            return result, import_name
+            return result, import_name, ignore_arguments
         except (SystemExit, KeyboardInterrupt):
             raise
         except BaseException:
             pass
 
-        return None, import_name
+        return None, import_name, ignore_arguments
 
     def get_variables_meta(
         self,
@@ -1131,7 +1140,7 @@ def _get_library_libdoc(
         base_dir: str,
         variables: Optional[Dict[str, Any]] = None,
     ) -> LibraryDoc:
-        meta, source = self.get_library_meta(name, base_dir, variables)
+        meta, source, ignore_arguments = self.get_library_meta(name, base_dir, variables)
 
         self._logger.debug(lambda: f"Load Library {source}{args!r}")
 
@@ -1171,7 +1180,7 @@ def _get_library_libdoc(
             result = executor.submit(
                 get_library_doc,
                 name,
-                args,
+                args if not ignore_arguments else (),
                 working_dir,
                 base_dir,
                 self.get_resolvable_command_line_variables(),

packages/robot/src/robotcode/robot/diagnostics/workspace_config.py

@@ -48,6 +48,7 @@ class CacheConfig(ConfigBase):
     save_location: CacheSaveLocation = CacheSaveLocation.WORKSPACE_STORAGE
     ignored_libraries: List[str] = field(default_factory=list)
     ignored_variables: List[str] = field(default_factory=list)
+    ignore_arguments_for_library: List[str] = field(default_factory=list)
 
 
 @config_section("robotcode.analysis.robot")