robotcode-robot 0.108.0__py3-none-any.whl → 0.109.0__py3-none-any.whl

robotcode/robot/__version__.py

@@ -1 +1 @@
-__version__ = "0.108.0"
+__version__ = "0.109.0"

robotcode/robot/diagnostics/data_cache.py

@@ -27,10 +27,20 @@ class DataCache(ABC):
     def save_cache_data(self, section: CacheSection, entry_name: str, data: Any) -> None: ...
 
 
-class JsonDataCache(DataCache):
+class FileCacheDataBase(DataCache, ABC):
     def __init__(self, cache_dir: Path) -> None:
         self.cache_dir = cache_dir
 
+        if not Path.exists(self.cache_dir):
+            Path.mkdir(self.cache_dir, parents=True)
+            Path(self.cache_dir / ".gitignore").write_text(
+                "# Created by robotcode\n*\n",
+                "utf-8",
+            )
+
+
+class JsonDataCache(FileCacheDataBase):
+
     def build_cache_data_filename(self, section: CacheSection, entry_name: str) -> Path:
         return self.cache_dir / section.value / (entry_name + ".json")
 
@@ -51,10 +61,7 @@ class JsonDataCache(DataCache):
         cached_file.write_text(as_json(data), "utf-8")
 
 
-class PickleDataCache(DataCache):
-    def __init__(self, cache_dir: Path) -> None:
-        self.cache_dir = cache_dir
-
+class PickleDataCache(FileCacheDataBase):
     def build_cache_data_filename(self, section: CacheSection, entry_name: str) -> Path:
         return self.cache_dir / section.value / (entry_name + ".pkl")
 

robotcode/robot/diagnostics/entities.py

@@ -5,6 +5,7 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Callable,
+    Generic,
     List,
     Optional,
     Tuple,
@@ -12,6 +13,8 @@ from typing import (
     cast,
 )
 
+from typing_extensions import Concatenate, ParamSpec
+
 from robot.parsing.lexer.tokens import Token
 from robotcode.core.lsp.types import Position, Range
 from robotcode.robot.utils.match import normalize
@@ -41,6 +44,39 @@ def single_call(func: _F) -> _F:
     return cast(_F, wrapper)
 
 
+P = ParamSpec("P")
+R = TypeVar("R")
+
+
+class cached_method(Generic[P, R]):  # noqa: N801
+    def __init__(
+        self, func: Optional[Callable[Concatenate[Any, P], R]] = None, *, maxsize: Optional[int] = None
+    ) -> None:
+        self.func: Optional[Callable[Concatenate[Any, P], R]] = func
+        self._maxsize = maxsize
+        self.cache_name: Optional[str] = None
+        if func is not None:
+            functools.update_wrapper(self, func)
+
+    def __set_name__(self, owner: type, name: str) -> None:
+        self.cache_name = f"__cached_{owner.__name__}_{name}"
+
+    def __call__(self, func: Callable[Concatenate[Any, P], R]) -> "cached_method[P, R]":
+        self.func = func
+        functools.update_wrapper(self, func)
+        return self
+
+    def __get__(self, instance: Any, owner: Optional[type] = None) -> Callable[P, R]:
+        cached = instance.__dict__.get(self.cache_name, _NOT_SET)
+        if cached is _NOT_SET:
+            assert self.func is not None
+
+            bound_method = self.func.__get__(instance, owner)
+            cached = functools.lru_cache(maxsize=self._maxsize)(bound_method)
+            instance.__dict__[self.cache_name] = cached
+        return cast(Callable[P, R], cached)
+
+
 @dataclass
 class SourceEntity:
     line_no: int

robotcode/robot/diagnostics/imports_manager.py

@@ -610,7 +610,8 @@ class ImportsManager:
 
     def clear_cache(self) -> None:
         if self.cache_path.exists():
-            shutil.rmtree(self.cache_path)
+            shutil.rmtree(self.cache_path, ignore_errors=True)
+
             self._logger.debug(lambda: f"Cleared cache {self.cache_path}")
 
     @_logger.call

robotcode/robot/diagnostics/library_doc.py

@@ -80,6 +80,7 @@ from .entities import (
     LibraryArgumentDefinition,
     NativeValue,
     SourceEntity,
+    cached_method,
     single_call,
 )
 
@@ -362,7 +363,8 @@ class TypeDoc:
             )
         )
 
-    def to_markdown(self, header_level: int = 2) -> str:
+    @cached_method
+    def to_markdown(self, header_level: int = 2, only_doc: bool = False) -> str:
         result = ""
 
         result += f"##{'#' * header_level} {self.name} ({self.type})\n\n"
@@ -378,19 +380,22 @@ class TypeDoc:
             else:
                 result += self.doc
 
