added some type hints

Author: manfred-kaiser

sifter/extension.py

@@ -1,7 +1,9 @@
+from typing import Text
+
 import sifter.handler
 
 __all__ = ('register',)
 
 
-def register(extension_name):
+def register(extension_name: Text) -> None:
     sifter.handler.register('extension', extension_name, True)

sifter/grammar/comparator.py

@@ -8,7 +8,7 @@
 class Comparator(object):
 
     @classmethod
-    def register(cls):
+    def register(cls) -> None:
         try:
             sifter.comparator.register(cls.COMPARATOR_ID, cls)
         except AttributeError:

sifter/grammar/rule.py

@@ -12,7 +12,7 @@ class RuleSyntaxError(Exception):
 class Rule(object):
 
     @classmethod
-    def register(cls):
+    def register(cls) -> None:
         try:
             sifter.handler.register(cls.RULE_TYPE, cls.RULE_IDENTIFIER, cls)
         except AttributeError:

sifter/grammar/state.py

@@ -5,7 +5,7 @@
 
 class EvaluationState(object):
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.actions = sifter.grammar.Actions(implicit_keep=True)
         self.required_extensions = {}
         # section 6.1: the built-in comparators have defined capability

sifter/t/test_comparators.py

@@ -11,10 +11,10 @@ class MockComparator(sifter.grammar.Comparator):
 
 class TestMatchTypes(unittest.TestCase):
 
-    def setUp(self):
+    def setUp(self) -> None:
         MockComparator.register()
 
-    def test_unimplemented_match_type(self):
+    def test_unimplemented_match_type(self) -> None:
         self.assertRaises(
             RuntimeError,
             sifter.comparator.get_match_fn,

sifter/t/test_evaluation.py

@@ -18,7 +18,7 @@ class TestEvaluateRules(unittest.TestCase):
         ("evaluation_3.msg", "evaluation_3.rules", [('keep', None)]),
     )
 
-    def setUp(self):
+    def setUp(self) -> None:
         self.messages = {}
         self.rules = {}
         for result in self.EVAL_RESULTS:
@@ -29,7 +29,7 @@ def setUp(self):
                              encoding='utf-8') as rule_fh:
                 self.rules.setdefault(result[1], sifter.parser.parse_file(rule_fh))
 
-    def test_msg_rule_cross_product(self):
+    def test_msg_rule_cross_product(self) -> None:
         for result in self.EVAL_RESULTS:
             self.assertEqual(
                 self.rules[result[1]].evaluate(self.messages[result[0]]),

sifter/t/test_grammar.py

@@ -6,12 +6,12 @@
 
 class TestEvaluationState(unittest.TestCase):
 
-    def setUp(self):
+    def setUp(self) -> None:
         sifter.extension.register('ext1')
         sifter.extension.register('ext2')
         self.state = sifter.grammar.EvaluationState()
 
-    def test_require_extension(self):
+    def test_require_extension(self) -> None:
         self.state.require_extension('ext1')
         self.assertTrue(self.state.check_required_extension('ext1', 'ext1'))
         self.assertRaises(

sifter/t/test_parser.py

@@ -7,7 +7,7 @@
 
 class TestParseFile(unittest.TestCase):
 
-    def test_files(self):
+    def test_files(self) -> None:
         for in_filename, golden_filename in (("parser_1.in", "parser_1.out"),):
             with codecs.open(os.path.join(os.path.dirname(__file__), in_filename), encoding='utf-8') as in_fh:
                 test_output = str(sifter.parser.parse_file(in_fh))

sifter/t/test_validators.py

@@ -15,14 +15,14 @@ def __init__(self, arguments=None, tests=None):
 
 class TestValidationFn(unittest.TestCase):
 
-    def test_too_many_args(self):
+    def test_too_many_args(self) -> None:
         mock_rule = MockRule([sifter.grammar.Tag('IS'), 13, ])
         self.assertRaises(
             sifter.grammar.RuleSyntaxError,
             mock_rule.validate_arguments,
         )
 
-    def test_not_enough_args(self):
+    def test_not_enough_args(self) -> None:
         mock_rule = MockRule([13, ])
         self.assertRaises(
             sifter.grammar.RuleSyntaxError,
@@ -36,29 +36,29 @@ def test_not_enough_args(self):
 
 class TestTagValidator(unittest.TestCase):
 
-    def test_allowed_tag(self):
+    def test_allowed_tag(self) -> None:
         mock_validator = sifter.validators.Tag(['MOCK', 'IS', ])
         self.assertEqual(
             mock_validator.validate([sifter.grammar.Tag('IS')], 0),
             1
         )
 
-    def test_allowed_single_tag(self):
+    def test_allowed_single_tag(self) -> None:
         # test the case for a non-list single tag name
         mock_validator = sifter.validators.Tag('IS')
         self.assertEqual(
             mock_validator.validate([sifter.grammar.Tag('IS')], 0),
             1
         )
 
-    def test_not_allowed_tag(self):
+    def test_not_allowed_tag(self) -> None:
         mock_validator = sifter.validators.Tag(['MOCK', 'FOO', ])
         self.assertEqual(
             mock_validator.validate([sifter.grammar.Tag('IS')], 0),
             0
         )
 
-    def test_not_allowed_single_tag(self):
+    def test_not_allowed_single_tag(self) -> None:
         # test the case for a non-list single tag name. test when the tag is a
         # substring of the allowed tag.
         mock_validator = sifter.validators.Tag('ISFOO')

sifter/tests/address.py

@@ -1,4 +1,7 @@
 import email.utils
+from typing import (
+    Text
+)
 
 import sifter.grammar
 import sifter.grammar.string
@@ -10,9 +13,9 @@
 # section 5.1
 class TestAddress(sifter.grammar.Test):
 
-    RULE_IDENTIFIER = 'ADDRESS'
+    RULE_IDENTIFIER: Text = 'ADDRESS'
 
-    def __init__(self, arguments=None, tests=None):
+    def __init__(self, arguments=None, tests=None) -> None:
         super(TestAddress, self).__init__(arguments, tests)
         tagged_args, positional_args = self.validate_arguments(
             {
@@ -36,7 +39,7 @@ def __init__(self, arguments=None, tests=None):
         if 'address_part' in tagged_args:
             self.address_part = tagged_args['address_part'][0]
 
-    def evaluate(self, message, state):
+    def evaluate(self, message, state) -> bool:
         header_values = []
         for header in self.headers:
             # TODO: section 5.1: we should restrict the allowed headers to