type hints

Author: manfred-kaiser

sifter/grammar/actions.py

@@ -3,14 +3,13 @@
 
 class Actions(list):
 
-    def __init__(self, implicit_keep=False):
+    def __init__(self, implicit_keep: bool = False) -> None:
         super(Actions, self).__init__()
         self.implicit_keep = implicit_keep
 
-    def append(self, action, action_args=None):
+    def append(self, action, action_args=None) -> None:
         super(Actions, self).append((action, action_args))
-        return self
 
-    def cancel_implicit_keep(self):
+    def cancel_implicit_keep(self) -> 'Actions':
         self.implicit_keep = False
         return self

sifter/grammar/command.py

@@ -1,21 +1,26 @@
 from typing import (
-    Text
+    TYPE_CHECKING,
+    Text,
+    Optional,
+    List
 )
 
 import sifter.grammar
 from sifter.grammar.command_list import CommandList
-from sifter.grammar.rule import RuleSyntaxError
-from . import rule
+from sifter.grammar.rule import Rule, RuleSyntaxError
 import sifter.utils
 
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag
+
 __all__ = ('Command',)
 
 
-class Command(rule.Rule):
+class Command(Rule):
 
     RULE_TYPE: Text = 'command'
 
-    def __init__(self, arguments=None, tests=None, block=None) -> None:
+    def __init__(self, arguments: Optional[List['Tag']] = None, tests=None, block=None) -> None:
         super(Command, self).__init__(arguments, tests)
         if block is None:
             self.block = CommandList()

sifter/grammar/command_list.py

@@ -1,20 +1,26 @@
+from email.message import Message
+from typing import (
+    Text
+)
+
 from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
 
 __all__ = ('CommandList',)
 
 
 class CommandList(object):
 
-    def __init__(self, command_list=None):
+    def __init__(self, command_list=None) -> None:
         if command_list is None:
             self.commands = []
         else:
             self.commands = command_list
 
-    def __str__(self):
+    def __str__(self) -> Text:
         return ''.join(cmd.__str__() for cmd in self.commands)
 
-    def evaluate(self, message, state=None):
+    def evaluate(self, message: Message, state: EvaluationState = None) -> Actions:
         if state is None:
             state = EvaluationState()
         for command in self.commands:

sifter/grammar/rule.py

@@ -9,6 +9,7 @@
 )
 
 from sifter.grammar.tag import Tag
+from sifter.grammar.string import String
 from sifter.grammar.state import EvaluationState
 from sifter.grammar.validator import Validator
 import sifter.grammar
@@ -36,7 +37,10 @@ def register(cls) -> None:
             # only on subclasses that implement specific rules
             raise NotImplementedError
 
-    def __init__(self, arguments: Optional[List[Any]] = None, tests: Optional[List[Any]] = None) -> None:
+    def __init__(self, arguments: Optional[List[Tag]] = None, tests: Optional[List[Any]] = None) -> None:
+        if arguments:
+            print(arguments)
+            print([type(x) for x in arguments])
         if arguments is None:
             self.arguments = []
         else:

sifter/tests/size.py

@@ -1,5 +1,11 @@
 import operator
 from email.message import Message
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Text
+)
 
 from sifter.grammar.test import Test
 from sifter.validators.tag import Tag
@@ -14,7 +20,7 @@ class TestSize(Test):
 
     RULE_IDENTIFIER = 'SIZE'
 
-    COMPARISON_FNS = {
+    COMPARISON_FNS: Dict[Text, Callable[[Any, Any], bool]] = {
         'OVER': operator.gt,
         'UNDER': operator.lt,
     }