-        if self.members:
-            result += f"\n\n###{'#' * header_level} Allowed Values:\n\n"
-            result += "- " + "\n- ".join(f"`{m.name}`" for m in self.members)
-
-        if self.items:
-            result += f"\n\n###{'#' * header_level} Dictionary Structure:\n\n"
-            result += "```\n{"
-            result += "\n ".join(f"'{m.key}': <{m.type}> {'# optional' if not m.required else ''}" for m in self.items)
-            result += "\n}\n```"
+        if not only_doc:
+            if self.members:
+                result += f"\n\n###{'#' * header_level} Allowed Values:\n\n"
+                result += "- " + "\n- ".join(f"`{m.name}`" for m in self.members)
+
+            if self.items:
+                result += f"\n\n###{'#' * header_level} Dictionary Structure:\n\n"
+                result += "```\n{"
+                result += "\n ".join(
+                    f"'{m.key}': <{m.type}> {'# optional' if not m.required else ''}" for m in self.items
+                )
+                result += "\n}\n```"
 
-        if self.accepts:
-            result += f"\n\n###{'#' * header_level} Converted Types:\n\n"
-            result += "- " + "\n- ".join(self.accepts)
+            if self.accepts:
+                result += f"\n\n###{'#' * header_level} Converted Types:\n\n"
+                result += "- " + "\n- ".join(self.accepts)
 
         return result
 
@@ -475,6 +480,7 @@ class ArgumentInfo:
     def __str__(self) -> str:
         return self.signature()
 
+    @cached_method
     def signature(self, add_types: bool = True) -> str:
         prefix = ""
         if self.kind == KeywordArgumentKind.POSITIONAL_ONLY_MARKER:
@@ -721,6 +727,7 @@ class KeywordDoc(SourceEntity):
             ),
         )
 
+    @cached_method
     def to_markdown(
         self,
         add_signature: bool = True,
@@ -796,7 +803,7 @@ class KeywordDoc(SourceEntity):
 
                 result += (
                     f"\n| `{prefix}{a.name!s}`"
-                    f'| {": " if a.types else " "}'
+                    f"| {': ' if a.types else ' '}"
                     f"{escaped_pipe.join(f'`{escape_pipe(s)}`' for s in a.types) if a.types else ''} "
                     f"| {'=' if a.default_value is not None else ''} "
                     f"| {f'`{a.default_value!s}`' if a.default_value else ''} |"
@@ -832,6 +839,7 @@ class KeywordDoc(SourceEntity):
             + ")"
         )
 
+    @cached_method
     def parameter_signature(self, full_signatures: Optional[Sequence[int]] = None) -> str:
         return (
             "("
@@ -1094,6 +1102,7 @@ class LibraryDoc:
             ),
         )
 
