extensions as entry points

manfred-kaiser · manfred-kaiser · commit cad1ad52e4a0 · 2020-09-30T09:41:45.000+02:00
diff --git a/setup.py b/setup.py
@@ -45,4 +45,31 @@
     package_data={
         "sifter": ['py.typed']
     },
+    entry_points={
+        'sifter_extensions': [
+            # sifter commands
+            'discard = sifter.commands.discard:CommandDiscard',
+            'fileinto = sifter.commands.fileinto:CommandFileInto',
+            'if = sifter.commands.if_cmd:CommandIf',
+            'elseif = sifter.commands.if_cmd:CommandElsIf',
+            'else = sifter.commands.if_cmd:CommandElse',
+            'keep = sifter.commands.keep:CommandKeep',
+            'redirect = sifter.commands.redirect:CommandRedirect',
+            'require = sifter.commands.require:CommandRequire',
+            'stop = sifter.commands.stop:CommandStop',
+            # sifter tests
+            'address = sifter.tests.address:TestAddress',
+            'allof = sifter.tests.allof:TestAllOf',
+            'anyof = sifter.tests.anyof:TestAnyOf',
+            'exists = sifter.tests.exists:TestExists',
+            'header = sifter.tests.header:TestHeader',
+            'false = sifter.tests.false:TestFalse',
+            'not_test = sifter.tests.not_test:TestNot',
+            'size = sifter.tests.size:TestSize',
+            'true = sifter.tests.true:TestTrue',
+            # sifter comparators
+            'ascii_casemap = sifter.comparators.ascii_casemap:ComparatorASCIICasemap',
+            'octed = sifter.comparators.octet:ComparatorOctet'
+        ],
+    }
 )
diff --git a/sifter/commands/discard.py b/sifter/commands/discard.py
@@ -16,6 +16,3 @@ class CommandDiscard(Command):
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.cancel_implicit_keep()
         return None
-
-
-CommandDiscard.register()
diff --git a/sifter/commands/fileinto.py b/sifter/commands/fileinto.py
@@ -22,6 +22,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
         state.actions.append('fileinto', file_dest)  # type: ignore
         state.actions.cancel_implicit_keep()
         return None
-
-
-CommandFileInto.register()
diff --git a/sifter/commands/if_cmd.py b/sifter/commands/if_cmd.py
@@ -28,9 +28,6 @@ class CommandIf(CommandIfBase):
     RULE_IDENTIFIER = 'IF'
 
 
-CommandIf.register()
-
-
 class CommandElsIf(CommandIfBase):
 
     RULE_IDENTIFIER = 'ELSIF'
@@ -41,9 +38,6 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
         return super().evaluate(message, state)
 
 
-CommandElsIf.register()
-
-
 class CommandElse(Command):
 
     RULE_IDENTIFIER = 'ELSE'
@@ -54,6 +48,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
         if state.last_if:
             return None
         return self.block.evaluate(message, state)
-
-
-CommandElse.register()
diff --git a/sifter/commands/keep.py b/sifter/commands/keep.py
@@ -18,6 +18,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
         state.actions.append('keep')
         state.actions.cancel_implicit_keep()
         return None
-
-
-CommandKeep.register()
diff --git a/sifter/commands/redirect.py b/sifter/commands/redirect.py
@@ -52,6 +52,3 @@ 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()
diff --git a/sifter/commands/require.py b/sifter/commands/require.py
@@ -28,6 +28,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
                 )
             state.require_extension(ext_name)
         return None
-
-
-CommandRequire.register()
diff --git a/sifter/commands/stop.py b/sifter/commands/stop.py
@@ -16,6 +16,3 @@ class CommandStop(Command):
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.append('stop')
         return None
-
-
-CommandStop.register()
diff --git a/sifter/comparators/ascii_casemap.py b/sifter/comparators/ascii_casemap.py
@@ -11,6 +11,3 @@ class ComparatorASCIICasemap(ComparatorOctet):
     @classmethod
     def sort_key(cls, s: Text) -> Text:
         return s.upper()
-
-
-ComparatorASCIICasemap.register()
diff --git a/sifter/comparators/octet.py b/sifter/comparators/octet.py
@@ -49,6 +49,3 @@ def cmp_matches(cls, s: Text, pattern: Text, state: EvaluationState) -> Optional
             cls.sort_key(s),
             re.MULTILINE | re.DOTALL
         )
-
-
-ComparatorOctet.register()
diff --git a/sifter/grammar/comparator.py b/sifter/grammar/comparator.py
@@ -15,6 +15,14 @@ class Comparator(object):
 
     COMPARATOR_ID: Optional[Text] = None
 
+    @classmethod
+    def get_mapkey(cls):
+        return 'comparator'
+
+    @classmethod
+    def get_identifier(cls):
+        return cls.COMPARATOR_ID
+
     @classmethod
     def register(cls) -> None:
         try:
