Upgrade 'lark' dependency

Author: Scony

gdtoolkit/common/ast.py

@@ -58,7 +58,7 @@ def _load_sub_statements(self):
 
     def __repr__(self):
         return "Statement({}:{}:{})".format(
-            self.lark_node.data, self.lark_node.line, self.lark_node.column
+            self.lark_node.data, self.lark_node.meta.line, self.lark_node.meta.column
         )
 
 

gdtoolkit/common/types.py

@@ -0,0 +1,5 @@
+from typing import Union
+
+from lark import Tree, Token
+
+Node = Union[Tree, Token]

gdtoolkit/common/utils.py

@@ -3,6 +3,8 @@
 
 from lark import Tree, Token
 
+from .types import Node
+
 Path = str
 
 
@@ -35,3 +37,24 @@ def find_tree_among_children(tree_name_to_find: str, tree: Tree) -> Optional[Tre
         if isinstance(child, Tree) and child.data == tree_name_to_find:
             return child
     return None
+
+
+# TODO: remove
+def get_line(node: Node) -> int:
+    if isinstance(node, Tree):
+        return node.meta.line
+    return node.line
+
+
+# TODO: remove
+def get_end_line(node: Node) -> int:
+    if isinstance(node, Tree):
+        return node.meta.end_line
+    return node.end_line
+
+
+# TODO: remove
+def get_column(node: Node) -> int:
+    if isinstance(node, Tree):
+        return node.meta.column
+    return node.column

gdtoolkit/formatter/annotation.py

@@ -2,6 +2,7 @@
 
 from lark import Tree
 
+from ..common.utils import get_line, get_end_line
 from .types import FormattedLine, FormattedLines, Outcome
 from .context import Context, ExpressionContext
 from .expression import format_concrete_expression
@@ -56,7 +57,7 @@ def prepend_annotations_to_formatted_line(
 
 def format_standalone_annotation(annotation: Tree, context: Context) -> Outcome:
     return format_concrete_expression(
-        annotation, ExpressionContext("", annotation.line, "", -1), context
+        annotation, ExpressionContext("", get_line(annotation), "", -1), context
     )
 
 
@@ -72,8 +73,8 @@ def _annotations_have_standalone_comments(
     return any(
         comment is not None
         for comment in standalone_comments[
-            annotations[0].line : last_line
+            get_line(annotations[0]) : last_line
             if last_line is not None
-            else annotations[-1].end_line
+            else get_end_line(annotations[-1])
         ]
     )

gdtoolkit/formatter/block.py

@@ -4,6 +4,7 @@
 
 from lark import Tree
 
+from ..common.utils import get_line
 from .types import Outcome, FormattedLines
 from .context import Context
 from .constants import (
@@ -32,7 +33,7 @@ def format_block(
             if not is_first_annotation:
                 continue
         blank_lines = reconstruct_blank_lines_in_range(
-            previously_processed_line_number, statement.line, context
+            previously_processed_line_number, get_line(statement), context
         )
         if previous_statement_name is None:
             blank_lines = _remove_empty_strings_from_begin(blank_lines)

gdtoolkit/formatter/class_statement.py

@@ -3,6 +3,7 @@
 
 from lark import Tree
 
+from ..common.utils import get_line, get_end_line
 from .types import FormattedLines, Outcome
 from .context import Context, ExpressionContext
 from .block import format_block
@@ -61,27 +62,27 @@ def _format_signal_statement(statement: Tree, context: Context) -> Outcome:
         )
     expression_context = ExpressionContext(
         f"signal {statement.children[0].value}",
-        statement.line,
+        get_line(statement),
         "",
-        statement.end_line,
+        get_end_line(statement),
     )
     signal_args = statement.children[-1]
     return format_concrete_expression(signal_args, expression_context, context)
 
 
 def _format_classname_statement(statement: Tree, context: Context) -> Outcome:
-    last_processed_line_no = statement.line
+    last_processed_line_no = get_line(statement)
     formatted_lines: FormattedLines = [
         (
-            statement.line,
+            get_line(statement),
             f"{context.indent_string}class_name {statement.children[0].value}",
         )
     ]
     return (formatted_lines, last_processed_line_no)
 
 
 def _format_extends_statement(statement: Tree, context: Context) -> Outcome:
-    last_processed_line_no = statement.line
+    last_processed_line_no = get_line(statement)
     optional_attributes = (
         ""
         if len(statement.children) == 1
@@ -91,7 +92,7 @@ def _format_extends_statement(statement: Tree, context: Context) -> Outcome:
     )
     formatted_lines: FormattedLines = [
         (
-            statement.line,
+            get_line(statement),
             "{}extends {}{}".format(
                 context.indent_string,
                 expression_to_str(statement.children[0]),
@@ -103,7 +104,7 @@ def _format_extends_statement(statement: Tree, context: Context) -> Outcome:
 
 
 def _format_classname_extends_statement(statement: Tree, context: Context) -> Outcome:
-    last_processed_line_no = statement.line
+    last_processed_line_no = get_line(statement)
     extendee_pos = 2 + 1
     optional_attributes = (
         ""
@@ -119,7 +120,7 @@ def _format_classname_extends_statement(statement: Tree, context: Context) -> Ou
     )
     formatted_lines: FormattedLines = [
         (
-            statement.line,
+            get_line(statement),
             "{}class_name {} extends {}{}".format(
                 context.indent_string,
                 statement.children[1].value,
@@ -143,17 +144,19 @@ def _format_var_statement(statement: Tree, context: Context) -> Outcome:
 
 
 def _format_docstring_statement(statement: Tree, context: Context) -> Outcome:
-    expression_context = ExpressionContext("", statement.line, "", statement.end_line)
+    expression_context = ExpressionContext(
+        "", get_line(statement), "", get_end_line(statement)
+    )
     return format_concrete_expression(
         statement.children[0], expression_context, context
     )
 
 
 def _format_class_statement(statement: Tree, context: Context) -> Outcome:
-    last_processed_line_no = statement.line
+    last_processed_line_no = get_line(statement)
     name = statement.children[0].value
     formatted_lines: FormattedLines = [
-        (statement.line, f"{context.indent_string}class {name}:")
+        (get_line(statement), f"{context.indent_string}class {name}:")
     ]
     class_lines, last_processed_line_no = format_block(
         statement.children[1:],
@@ -181,9 +184,9 @@ def _format_func_header(statement: Tree, context: Context) -> Outcome:
     has_return_type = len(statement.children) > 2
     expression_context = ExpressionContext(
         f"func {name}",
-        statement.line,
+        get_line(statement),
         f" -> {statement.children[2].value}:" if has_return_type else ":",
-        statement.end_line,
+        get_end_line(statement),
     )
     func_args = statement.children[1]
     return format_concrete_expression(func_args, expression_context, context)
@@ -197,7 +200,7 @@ def _format_enum_statement(statement: Tree, context: Context) -> Outcome:
         else "enum "
     )
     expression_context = ExpressionContext(
-        prefix, statement.line, "", statement.end_line
+        prefix, get_line(statement), "", get_end_line(statement)
     )
     enum_body = actual_enum.children[-1]
     return format_concrete_expression(enum_body, expression_context, context)

gdtoolkit/formatter/comments.py

@@ -3,6 +3,7 @@
 
 from lark import Tree
 
+from ..common.utils import get_line
 from ..parser import parser
 
 
@@ -40,7 +41,7 @@ def _gather_comments_by_prefix_regex(
 ) -> List[Optional[str]]:
     """prefix means all line characters before comment"""
     line_to_comment_mapping = {
-        comment.line: comment for comment in comment_parse_tree.children
+        get_line(comment): comment for comment in comment_parse_tree.children
     }  # type: Dict[int, Tree]
     lines = gdscript_code.splitlines()
     comments = [None]  # type: List[Optional[str]]

gdtoolkit/formatter/const_statement.py

@@ -1,5 +1,6 @@
 from lark import Tree
 
+from ..common.utils import get_line, get_end_line
 from .types import Outcome
 from .context import Context, ExpressionContext
 from .expression import format_expression
@@ -15,6 +16,6 @@ def format_const_statement(statement: Tree, context: Context) -> Outcome:
             f"const {statement.children[1].value}: {statement.children[3].value} = "
         )
     expression_context = ExpressionContext(
-        prefix, statement.line, "", statement.end_line
+        prefix, get_line(statement), "", get_end_line(statement)
     )
     return format_expression(statement.children[-1], expression_context, context)