Apply suggestions from code review

Co-Authored-By: zurk <[email protected]>

Author: vmarkovtsev

lookout/core/analyzer.py

@@ -37,7 +37,7 @@ def to_pb(self) -> ApiReferencePointer:
 UnicodeFile.__doc__ = """
 UnicodeFile is an alternative to `lookout.core.api.service_data_pb2.File`.
 It is used in case `@with_unicode_data_service` decorator is applied.
-The main difference is that `content` field is a unicode string and uast offsets are changed to
+The main difference is that `content` field is a Unicode string and the node offsets are changed to
 corresponding unicode string offsets.
 """.strip()
 
@@ -46,8 +46,8 @@ def to_pb(self) -> ApiReferencePointer:
 UnicodeChange.__doc__ = """
 UnicodeFile is an alternative to `lookout.core.api.service_data_pb2.Change`.
 It is used in case `@with_unicode_data_service` decorator is applied.
-The main difference is that `base` and `head` fields have type `UnicodeFile`. For more info read
-documentation about `UnicodeFile`.
+The main difference is that `base` and `head` fields have type `UnicodeFile`. For more info refer to
+the documentation about `UnicodeFile`.
 """.strip()
 
 

lookout/core/bytes_to_unicode_converter.py

@@ -34,7 +34,7 @@ def convert_uast(self, uast: bblfsh.Node) -> bblfsh.Node:
         :param uast: corresponding UAST.
         :return: UAST with unicode positions.
         """
-        uast = bblfsh.Node.FromString(uast.SerializeToString())
+        uast = bblfsh.Node.FromString(uast.SerializeToString())  # deep copy the whole tree
         if not self._content:
             return uast
         for node in self._traverse_uast(uast):
@@ -89,7 +89,7 @@ def _build_bytes_to_str_offset_mapping(content: bytes) -> Dict[int, int]:
         return byte_to_str_offset
 
     @staticmethod
-    def _traverse_uast(uast: "bblfsh.Node"):
+    def _traverse_uast(uast: "bblfsh.Node") -> Iterator["bblfsh.Node"]:
         stack = [uast]
         while stack:
             node = stack.pop(0)

lookout/core/data_requests.py

@@ -90,7 +90,7 @@ def _get_channel(self) -> grpc.Channel:
 
 
 class UnicodeDataService(DataService):
-    """Retrieves UASTs/files from the Lookout server and converts in to unicode data."""
+    """Retrieves UASTs/files from the Lookout server and adjusts offsets for Unicode contents."""
 
     def _unicodify_changes(get_changes):
         @functools.wraps(get_changes)