feat(langserver): support for importing libraries of multiple classes from a module

Author: d-biehl

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

@@ -471,22 +471,23 @@ async def get_libdoc(self) -> VariablesDoc:
 class LibraryMetaData:
     meta_version: str
     name: Optional[str]
+    member_name: Optional[str]
     origin: Optional[str]
     submodule_search_locations: Optional[List[str]]
     by_path: bool
 
     mtimes: Optional[Dict[str, int]] = None
 
     @property
-    def filepath_base(self) -> Path:
+    def filepath_base(self) -> str:
         if self.by_path:
             if self.origin is not None:
                 p = Path(self.origin)
 
-                return Path(f"{zlib.adler32(str(p.parent).encode('utf-8')):08x}_{p.stem}")
+                return f"{zlib.adler32(str(p.parent).encode('utf-8')):08x}_{p.stem}"
         else:
             if self.name is not None:
-                return Path(self.name.replace(".", "/"))
+                return self.name.replace(".", "/") + (f".{self.member_name}" if self.member_name else "")
 
         raise ValueError("Cannot determine filepath base.")
 
@@ -832,13 +833,14 @@ async def get_library_meta(
             module_spec: Optional[ModuleSpec] = None
             if is_library_by_path(import_name):
                 if (p := Path(import_name)).exists():
-                    result = LibraryMetaData(__version__, p.stem, import_name, None, True)
+                    result = LibraryMetaData(__version__, p.stem, None, import_name, None, True)
             else:
                 module_spec = get_module_spec(import_name)
                 if module_spec is not None and module_spec.origin is not None:
                     result = LibraryMetaData(
                         __version__,
                         module_spec.name,
+                        module_spec.member_name,
                         module_spec.origin,
                         module_spec.submodule_search_locations,
                         False,
@@ -900,13 +902,14 @@ async def get_variables_meta(
             module_spec: Optional[ModuleSpec] = None
             if is_variables_by_path(import_name):
                 if (p := Path(import_name)).exists():
-                    result = LibraryMetaData(__version__, p.stem, import_name, None, True)
+                    result = LibraryMetaData(__version__, p.stem, None, import_name, None, True)
             else:
                 module_spec = get_module_spec(import_name)
                 if module_spec is not None and module_spec.origin is not None:
                     result = LibraryMetaData(
                         __version__,
                         module_spec.name,
+                        module_spec.member_name,
                         module_spec.origin,
                         module_spec.submodule_search_locations,
                         False,
@@ -1059,15 +1062,16 @@ async def _get_libdoc(name: str, args: Tuple[Any, ...], working_dir: str, base_d
             )
 
             self._logger.debug(lambda: f"Load Library {source}{args!r}")
+
             if meta is not None:
-                meta_file = Path(self.lib_doc_cache_path, meta.filepath_base.with_suffix(".meta.json"))
+                meta_file = Path(self.lib_doc_cache_path, meta.filepath_base + ".meta.json")
                 if meta_file.exists():
                     try:
                         try:
                             saved_meta = from_json(meta_file.read_text("utf-8"), LibraryMetaData)
                             spec_path = None
                             if saved_meta == meta:
-                                spec_path = Path(self.lib_doc_cache_path, meta.filepath_base.with_suffix(".spec.json"))
+                                spec_path = Path(self.lib_doc_cache_path, meta.filepath_base + ".spec.json")
                                 return from_json(
                                     spec_path.read_text("utf-8"),
                                     LibraryDoc,
@@ -1110,8 +1114,8 @@ async def _get_libdoc(name: str, args: Tuple[Any, ...], working_dir: str, base_d
                 self._logger.warning(lambda: f"stdout captured at loading library {name}{args!r}:\n{result.stdout}")
             try:
                 if meta is not None:
-                    meta_file = Path(self.lib_doc_cache_path, meta.filepath_base.with_suffix(".meta.json"))
-                    spec_file = Path(self.lib_doc_cache_path, meta.filepath_base.with_suffix(".spec.json"))
+                    meta_file = Path(self.lib_doc_cache_path, meta.filepath_base + ".meta.json")
+                    spec_file = Path(self.lib_doc_cache_path, meta.filepath_base + ".spec.json")
                     spec_file.parent.mkdir(parents=True, exist_ok=True)
 
                     try:
@@ -1202,16 +1206,14 @@ async def _get_libdoc(name: str, args: Tuple[Any, ...], working_dir: str, base_d
 
             self._logger.debug(lambda: f"Load variables {source}{args!r}")
             if meta is not None:
-                meta_file = Path(self.variables_doc_cache_path, meta.filepath_base.with_suffix(".meta.json"))
+                meta_file = Path(self.variables_doc_cache_path, meta.filepath_base + ".meta.json")
                 if meta_file.exists():
                     try:
                         try:
                             saved_meta = from_json(meta_file.read_text("utf-8"), LibraryMetaData)
                             spec_path = None
                             if saved_meta == meta:
-                                spec_path = Path(
-                                    self.variables_doc_cache_path, meta.filepath_base.with_suffix(".spec.json")
-                                )
+                                spec_path = Path(self.variables_doc_cache_path, meta.filepath_base + ".spec.json")
                                 return from_json(
                                     spec_path.read_text("utf-8"),
                                     VariablesDoc,
@@ -1255,8 +1257,8 @@ async def _get_libdoc(name: str, args: Tuple[Any, ...], working_dir: str, base_d
 
             try:
                 if meta is not None:
-                    meta_file = Path(self.variables_doc_cache_path, meta.filepath_base.with_suffix(".meta.json"))
-                    spec_file = Path(self.variables_doc_cache_path, meta.filepath_base.with_suffix(".spec.json"))
+                    meta_file = Path(self.variables_doc_cache_path, meta.filepath_base + ".meta.json")
+                    spec_file = Path(self.variables_doc_cache_path, meta.filepath_base + ".spec.json")
                     spec_file.parent.mkdir(parents=True, exist_ok=True)
 
                     try:

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

@@ -835,6 +835,7 @@ class ModuleSpec:
     name: str
     origin: Optional[str]
     submodule_search_locations: Optional[List[str]]
+    member_name: Optional[str]
 
 
 class LibraryType(Enum):
@@ -866,6 +867,7 @@ class LibraryDoc:
     _keywords: KeywordStore = field(default_factory=KeywordStore, compare=False)
     types: List[TypeDoc] = field(default_factory=list)
     module_spec: Optional[ModuleSpec] = None
+    member_name: Optional[str] = None
     errors: Optional[List[Error]] = field(default=None, compare=False)
     python_path: Optional[List[str]] = None
     stdout: Optional[str] = field(default=None, compare=False)
@@ -1149,6 +1151,7 @@ def get_module_spec(module_name: str) -> Optional[ModuleSpec]:
     import importlib.util
 
     result = None
+    member_name: Optional[str] = None
     while result is None:
         try:
             result = importlib.util.find_spec(module_name)
@@ -1160,7 +1163,9 @@ def get_module_spec(module_name: str) -> Optional[ModuleSpec]:
             splitted = module_name.rsplit(".", 1)
             if len(splitted) <= 1:
                 break
-            module_name = splitted[0]
+            module_name, m = splitted
+            if m:
+                member_name = m + "." + member_name if m and member_name is not None else m
 
     if result is not None:
         return ModuleSpec(  # type: ignore
@@ -1169,6 +1174,7 @@ def get_module_spec(module_name: str) -> Optional[ModuleSpec]:
             submodule_search_locations=list(result.submodule_search_locations)
             if result.submodule_search_locations
             else None,
+            member_name=member_name,
         )
     return None
 
@@ -1651,6 +1657,7 @@ def get_test_library(
             version=str(lib.version) if lib is not None else "",
             scope=str(lib.scope) if lib is not None else ROBOT_DEFAULT_SCOPE,
             doc_format=(str(lib.doc_format) or ROBOT_DOC_FORMAT) if lib is not None else ROBOT_DOC_FORMAT,
+            member_name=module_spec.member_name if module_spec is not None else None,
         )
 
         if lib is not None:

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

@@ -1321,6 +1321,7 @@ async def _import(
                             e
                             for e in self._libraries.values()
                             if e.library_doc.source == entry.library_doc.source
+                            and e.library_doc.member_name == entry.library_doc.member_name
                             and e.alias == entry.alias
                             and e.args == entry.args
                         ]