Library doc now includes type doc ie. library, resource, ...

Author: d-biehl

.vscode/launch.json

@@ -33,6 +33,18 @@
 				"port": "${input:portNumber}"
 			}
 		},
+		{
+			"name": "Python: Pytest Current File",
+			"type": "python",
+			"request": "launch",
+			"module": "pytest",
+			"args": [
+				"${file}"
+			],
+			"console": "integratedTerminal",
+			"justMyCode": false,
+			"cwd": "${workspaceFolder}",
+		},
 		{
 			"name": "Python: robotcode.debugger",
 			"type": "python",

robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -264,7 +264,10 @@ async def check_file_changed(self, changes: List[FileEvent]) -> Optional[FileCha
             return None
 
     def __close_document(self, document: TextDocument) -> None:
-        asyncio.run_coroutine_threadsafe(self.parent.parent_protocol.documents.close_document(document), self._loop)
+        if self._loop.is_running():
+            asyncio.run_coroutine_threadsafe(self.parent.parent_protocol.documents.close_document(document), self._loop)
+        else:
+            del document
 
     async def _update(self) -> None:
         self._document = await self._get_document_coroutine()

robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -241,6 +241,7 @@ class KeywordDoc(Model):
     doc_format: str = DEFAULT_DOC_FORMAT
     is_error_handler: bool = False
     error_handler_message: Optional[str] = None
+    is_initializer: bool = False
 
     @validator("doc_format")
     def doc_format_validator(cls, v: str) -> str:
@@ -269,20 +270,24 @@ def range(self) -> Range:
             ),
         )
 
-    def to_markdown(self, add_signature: bool = True) -> str:
+    def to_markdown(self, add_signature: bool = True, header_level: int = 0) -> str:
         if self.doc_format == DEFAULT_DOC_FORMAT:
-            return MarkDownFormatter().format(self.get_full_doc(add_signature))
+            return MarkDownFormatter().format(self.get_full_doc(add_signature=add_signature, header_level=header_level))
 
         return self.doc
 
-    def get_full_doc(self, add_signature: bool = True) -> str:
+    def get_full_doc(self, add_signature: bool = True, header_level: int = 0) -> str:
         if self.doc_format == DEFAULT_DOC_FORMAT:
             result = ""
 
             if add_signature:
-                result += f"\n\n=== {self.name} ===\n"
+                result += (
+                    f"\n\n={'='*header_level} "
+                    f"{'Library' if self.is_initializer else 'Keyword'} *{self.name}* "
+                    f"={'='*header_level}\n"
+                )
                 if self.args:
-                    result += "\n==== Arguments: ====\n"
+                    result += f"\n=={'='*header_level} Arguments: =={'='*header_level}\n"
                     for a in self.args:
                         result += f"\n| {str(a)}"
 
@@ -293,7 +298,7 @@ def get_full_doc(self, add_signature: bool = True) -> str:
                 if result:
                     result += "\n\n"
 
-                result += "\n==== Documentation: ====\n\n"
+                result += f"\n=={'='*header_level} Documentation: =={'='*header_level}\n\n"
 
                 result += self.doc
 
@@ -493,7 +498,7 @@ def repl(m: re.Match) -> str:  # type: ignore
     def get_full_doc(self, only_doc: bool = True) -> str:
         if self.doc_format == DEFAULT_DOC_FORMAT:
 
-            result = f"= {self.name} =\n"
+            result = f"= {(self.type[0].upper()+self.type[1:].lower()) if self.type else 'Unknown'} *{self.name}* =\n"
 
             if self.version:
                 result += f"\n| **Library Version:** | {self.version} |"
@@ -536,7 +541,7 @@ def get_full_doc(self, only_doc: bool = True) -> str:
                             result += "\n---\n"
                         first = False
 
-                        result += "\n" + kw.get_full_doc()
+                        result += "\n" + kw.get_full_doc(header_level=2)
 
             return self._process_inline_links(result)
 
@@ -1031,6 +1036,7 @@ def get_test_library(
             source=lib.source if lib is not None else source,
             module_spec=module_spec,
             python_path=sys.path,
+            type="LIBRARY",
         )
 
         if lib is not None:
@@ -1056,6 +1062,7 @@ def get_test_library(
                             libname=kw[1].libname,
                             longname=kw[1].longname,
                             doc_format=str(lib.doc_format) or DEFAULT_DOC_FORMAT,
+                            is_initializer=True,
                         )
                         for kw in [
                             (KeywordDocBuilder().build_keyword(k), k) for k in [KeywordWrapper(lib.init, source)]

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

@@ -1,7 +1,12 @@
 *** Settings ***
 Library           Collections
-#                 ^^^^^^^^^^^ library import by module name: re.match(r'.*Collections.*', value)
-Variables         ${CURDIR}/../myvariables.py
+#                 ^^^^^^^^^^^ library import by module name: re.match(r'## Library \*Collections\*.*', value)
+Library           ${CURDIR}/lib/myvariables.py
+#                               ^^^^^^^^^^^^^^ library import by path name: re.match(r'## Library \*myvariables.*', value)
+# TODO            ^^^^^^^^^  variable in library name: value == '(builtin variable) ${CURDIR}'
+Variables         ${CURDIR}/lib/myvariables.py
+Resource          ${CURDIR}/resources/firstresource.resource
+#                                     ^^^^^^^^^^^^^^ library import by path name: re.match(r'## Resource \*firstresource.*', value)
 
 *** Variables ***
 ${A VAR}          i'm a var

tests/robotcode/language_server/robotframework/parts/data/resources/firstresource.resource

@@ -0,0 +1,4 @@
+*** Keywords ***
+
+do something in a resource
+    Log    done something

tests/robotcode/language_server/robotframework/parts/test_hover.py

@@ -1,7 +1,7 @@
 import asyncio
 import re
 from pathlib import Path
-from typing import Any, AsyncGenerator, Generator, Tuple, Union, cast
+from typing import Any, AsyncGenerator, Generator, Tuple, cast
 
 import pytest
 
@@ -77,7 +77,9 @@ async def test_document(request: Any) -> AsyncGenerator[TextDocument, None]:
     data_path = Path(request.param)
     data = data_path.read_text()
 
-    document = TextDocument(document_uri=data_path.as_uri(), language_id="robotframework", version=1, text=data)
+    document = TextDocument(
+        document_uri=data_path.absolute().as_uri(), language_id="robotframework", version=1, text=data
+    )
     try:
         yield document
     finally:
@@ -113,7 +115,7 @@ def generate_tests_from_doc(path: str) -> Generator[Tuple[str, str, int, int, st
 
 @pytest.mark.parametrize(
     ("test_document", "name", "line", "character", "expression"),
-    generate_tests_from_doc(Path(Path(__file__).parent, "data/hover.robot")),
+    generate_tests_from_doc(str(Path(Path(__file__).parent, "data/hover.robot").relative_to(Path(".").absolute()))),
     indirect=["test_document"],
 )
 @pytest.mark.asyncio
@@ -129,15 +131,17 @@ async def test_hover(
         protocol.hover, test_document, Position(line=line, character=character)
     )
 
-    assert eval(
-        expression,
-        {"re": re},
-        {
-            "result": result,
-            "value": result.contents.value
-            if result is not None and isinstance(result.contents, MarkupContent)
-            else None,
-            "line": line,
-            "character": character,
-        },
+    assert bool(
+        eval(
+            expression,
+            {"re": re},
+            {
+                "result": result,
+                "value": result.contents.value
+                if result is not None and isinstance(result.contents, MarkupContent)
+                else None,
+                "line": line,
+                "character": character,
+            },
+        )
     ), expression