even mor type hints

Author: manfred-kaiser

sifter/commands/redirect.py

@@ -2,6 +2,8 @@
 
 import sifter.grammar
 import sifter.validators
+from sifter.grammar.rule import RuleSyntaxError
+from sifter.validators.stringlist import StringList
 
 __all__ = ('CommandRedirect',)
 
@@ -15,7 +17,7 @@ def __init__(self, arguments=None, tests=None, block=None):
         super(CommandRedirect, self).__init__(arguments, tests, block)
         _, positional_args = self.validate_arguments(
             {},
-            [sifter.validators.StringList(length=1), ],
+            [StringList(length=1), ],
         )
         self.validate_tests_size(0)
         self.validate_block_size(0)
@@ -26,7 +28,7 @@ def __init__(self, arguments=None, tests=None, block=None):
         # parsing.
         realname, emailaddr = email.utils.parseaddr(self.email_address)
         if emailaddr == "":
-            raise sifter.grammar.RuleSyntaxError(
+            raise RuleSyntaxError(
                 "REDIRECT destination not a valid email address: %s"
                 % self.email_address
             )

sifter/commands/require.py

@@ -5,7 +5,7 @@
 from sifter.grammar.command import Command
 import sifter.grammar
 import sifter.handler
-import sifter.validators
+from sifter.validators.stringlist import StringList
 
 __all__ = ('CommandRequire',)
 
@@ -19,7 +19,7 @@ def __init__(self, arguments=None, tests=None, block=None) -> None:
         super(CommandRequire, self).__init__(arguments, tests, block)
         _, positional_args = self.validate_arguments(
             {},
-            [sifter.validators.StringList(), ],
+            [StringList(), ],
         )
         self.validate_tests_size(0)
         self.validate_block_size(0)

sifter/grammar/command.py

@@ -3,6 +3,8 @@
 )
 
 import sifter.grammar
+from sifter.grammar.command_list import CommandList
+from sifter.grammar.rule import RuleSyntaxError
 from . import rule
 import sifter.utils
 
@@ -16,7 +18,7 @@ class Command(rule.Rule):
     def __init__(self, arguments=None, tests=None, block=None) -> None:
         super(Command, self).__init__(arguments, tests)
         if block is None:
-            self.block = sifter.grammar.CommandList()
+            self.block = CommandList()
         else:
             self.block = block
 
@@ -31,6 +33,6 @@ def __str__(self) -> Text:
 
     def validate_block_size(self, max_commands: int) -> None:
         if len(self.block.commands) > max_commands:
-            raise sifter.grammar.RuleSyntaxError(
+            raise RuleSyntaxError(
                 "%s takes no more than %d commands" % (self.RULE_IDENTIFIER, max_commands)
             )

sifter/grammar/command_list.py

@@ -1,4 +1,4 @@
-import sifter.grammar
+from sifter.grammar.state import EvaluationState
 
 __all__ = ('CommandList',)
 
@@ -16,7 +16,7 @@ def __str__(self):
 
     def evaluate(self, message, state=None):
         if state is None:
-            state = sifter.grammar.EvaluationState()
+            state = EvaluationState()
         for command in self.commands:
             command.evaluate(message, state)
             # don't bother processing more commands if we hit a STOP. this

sifter/grammar/grammar.py

@@ -6,6 +6,8 @@
 import sifter.grammar
 from sifter.grammar.tag import Tag
 from sifter.grammar.lexer import tokens
+from sifter.grammar.command_list import CommandList
+from sifter.grammar.string import String
 import sifter.handler
 
 __all__ = ('parser',)
@@ -39,7 +41,7 @@ def p_commands_list(p):
 
 def p_commands_empty(p):
     """commands : """
-    p[0] = sifter.grammar.CommandList()
+    p[0] = CommandList()
 
 
 def p_command(p):
@@ -172,4 +174,4 @@ def p_stringlist_single(p):
 
 def p_string(p):
     """string : QUOTED_STRING"""
-    p[0] = sifter.grammar.String(p[1])
+    p[0] = String(p[1])

sifter/grammar/rule.py

@@ -113,5 +113,5 @@ def validate_tests_size(self, min_tests: int, max_tests: Optional[int] = None) -
             raise RuleSyntaxError("%s takes %s tests" % (
                 self.RULE_IDENTIFIER, msg))
 
-    def evaluate(self, message: Message, state: EvaluationState) -> None:
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
         raise NotImplementedError

sifter/grammar/state.py

@@ -1,15 +1,15 @@
 from typing import (
     Text
 )
-import sifter.grammar
+from sifter.grammar.actions import Actions
 
 __all__ = ('EvaluationState',)
 
 
 class EvaluationState(object):
 
     def __init__(self) -> None:
-        self.actions = sifter.grammar.Actions(implicit_keep=True)
+        self.actions = Actions(implicit_keep=True)
         self.required_extensions = {}
         # section 6.1: the built-in comparators have defined capability
         # strings, but they do not need to be explicitly REQUIRE'd before being
@@ -20,7 +20,7 @@ def __init__(self) -> None:
     def require_extension(self, extension):
         self.required_extensions[extension] = True
 
-    def check_required_extension(self, extension: Text, feature_string: Text) -> Text:
+    def check_required_extension(self, extension: Text, feature_string: Text) -> bool:
         if extension not in self.required_extensions:
             raise RuntimeError(
                 "REQUIRE '%s' must happen before %s can be used."

sifter/grammar/test.py

@@ -1,9 +1,9 @@
-from . import rule
+from sifter.grammar.rule import Rule
 
 __all__ = ('Test',)
 
 
-class Test(rule.Rule):
+class Test(Rule):
 
     RULE_TYPE = 'test'
 

sifter/tests/address.py

@@ -3,30 +3,31 @@
     Text
 )
 
-from sifter.validators.tag import Tag
+from sifter.validators.tag import Tag, Comparator, MatchType
 import sifter.grammar
+from sifter.grammar.test import Test
 import sifter.grammar.string
-import sifter.validators
+from sifter.validators.stringlist import StringList
 
 __all__ = ('TestAddress',)
 
 
 # section 5.1
-class TestAddress(sifter.grammar.Test):
+class TestAddress(Test):
 
     RULE_IDENTIFIER: Text = 'ADDRESS'
 
     def __init__(self, arguments=None, tests=None) -> None:
         super(TestAddress, self).__init__(arguments, tests)
         tagged_args, positional_args = self.validate_arguments(
             {
-                'comparator': sifter.validators.Comparator(),
-                'match_type': sifter.validators.MatchType(),
+                'comparator': Comparator(),
+                'match_type': MatchType(),
                 'address_part': Tag(('LOCALPART', 'DOMAIN', 'ALL')),
             },
             [
-                sifter.validators.StringList(),
-                sifter.validators.StringList(),
+                StringList(),
+                StringList(),
             ]
         )
         self.validate_tests_size(0)

sifter/tests/exists.py

@@ -1,5 +1,5 @@
 import sifter.grammar
-import sifter.validators
+from sifter.validators.stringlist import StringList
 
 __all__ = ('TestExists',)
 
@@ -13,7 +13,7 @@ def __init__(self, arguments=None, tests=None):
         super(TestExists, self).__init__(arguments, tests)
         tagged_args, positional_args = self.validate_arguments(
             {},
-            [sifter.validators.StringList(), ]
+            [StringList(), ]
         )
         self.validate_tests_size(0)
         self.headers = positional_args[0]