robotcode-robot 0.93.1__py3-none-any.whl → 0.94.0__py3-none-any.whl

robotcode/robot/diagnostics/model_helper.py

@@ -6,7 +6,9 @@ import token as python_token
 from io import StringIO
 from tokenize import TokenError, generate_tokens
 from typing import (
+    TYPE_CHECKING,
     Any,
+    Callable,
     Iterator,
     List,
     Optional,
@@ -17,6 +19,7 @@ from typing import (
     Union,
 )
 
+from robot.errors import VariableError
 from robot.parsing.lexer.tokens import Token
 from robot.utils.escaping import split_from_equals, unescape
 from robot.variables.finders import NOT_FOUND, NumberFinder
@@ -37,13 +40,16 @@ from .entities import (
     VariableDefinition,
     VariableNotFoundDefinition,
 )
+from .keyword_finder import DEFAULT_BDD_PREFIXES
 from .library_doc import (
     ArgumentInfo,
     KeywordArgumentKind,
     KeywordDoc,
     LibraryDoc,
 )
-from .namespace import DEFAULT_BDD_PREFIXES, Namespace
+
+if TYPE_CHECKING:
+    from .namespace import Namespace
 
 
 class ModelHelper:
@@ -52,7 +58,7 @@ class ModelHelper:
         cls,
         keyword_doc: Optional[KeywordDoc],
         argument_tokens: List[Token],
-        namespace: Namespace,
+        namespace: "Namespace",
         position: Position,
     ) -> Tuple[Optional[Tuple[Optional[KeywordDoc], Token]], List[Token]]:
         if keyword_doc is None or not keyword_doc.is_any_run_keyword():
@@ -200,7 +206,7 @@ class ModelHelper:
         keyword_name: Optional[str],
         keyword_token: Token,
         argument_tokens: List[Token],
-        namespace: Namespace,
+        namespace: "Namespace",
         position: Position,
         analyse_run_keywords: bool = True,
     ) -> Optional[Tuple[Optional[KeywordDoc], Token]]:
@@ -222,7 +228,7 @@ class ModelHelper:
 
     @classmethod
     def get_namespace_info_from_keyword_token(
-        cls, namespace: Namespace, keyword_token: Token
+        cls, namespace: "Namespace", keyword_token: Token
     ) -> Tuple[Optional[LibraryEntry], Optional[str]]:
         lib_entry: Optional[LibraryEntry] = None
         kw_namespace: Optional[str] = None
@@ -243,7 +249,7 @@ class ModelHelper:
 
         return lib_entry, kw_namespace
 
-    __match_extended = re.compile(
+    match_extended = re.compile(
         r"""
     (.+?)          # base name (group 1)
     ([^\s\w].+)    # extended part (group 2)
@@ -254,7 +260,7 @@ class ModelHelper:
     @staticmethod
     def iter_expression_variables_from_token(
         expression: Token,
-        namespace: Namespace,
+        namespace: "Namespace",
         nodes: Optional[List[ast.AST]],
         position: Optional[Position] = None,
         skip_commandline_variables: bool = False,
@@ -354,27 +360,36 @@ class ModelHelper:
         ignore_errors: bool = False,
         *,
         extra_types: Optional[Set[str]] = None,
+        exception_handler: Optional[Callable[[Exception, Token], None]] = None,
     ) -> Iterator[Token]:
-        for t in tokenize_variables(token, identifiers, ignore_errors, extra_types=extra_types):
-            if t.type == Token.VARIABLE:
-                var, rest = cls.remove_index_from_variable_token(t)
-                if var is not None:
-                    yield var
-                if rest is not None:
-                    yield from cls.tokenize_variables(
-                        rest,
-                        identifiers,
-                        ignore_errors,
-                        extra_types=extra_types,
-                    )
-            else:
-                yield t
+        if exception_handler is not None:
+            ignore_errors = False
+        try:
+            for t in tokenize_variables(token, identifiers, ignore_errors, extra_types=extra_types):
+                if t.type == Token.VARIABLE:
+                    var, rest = cls.remove_index_from_variable_token(t)
+                    if var is not None:
+                        yield var
+                    if rest is not None:
+                        yield from cls.tokenize_variables(
+                            rest,
+                            identifiers,
+                            ignore_errors,
+                            extra_types=extra_types,
+                        )
+                else:
+                    yield t
+        except VariableError as e:
+            if exception_handler is not None:
+                exception_handler(e, token)
+            elif not ignore_errors:
+                raise
 
     @classmethod
     def iter_variables_from_token(
         cls,
         token: Token,
-        namespace: Namespace,
+        namespace: "Namespace",
         nodes: Optional[List[ast.AST]],
         position: Optional[Position] = None,
         skip_commandline_variables: bool = False,
@@ -413,7 +428,7 @@ class ModelHelper:
                         ):
                             yield v
                     elif base == "" and return_not_found:
-                        yield (
+                        yield (  # TODO: robotframework ignores this case, should we do the same or raise an error/hint?
                             sub_token,
                             VariableNotFoundDefinition(
                                 sub_token.lineno,
@@ -481,7 +496,7 @@ class ModelHelper:
                     and sub_token.value[1:2] == "{"
                     and sub_token.value[-1:] == "}"
                 ):
-                    match = cls.__match_extended.match(name[2:-1])
+                    match = cls.match_extended.match(name[2:-1])
                     if match is not None:
                         base_name, _ = match.groups()
                         name = f"{name[0]}{{{base_name.strip()}}}"
@@ -557,7 +572,7 @@ class ModelHelper:
     BDD_TOKEN = re.compile(r"^(Given|When|Then|And|But)$", flags=re.IGNORECASE)
 
     @classmethod
-    def split_bdd_prefix(cls, namespace: Namespace, token: Token) -> Tuple[Optional[Token], Optional[Token]]:
+    def split_bdd_prefix(cls, namespace: "Namespace", token: Token) -> Tuple[Optional[Token], Optional[Token]]:
         bdd_token = None
 
         parts = token.value.split()
@@ -590,7 +605,7 @@ class ModelHelper:
         return bdd_token, token
 
     @classmethod
-    def strip_bdd_prefix(cls, namespace: Namespace, token: Token) -> Token:
+    def strip_bdd_prefix(cls, namespace: "Namespace", token: Token) -> Token:
         if get_robot_version() < (6, 0):
             bdd_match = cls.BDD_TOKEN_REGEX.match(token.value)
             if bdd_match:
@@ -627,7 +642,7 @@ class ModelHelper:
         return token
 
     @classmethod
-    def is_bdd_token(cls, namespace: Namespace, token: Token) -> bool:
+    def is_bdd_token(cls, namespace: "Namespace", token: Token) -> bool:
         if get_robot_version() < (6, 0):
             bdd_match = cls.BDD_TOKEN.match(token.value)
             return bool(bdd_match)
@@ -651,7 +666,7 @@ class ModelHelper:
     @classmethod
     def get_keyword_definition_at_line(cls, library_doc: LibraryDoc, value: str, line: int) -> Optional[KeywordDoc]:
         return next(
-            (k for k in library_doc.keywords.get_all(value) if k.line_no == line),
+            (k for k in library_doc.keywords.iter_all(value) if k.line_no == line),
             None,
         )