robotcode-robot 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

robotcode/robot/utils/variables.py

@@ -1,12 +1,165 @@
 import functools
-from typing import Optional, Tuple, cast
+from typing import Any, Optional, Tuple, cast
 
 from robot.utils.escaping import split_from_equals as robot_split_from_equals
-from robot.variables.search import VariableMatch as RobotVariableMatch
 from robot.variables.search import contains_variable as robot_contains_variable
 from robot.variables.search import is_scalar_assign as robot_is_scalar_assign
 from robot.variables.search import is_variable as robot_is_variable
 from robot.variables.search import search_variable as robot_search_variable
+from robotcode.robot.utils.match import normalize
+
+from . import get_robot_version
+
+
+class InvalidVariableError(Exception):
+    pass
+
+
+class VariableMatcher:
+    if get_robot_version() >= (7, 3):
+
+        def __init__(
+            self, string: str, identifiers: str = "$@&%", parse_type: bool = False, ignore_errors: bool = True
+        ) -> None:
+            self.string = string
+
+            self.match = robot_search_variable(
+                string, identifiers=identifiers, parse_type=parse_type, ignore_errors=ignore_errors
+            )
+
+            if not ignore_errors and self.match.base is None:
+                raise InvalidVariableError(f"Invalid variable '{string}'")
+
+            self.base = self.match.base
+            self.identifier = self.match.identifier
+            self.name = "%s{%s}" % (self.identifier, self.base.strip()) if self.base else None
+            self.type = self.match.type
+            self.items = self.match.items
+            self.start = self.match.start
+            self.end = self.match.end
+            self.after = self.match.after
+            self.before = self.match.before
+
+            self.normalized_name = normalize(self.base) if self.base else None
+
+    else:
+
+        def __init__(
+            self, string: str, identifiers: str = "$@&%", parse_type: bool = False, ignore_errors: bool = True
+        ) -> None:
+            self.string = string
+
+            self.match = robot_search_variable(string, identifiers=identifiers, ignore_errors=ignore_errors)
+
+            if not ignore_errors and self.match.base is None:
+                raise InvalidVariableError(f"Invalid variable '{string}'")
+
+            self.base = self.match.base
+            self.identifier = self.match.identifier
+            self.name = "%s{%s}" % (self.identifier, self.base.strip()) if self.base else None
+            self.type = None
+            self.items = self.match.items
+            self.start = self.match.start
+            self.end = self.match.end
+            self.after = self.match.after
+            self.before = self.match.before
+
+            self.normalized_name = normalize(self.base) if self.base else None
+
+    def __eq__(self, o: object) -> bool:
+        if self.normalized_name is None:
+            return False
+
+        if type(o) is VariableMatcher:
+            return o.normalized_name == self.normalized_name
+
+        if type(o) is str:
+            match = search_variable(o, "$@&%", ignore_errors=True)
+            base = match.base
+            if base is None:
+                return False
+
+            normalized = normalize(base)
+            return self.normalized_name == normalized
+
+        return False
+
+    def __hash__(self) -> int:
+        return hash(self.normalized_name)
+
+    def __str__(self) -> str:
+        return self.string
+
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}(name={self.string!r})"
+
+    def resolve_base(self, variables: Any, ignore_errors: bool = False) -> None:
+        self.match.resolve_base(variables, ignore_errors)
+
+    def is_variable(self) -> bool:
+        return bool(self.match.is_variable())
+
+    def is_scalar_variable(self) -> bool:
+        return bool(self.match.is_scalar_variable())
+
+    def is_list_variable(self) -> bool:
+        return bool(self.match.is_list_variable())
+
+    def is_dict_variable(self) -> bool:
+        return bool(self.match.is_dict_variable())
+
+    if get_robot_version() >= (6, 1):
+
+        def is_assign(
+            self, allow_assign_mark: bool = False, allow_nested: bool = False, allow_items: bool = False
+        ) -> bool:
+            return bool(
+                self.match.is_assign(
+                    allow_assign_mark=allow_assign_mark, allow_nested=allow_nested, allow_items=allow_items
+                )
+            )
+    else:
+
+        def is_assign(
+            self, allow_assign_mark: bool = False, allow_nested: bool = False, allow_items: bool = False
+        ) -> bool:
+            return bool(self.match.is_assign(allow_assign_mark=allow_assign_mark))
+
+    if get_robot_version() >= (6, 1):
+
+        def is_scalar_assign(self, allow_assign_mark: bool = False, allow_nested: bool = False) -> bool:
+            return bool(self.match.is_scalar_assign(allow_assign_mark=allow_assign_mark, allow_nested=allow_nested))
+    else:
+
+        def is_scalar_assign(self, allow_assign_mark: bool = False, allow_nested: bool = False) -> bool:
+            return bool(self.match.is_scalar_assign(allow_assign_mark=allow_assign_mark))
+
+    if get_robot_version() >= (6, 1):
+
+        def is_list_assign(
+            self,
+            allow_assign_mark: bool = False,
+            allow_nested: bool = False,
+        ) -> bool:
+            return bool(self.match.is_list_assign(allow_assign_mark=allow_assign_mark, allow_nested=allow_nested))
+    else:
+
+        def is_list_assign(
+            self,
+            allow_assign_mark: bool = False,
+            allow_nested: bool = False,
+        ) -> bool:
+            return bool(self.match.is_list_assign(allow_assign_mark=allow_assign_mark))
+
+    if get_robot_version() >= (6, 1):
+
+        def is_dict_assign(self, allow_assign_mark: bool = False, allow_nested: bool = False) -> bool:
+            return bool(self.match.is_dict_assign(allow_assign_mark=allow_assign_mark, allow_nested=allow_nested))
+    else:
+
+        def is_dict_assign(self, allow_assign_mark: bool = False, allow_nested: bool = False) -> bool:
+            return bool(self.match.is_dict_assign(allow_assign_mark=allow_assign_mark))
+
 
 BUILTIN_VARIABLES = [
     "${CURDIR}",
@@ -63,8 +216,10 @@ def is_variable(string: str, identifiers: str = "$@&") -> bool:
 
 
 @functools.lru_cache(maxsize=8192)
-def search_variable(string: str, identifiers: str = "$@&%*", ignore_errors: bool = False) -> RobotVariableMatch:
-    return robot_search_variable(string, identifiers, ignore_errors)
+def search_variable(
+    string: str, identifiers: str = "$@&%*", parse_type: bool = False, ignore_errors: bool = False
+) -> VariableMatcher:
+    return VariableMatcher(string, identifiers, parse_type, ignore_errors)
 
 
 @functools.lru_cache(maxsize=8192)

{robotcode_robot-1.2.0.dist-info → robotcode_robot-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotcode-robot
-Version: 1.2.0
+Version: 1.3.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==1.2.0
+Requires-Dist: robotcode-core==1.3.0
 Requires-Dist: robotframework>=4.1.0
 Requires-Dist: tomli>=1.1.0; python_version < '3.11'
 Description-Content-Type: text/markdown

robotcode_robot-1.3.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+robotcode/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robotcode/robot/__version__.py,sha256=F5mW07pSyGrqDNY2Ehr-UpDzpBtN-FsYU0QGZWf6PJE,22
+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=lN12CbUh_t0tMfMQpCi2Clcnpf8YTrh4KD1pbl6vpks,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=duLbcKzwqlCC1tBvJY8ASYh2LcIoCSs8_NgQ8NUQ7VU,3186
+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=ubjARNPP4fNGoOfv0Mm1RrbdpPfF3GC0Qn7Sz5Zeoc0,12449
+robotcode/robot/diagnostics/errors.py,sha256=irVOZIcnpf611c9BdWXWpRu2esEl6SSN0EvZjA7p3bY,2060
+robotcode/robot/diagnostics/imports_manager.py,sha256=X7ZEMaLzplrVt_880NyxFnbKlTNKpvNHWQxZeMoaQd0,61167
+robotcode/robot/diagnostics/keyword_finder.py,sha256=TRYnbliYe0LPwqzdzABZawJEafksAsZBQ3pF3zYMdaA,18763
+robotcode/robot/diagnostics/library_doc.py,sha256=Bq38jak6MK6S_J_mMyF3taPZkDKtxE0kN7aP-Ld2QPs,100780
+robotcode/robot/diagnostics/model_helper.py,sha256=RmKg1t5qsbSbW5uiehpFzJt157gDSQ1ayzXlur26AGI,31000
+robotcode/robot/diagnostics/namespace.py,sha256=dS8_1JZj-Vk-zX8JswkLJ5cKIg2J0FgEvnXRcnUCeZg,80960
+robotcode/robot/diagnostics/namespace_analyzer.py,sha256=Tv5Pje9WQkUG3LAgJER4eYhiLxXg8molmCvm0LlOro4,78849
+robotcode/robot/diagnostics/workspace_config.py,sha256=gyKR5z-HpnjxPAui3YujgeZqXX7RYBO_ErGVlk7vnGc,2689
+robotcode/robot/utils/__init__.py,sha256=HETwRb7y8SJSehSxygixKwkUGdiTKNgS4NjXVOUrUzE,361
+robotcode/robot/utils/ast.py,sha256=IdihPbvY2ERwm763mwPcDUZlS-si6AgNdF3ROqX48Pk,11417
+robotcode/robot/utils/markdownformatter.py,sha256=v2p4T-d0wc0SuUJ4iLJJg1pHjgIA6dZX4l_XnZIXjXM,11690
+robotcode/robot/utils/match.py,sha256=9tG1OD9KS1v9ocWgsERSf6z_w9gAeE5LourNUYHzvTM,653
+robotcode/robot/utils/robot_path.py,sha256=Z-GVBOPA_xeD20bCJi4_AWaU0eQWvCym-YFtyRpXARE,1767
+robotcode/robot/utils/stubs.py,sha256=umugZYAyneFNgqRJBRMJPzm0u0B_TH8Sx_y-ykXnxpw,351
+robotcode/robot/utils/variables.py,sha256=RCmBdVWtwVkB058QCBE_Bj3_28H1sXmYs0lJF9bVc0w,7644
+robotcode/robot/utils/visitor.py,sha256=nP3O0qh3YYuxR6S8wYJRBFfNwIVgsgohURBlrnFkRYQ,2299
+robotcode_robot-1.3.0.dist-info/METADATA,sha256=oZcIGZXyNKACn2QUb_QohhNobvuaHF2EQoy3itTkjBc,2238
+robotcode_robot-1.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+robotcode_robot-1.3.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+robotcode_robot-1.3.0.dist-info/RECORD,,

robotcode_robot-1.2.0.dist-info/RECORD

@@ -1,32 +0,0 @@
-robotcode/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-robotcode/robot/__version__.py,sha256=MpAT5hgNoHnTtG1XRD_GV_A7QrHVU6vJjGSw_8qMGA4,22
-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=duLbcKzwqlCC1tBvJY8ASYh2LcIoCSs8_NgQ8NUQ7VU,3186
-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=I55YMxXpl7C1Sx6GgxRqb7vWMK7uWIoB7GhR1X9b66c,12983
-robotcode/robot/diagnostics/errors.py,sha256=RGnE4KCgNxQ58hNMBuAD3Q-qWqZVWZSZsCnhBGtQScw,1975
-robotcode/robot/diagnostics/imports_manager.py,sha256=hu4Wp9b8J1jk55-NBqK2teQieWQF5D8LKxM5fyaxI1U,61156
-robotcode/robot/diagnostics/keyword_finder.py,sha256=dm4BA0ccp5V4C65CkSYUJUNXegSmvG24uu09T3eL6a4,17319
-robotcode/robot/diagnostics/library_doc.py,sha256=ruHS1bjOae0v4HQ2zH-B0baP_zs8BFa7mjsIb8tyvp4,100541
-robotcode/robot/diagnostics/model_helper.py,sha256=nq78e6TQ9Anvz_VSLW560lRTKrRjBsh7NoWttEvJ2hw,30973
-robotcode/robot/diagnostics/namespace.py,sha256=qSE-1z8U8AoE7HyY-cUMLgaEETjMB3gQr3IHLVdgFSU,78941
-robotcode/robot/diagnostics/namespace_analyzer.py,sha256=ksa9Mmexnvo8XWscm-OLqG9jd2lxetYLtmVx0KgCkj4,76047
-robotcode/robot/diagnostics/workspace_config.py,sha256=gyKR5z-HpnjxPAui3YujgeZqXX7RYBO_ErGVlk7vnGc,2689
-robotcode/robot/utils/__init__.py,sha256=OjNPMn_XSnfaMCyKd8Kmq6vlRt6mIGlzW4qiiD3ykUg,447
-robotcode/robot/utils/ast.py,sha256=m5pNr2m84lmPP4yIstq5RHjLrj0u8RsSmy6iCXBnV4g,11092
-robotcode/robot/utils/markdownformatter.py,sha256=v2p4T-d0wc0SuUJ4iLJJg1pHjgIA6dZX4l_XnZIXjXM,11690
-robotcode/robot/utils/match.py,sha256=9tG1OD9KS1v9ocWgsERSf6z_w9gAeE5LourNUYHzvTM,653
-robotcode/robot/utils/robot_path.py,sha256=Z-GVBOPA_xeD20bCJi4_AWaU0eQWvCym-YFtyRpXARE,1767
-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-1.2.0.dist-info/METADATA,sha256=Dd5RTDSIrkMDhJ9Rdm1I2imabCEtbN8T0lkOtqIK2dE,2238
-robotcode_robot-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-robotcode_robot-1.2.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
-robotcode_robot-1.2.0.dist-info/RECORD,,