+    @cached_method
     def to_markdown(
         self,
         add_signature: bool = True,
@@ -1250,6 +1259,7 @@ class VariablesDoc(LibraryDoc):
 
     variables: List[ImportedVariableDefinition] = field(default_factory=list)
 
+    @cached_method
     def to_markdown(
         self,
         add_signature: bool = True,
@@ -2081,6 +2091,7 @@ def get_library_doc(
                             td.usages,
                             [EnumMember(m.name, m.value) for m in td.members] if td.members else None,
                             [TypedDictItem(i.key, i.type, i.required) for i in td.items] if td.items else None,
+                            # TODO nested types like Literals
                             libname=libdoc.name,
                             libtype=libdoc.type,
                             doc_format=libdoc.doc_format,
@@ -2453,6 +2464,7 @@ class CompleteResultKind(Enum):
     VARIABLES_MODULE = "Variables Module"
     FOLDER = "Directory"
     KEYWORD = "Keyword"
+    DOC_CACHE = "DOC_CACHE"
 
 
 class CompleteResult(NamedTuple):

{robotcode_robot-0.108.0.dist-info → robotcode_robot-0.109.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotcode-robot
-Version: 0.108.0
+Version: 0.109.0
 Summary: Support classes for RobotCode for handling Robot Framework projects.
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -26,7 +26,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Requires-Dist: platformdirs<4.4.0,>=3.2.0
-Requires-Dist: robotcode-core==0.108.0
+Requires-Dist: robotcode-core==0.109.0
 Requires-Dist: robotframework>=4.1.0
 Requires-Dist: tomli>=1.1.0; python_version < '3.11'
 Description-Content-Type: text/markdown

{robotcode_robot-0.108.0.dist-info → robotcode_robot-0.109.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 robotcode/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-robotcode/robot/__version__.py,sha256=JEOHZgUQDTlcB-baQWEy9fRq4GokkcN9OsdgKLdJmJM,24
+robotcode/robot/__version__.py,sha256=To2Wkjt2rR7FNc5nbafXdKVV4Iy6AR0OLu5SmjOkGxs,24
 robotcode/robot/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
 robotcode/robot/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 robotcode/robot/config/loader.py,sha256=qrP810HNMDpqhXopWa0dOa0Wq_zQfVctsNYKY6sLKGI,8654
 robotcode/robot/config/model.py,sha256=sgr6-4_E06g-yIXW41Z-NtIXZ_7JMmR5WvUD7kTUqu4,89106
 robotcode/robot/config/utils.py,sha256=xY-LH31BidWzonpvSrle-4HvKrp02I7IRqU2JwlL4Ls,2931
 robotcode/robot/diagnostics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-robotcode/robot/diagnostics/data_cache.py,sha256=Wge9HuxSUiBVMmrmlsYSMmG2ad7f3Texwox0Dm8lN7U,2969
+robotcode/robot/diagnostics/data_cache.py,sha256=rUh-LGkfxLYBLh3GmiJVGJi1JNP5GLiYnI1aVO0Pwqc,3187
 robotcode/robot/diagnostics/diagnostics_modifier.py,sha256=6zJdXBd6g1QM12XJbsHd8gNNysECMnWlne3q8XNgBDo,9797
 robotcode/robot/diagnostics/document_cache_helper.py,sha256=5H0S7qDCeoEmqjMLUE7EQy9iZcZTYIUl5H1Pdvn5s5I,23886
-robotcode/robot/diagnostics/entities.py,sha256=JCqwsjBZThpqiMxHzXKdnpV3z-5ndYOyF3buk4UKJrw,11695
+robotcode/robot/diagnostics/entities.py,sha256=I55YMxXpl7C1Sx6GgxRqb7vWMK7uWIoB7GhR1X9b66c,12983
 robotcode/robot/diagnostics/errors.py,sha256=RGnE4KCgNxQ58hNMBuAD3Q-qWqZVWZSZsCnhBGtQScw,1975
-robotcode/robot/diagnostics/imports_manager.py,sha256=nrvK6W1KHYbfmHRyerHbY2s-9p9uVjRoJwa7PHc8rmg,61146
+robotcode/robot/diagnostics/imports_manager.py,sha256=aJbVZ9OyhpdFMtDRMJT2orKHQc3ad3UeJ7TPycTM6GI,61167
 robotcode/robot/diagnostics/keyword_finder.py,sha256=dm4BA0ccp5V4C65CkSYUJUNXegSmvG24uu09T3eL6a4,17319
-robotcode/robot/diagnostics/library_doc.py,sha256=e8qEay6B16ZMNGZgDxtq-dhmQILCtQiPEGkNuY-24X0,99987
+robotcode/robot/diagnostics/library_doc.py,sha256=Mz4Y2w00qHTx42xZMznnMwOWn5SY2utJAciRLaqyY00,100341
 robotcode/robot/diagnostics/model_helper.py,sha256=nq78e6TQ9Anvz_VSLW560lRTKrRjBsh7NoWttEvJ2hw,30973
 robotcode/robot/diagnostics/namespace.py,sha256=oLBXJkj-JEX--OMh9hIDfzpZxKvDOwH6Sle-SZG9s-Y,78653
 robotcode/robot/diagnostics/namespace_analyzer.py,sha256=tZQOvPIsgrgLcynx_IRH4G7vXN0M_vZEtxBMC0ZMmO8,75653
@@ -26,7 +26,7 @@ robotcode/robot/utils/robot_path.py,sha256=Z-GVBOPA_xeD20bCJi4_AWaU0eQWvCym-YFty
 robotcode/robot/utils/stubs.py,sha256=umugZYAyneFNgqRJBRMJPzm0u0B_TH8Sx_y-ykXnxpw,351
 robotcode/robot/utils/variables.py,sha256=-ldL8mRRSYYW2pwlm8IpoDeQcG6LYBqaYyV_7U3xsIc,2174
 robotcode/robot/utils/visitor.py,sha256=nP3O0qh3YYuxR6S8wYJRBFfNwIVgsgohURBlrnFkRYQ,2299
-robotcode_robot-0.108.0.dist-info/METADATA,sha256=WtWBBM8Z1A7MbCtupTp6YJVC8PdnVCy1sfAZ-enm1Fs,2242
-robotcode_robot-0.108.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-robotcode_robot-0.108.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
-robotcode_robot-0.108.0.dist-info/RECORD,,
+robotcode_robot-0.109.0.dist-info/METADATA,sha256=dWkp3IGYkd68LNyCB5VRJOx42oBRunhzmmbRV9XhquI,2242
+robotcode_robot-0.109.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+robotcode_robot-0.109.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+robotcode_robot-0.109.0.dist-info/RECORD,,