added type hints

Author: manfred-kaiser

.gitignore

@@ -5,3 +5,4 @@ parser.out
 parsetab.py
 *.pyc
 *.egg-info/
+.mypy_cache

sifter/commands/discard.py

@@ -1,4 +1,22 @@
+from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    Optional,
+    List,
+    Union,
+    SupportsInt,
+    Text
+)
+
+from sifter.grammar.actions import Actions
+from sifter.grammar.state import EvaluationState
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandDiscard',)
 
@@ -8,14 +26,15 @@ class CommandDiscard(Command):
 
     RULE_IDENTIFIER = 'DISCARD'
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandDiscard, self).__init__(arguments, tests, block)
         self.validate_arguments()
         self.validate_tests_size(0)
         self.validate_block_size(0)
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.cancel_implicit_keep()
+        return None
 
 
 CommandDiscard.register()

sifter/commands/fileinto.py

@@ -1,9 +1,23 @@
 from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
+    Union,
+    SupportsInt,
+    Text
+)
 
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
 from sifter.validators.stringlist import StringList
 from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
 
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandFileInto',)
 
@@ -13,7 +27,7 @@ class CommandFileInto(Command):
 
     RULE_IDENTIFIER = 'FILEINTO'
 
-    def __init__(self, arguments=None, tests=None, block=None) -> None:
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandFileInto, self).__init__(arguments, tests, block)
         _, positional_args = self.validate_arguments(
             {},
@@ -23,10 +37,11 @@ def __init__(self, arguments=None, tests=None, block=None) -> None:
         self.validate_block_size(0)
         self.file_dest = positional_args[0]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> None:
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.check_required_extension('fileinto', 'FILEINTO')
-        state.actions.append('fileinto', self.file_dest)
+        state.actions.append('fileinto', self.file_dest)  # type: ignore
         state.actions.cancel_implicit_keep()
+        return None
 
 
 CommandFileInto.register()

sifter/commands/if_cmd.py

@@ -1,17 +1,35 @@
+from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
+    Union,
+    SupportsInt,
+    Text
+)
+
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandIf', 'CommandElsIf', 'CommandElse',)
 
 
 # section 3.1
 class CommandIfBase(Command):
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandIfBase, self).__init__(arguments, tests, block)
         self.validate_arguments()
         self.validate_tests_size(1)
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         if self.tests[0].evaluate(message, state):
             result = self.block.evaluate(message, state)
             state.last_if = True
@@ -32,7 +50,7 @@ class CommandElsIf(CommandIfBase):
 
     RULE_IDENTIFIER = 'ELSIF'
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         if state.last_if:
             return None
         return super(CommandElsIf, self).evaluate(message, state)
@@ -45,12 +63,12 @@ class CommandElse(Command):
 
     RULE_IDENTIFIER = 'ELSE'
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandElse, self).__init__(arguments, tests, block)
         self.validate_arguments()
         self.validate_tests_size(0)
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         if state.last_if:
             return None
         return self.block.evaluate(message, state)

sifter/commands/keep.py

@@ -1,4 +1,23 @@
+from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
+    Union,
+    SupportsInt,
+    Text
+)
+
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
+
 
 __all__ = ('CommandKeep',)
 
@@ -8,14 +27,16 @@ class CommandKeep(Command):
 
     RULE_IDENTIFIER = 'KEEP'
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandKeep, self).__init__(arguments, tests, block)
         self.validate_arguments()
         self.validate_tests_size(0)
         self.validate_block_size(0)
 
-    def evaluate(self, message, state):
-        state.actions.append('keep').cancel_implicit_keep()
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+        state.actions.append('keep')
+        state.actions.cancel_implicit_keep()
+        return None
 
 
 CommandKeep.register()

sifter/commands/redirect.py

@@ -1,9 +1,25 @@
 import email.utils
+from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
+    Union,
+    SupportsInt,
+    Text
+)
 
 from sifter.grammar.command import Command
-import sifter.validators
+from sifter.grammar.command_list import CommandList
 from sifter.grammar.rule import RuleSyntaxError
 from sifter.validators.stringlist import StringList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandRedirect',)
 
@@ -13,14 +29,18 @@ class CommandRedirect(Command):
 
     RULE_IDENTIFIER = 'REDIRECT'
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandRedirect, self).__init__(arguments, tests, block)
         _, positional_args = self.validate_arguments(
             {},
             [StringList(length=1), ],
         )
         self.validate_tests_size(0)
         self.validate_block_size(0)