diff --git a/sifter/grammar/rule.py b/sifter/grammar/rule.py
@@ -36,6 +36,14 @@ class Rule(object):
     TESTS_MIN: int = 0
     TESTS_MAX: Optional[int] = None
 
+    @classmethod
+    def get_mapkey(cls):
+        return cls.RULE_TYPE
+
+    @classmethod
+    def get_identifier(cls):
+        return cls.RULE_IDENTIFIER
+
     @classmethod
     def register(cls) -> None:
         try:
diff --git a/sifter/handler.py b/sifter/handler.py
@@ -6,10 +6,11 @@
     Union,
     Type
 )
+import pkg_resources
 
 if TYPE_CHECKING:
-    from sifter.grammar.comparator import Comparator
     from sifter.grammar.rule import Rule
+    from sifter.grammar.comparator import Comparator
 
 
 _HANDLERS_MAP: Dict[Text, Dict[Text, Union[bool, Type['Comparator'], Type['Rule']]]] = {}
@@ -20,9 +21,19 @@ def register(
     handler_id: Optional[Text],
     value: Union[bool, Type['Comparator'], Type['Rule']]
 ) -> None:
+    from sifter.grammar.rule import Rule
+    from sifter.grammar.comparator import Comparator
     if not handler_type or not handler_id:
         raise ValueError("handler_type and handler_id must not be None!")
-    _HANDLERS_MAP.setdefault(handler_type, {})[handler_id] = value
+    if not isinstance(value, Rule) and not (isinstance(value, type) and issubclass(value, (Rule, Comparator))):
+        print(type(value))
+        _HANDLERS_MAP.setdefault(handler_type, {})[handler_id] = value
+    else:
+        for entry_point in pkg_resources.iter_entry_points('sifter_extensions'):
+            if entry_point.name not in _HANDLERS_MAP:
+                ext_cls = entry_point.load()
+                _HANDLERS_MAP.setdefault(ext_cls.get_mapkey(), {})[ext_cls.get_identifier()] = ext_cls
+                _HANDLERS_MAP[entry_point.name] = entry_point.load()
 
 
 def unregister(handler_type: Text, handler_id: Text) -> Optional[Union[bool, Type['Comparator'], Type['Rule']]]:
diff --git a/sifter/tests/address.py b/sifter/tests/address.py
@@ -85,6 +85,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
                 ):
                     return True
         return False
-
-
-TestAddress.register()
diff --git a/sifter/tests/allof.py b/sifter/tests/allof.py
@@ -23,6 +23,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
             if not test.evaluate(message, state):
                 return False
         return True
-
-
-TestAllOf.register()
diff --git a/sifter/tests/anyof.py b/sifter/tests/anyof.py
@@ -22,6 +22,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
             if test.evaluate(message, state):
                 return True
         return False
-
-
-TestAnyOf.register()
diff --git a/sifter/tests/exists.py b/sifter/tests/exists.py
@@ -23,6 +23,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
             if header not in message:
                 return False
         return True
-
-
-TestExists.register()
diff --git a/sifter/tests/false.py b/sifter/tests/false.py
@@ -14,6 +14,3 @@ class TestFalse(Test):
 
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
         return False
-
-
-TestFalse.register()
diff --git a/sifter/tests/header.py b/sifter/tests/header.py
@@ -66,6 +66,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
                     ):
                         return True
         return False
-
-
-TestHeader.register()
diff --git a/sifter/tests/not_test.py b/sifter/tests/not_test.py
@@ -15,6 +15,3 @@ class TestNot(Test):
 
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
         return not self.tests[0].evaluate(message, state)
-
-
-TestNot.register()
diff --git a/sifter/tests/size.py b/sifter/tests/size.py
@@ -38,6 +38,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
         # number of characters
         message_size = len(message.as_string())
         return comparison_fn(message_size, comparison_size)
-
-
-TestSize.register()
diff --git a/sifter/tests/true.py b/sifter/tests/true.py
@@ -13,6 +13,3 @@ class TestTrue(Test):
 
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[bool]:
         return True
-
-
-TestTrue.register()

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions`
`28`	`28`	`)`
`29`	`29`	`state.require_extension(ext_name)`
`30`	`30`	`return None`
`31`		`-`
`32`		`-`
`33`		`-CommandRequire.register()`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,3 @@ def cmp_matches(cls, s: Text, pattern: Text, state: EvaluationState) -> Optional`
`49`	`49`	`cls.sort_key(s),`
`50`	`50`	`re.MULTILINE \| re.DOTALL`
`51`	`51`	`)`
`52`		`-`
`53`		`-`
`54`		`-ComparatorOctet.register()`