Merge pull request #26 from Mathics3/type-annotations

Add some type annotations and format strings

Author: rocky

mathics_scanner/feed.py

@@ -5,7 +5,6 @@
 """
 
 from abc import abstractmethod, ABCMeta
-from chardet import detect
 
 
 class LineFeeder(metaclass=ABCMeta):
@@ -30,39 +29,43 @@ def feed(self):
         Consume and return next line of code. Each line should be followed by a
         newline character. Returns '' after all lines are consumed.
         """
+
         return ""
 
     @abstractmethod
-    def empty(self):
+    def empty(self) -> bool:
         """
         Return True once all lines have been consumed.
         """
+
         return True
 
-    def message(self, sym: str, tag, *args):
+    def message(self, sym: str, tag: str, *args) -> None:
         """
         Append a generic message of type ``sym`` to the message queue.
         """
+
         if sym == "Syntax":
             message = self.syntax_message(sym, tag, *args)
         else:
             message = [sym, tag] + list(args)
         self.messages.append(message)
 
-    def syntax_message(self, sym: str, tag, *args):
+    def syntax_message(self, sym: str, tag: str, *args):
         """
         Append a message concerning syntax errors to the message queue.
         """
+
         if len(args) > 3:
             raise ValueError("Too many args.")
         message = [sym, tag]
         for i in range(3):
             if i < len(args):
-                message.append('"' + args[i] + '"')
+                message.append(f'"{args[i]}"')
             else:
                 message.append('""')
-        message.append(self.lineno)
-        message.append('"' + self.filename + '"')
+        message.append(str(self.lineno))
+        message.append(f'"{self.filename}"')
         assert len(message) == 7
         return message
 
@@ -97,7 +100,7 @@ def feed(self):
             result = ""
         return result
 
-    def empty(self):
+    def empty(self) -> bool:
         return self.lineno >= len(self.lines)
 
 
@@ -121,7 +124,7 @@ def feed(self):
         self.lineno += 1
         return self.code
 
-    def empty(self):
+    def empty(self) -> bool:
         return self._empty
 
 

mathics_scanner/prescanner.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 
-
 from mathics_scanner.characters import named_characters
 from mathics_scanner.errors import ScanError, IncompleteSyntaxError
 
@@ -67,11 +66,11 @@ def scan(self):
         # reduce
         return "".join(self.stubs)
 
-    def newstub(self, pos):
+    def newstub(self, pos: int) -> None:
         self.pos = pos
         self.start = pos
 
-    def try_parse_base(self, start_shift, end_shift, base):
+    def try_parse_base(self, start_shift: int, end_shift: int, base: int) -> None:
         start, end = self.pos + start_shift, self.pos + end_shift
         result = None
         if end <= len(self.code):

mathics_scanner/tokeniser.py

@@ -272,8 +272,9 @@
     literal_tokens[c] = ["Number"]
 
 
-def find_indices(literals):
+def find_indices(literals) -> dict:
     "find indices of literal tokens"
+
     literal_indices = {}
     for key, tags in literals.items():
         indices = []
@@ -282,8 +283,8 @@ def find_indices(literals):
                 if tag == tag2:
                     indices.append(i)
                     break
-        literal_indices[key] = tuple(indices)
         assert len(indices) == len(tags)
+        literal_indices[key] = tuple(indices)
     return literal_indices