+        if not isinstance(positional_args, list):
+            raise ValueError("CommandRedirect positional argument error")
+        if not isinstance(positional_args[0], list):
+            raise ValueError("CommandRedirect positional argument error")
         self.email_address = positional_args[0][0]
         # TODO: section 2.4.2.3 constrains the email address to a limited
         # subset of valid address formats. need to check if python's
@@ -33,9 +53,10 @@ def __init__(self, arguments=None, tests=None, block=None):
                 % self.email_address
             )
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.append('redirect', self.email_address)
         state.actions.cancel_implicit_keep()
+        return None
 
 
 CommandRedirect.register()

sifter/commands/require.py

@@ -1,11 +1,25 @@
+from email.message import Message
 from typing import (
-    Text
+    TYPE_CHECKING,
+    Text,
+    List,
+    Optional,
+    Union,
+    SupportsInt
 )
 
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
 import sifter.grammar
 import sifter.handler
 from sifter.validators.stringlist import StringList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandRequire',)
 
@@ -15,7 +29,7 @@ class CommandRequire(Command):
 
     RULE_IDENTIFIER: Text = 'REQUIRE'
 
-    def __init__(self, arguments=None, tests=None, block=None) -> None:
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandRequire, self).__init__(arguments, tests, block)
         _, positional_args = self.validate_arguments(
             {},
@@ -25,14 +39,17 @@ def __init__(self, arguments=None, tests=None, block=None) -> None:
         self.validate_block_size(0)
         self.ext_names = positional_args[0]
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+        if not isinstance(self.ext_names, list):
+            raise ValueError("CommandRequire.ext_names must be a list!")
         for ext_name in self.ext_names:
             if not sifter.handler.get('extension', ext_name):
                 raise RuntimeError(
                     "Required extension '%s' not supported"
                     % ext_name
                 )
             state.require_extension(ext_name)
+        return None
 
 
 CommandRequire.register()

sifter/commands/stop.py

@@ -1,4 +1,22 @@
+from email.message import Message
+from typing import (
+    TYPE_CHECKING,
+    Optional,
+    List,
+    Union,
+    SupportsInt,
+    Text
+)
+
 from sifter.grammar.command import Command
+from sifter.grammar.command_list import CommandList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+if TYPE_CHECKING:
+    from sifter.grammar.tag import Tag as TagGrammar
+    from sifter.grammar.string import String
+    from sifter.grammar.test import Test
 
 __all__ = ('CommandStop',)
 
@@ -8,14 +26,15 @@ class CommandStop(Command):
 
     RULE_IDENTIFIER = 'STOP'
 
-    def __init__(self, arguments=None, tests=None, block=None):
+    def __init__(self, arguments: Optional[List[Union['TagGrammar', SupportsInt, List[Union[Text, 'String']]]]] = None, tests: Optional[List['Test']] = None, block: Optional[CommandList] = None) -> None:
         super(CommandStop, self).__init__(arguments, tests, block)
         self.validate_arguments()
         self.validate_tests_size(0)
         self.validate_block_size(0)
 
-    def evaluate(self, message, state):
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.append('stop')
+        return None
 
 
 CommandStop.register()

sifter/comparator.py

@@ -1,26 +1,28 @@
 from typing import (
     TYPE_CHECKING,
-    Any,
     Callable,
     Text,
     Optional,
     Tuple,
-    Type
+    Type,
+    Union
 )
 
 import sifter.handler
 
 if TYPE_CHECKING:
     from sifter.grammar.comparator import Comparator
+    from sifter.grammar.tag import Tag
+    from sifter.grammar.state import EvaluationState
 
 __all__ = ('register', 'get_match_fn',)
 
 
-def register(comparator_name: Text, comparator_cls: Type['Comparator']) -> None:
+def register(comparator_name: Optional[Text], comparator_cls: Type['Comparator']) -> None:
     sifter.handler.register('comparator', comparator_name, comparator_cls)
 
 
-def get_match_fn(comparator: Optional[Text], match_type: Optional[Text]) -> Tuple[Callable[[Text, Text, Any], bool], Text, Text]:  # TODO: Change Any from Callable
+def get_match_fn(comparator: Optional[Union[Text, 'Tag']], match_type: Optional[Union[Text, 'Tag']]) -> Tuple[Callable[[Text, Text, 'EvaluationState'], bool], Union[Text, 'Tag'], Union[Text, 'Tag']]:
     # section 2.7.3: default comparator is 'i;ascii-casemap'
     if comparator is None:
         comparator = 'i;ascii-casemap'