Merge branch 'develop'

Author: manfred-kaiser

.github/workflows/python-package.yml

@@ -26,8 +26,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install flake8 pytest mypy
+        pip install -U .
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
@@ -37,3 +37,6 @@ jobs:
     - name: Test with pytest
       run: |
         pytest
+    - name: Test with mypy
+      run: |
+        mypy --strict sifter

setup.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 # read the contents of your README file
 from os import path
@@ -41,18 +41,35 @@
         "Topic :: Software Development :: Interpreters",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    packages=[
-        "sifter",
-        "sifter.commands",
-        "sifter.comparators",
-        "sifter.extensions",
-        "sifter.grammar",
-        "sifter.t",
-        "sifter.tests",
-        "sifter.validators",
-    ],
+    packages=find_packages(exclude=("tests",)),
     package_data={
-        "sifter": ['py.typed'],
-        "sifter.t": ["*.in", "*.out", "*.msg", "*.rules"],
+        "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'
+        ],
+    }
 )

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()

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()

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()

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()

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()

sifter/commands/require.py

@@ -5,8 +5,7 @@
 )
 
 from sifter.grammar.command import Command
-import sifter.grammar
-import sifter.handler
+from sifter.extensions import ExtensionRegistry
 from sifter.validators.stringlist import StringList
 from sifter.grammar.state import EvaluationState
 from sifter.grammar.actions import Actions
@@ -21,13 +20,10 @@ class CommandRequire(Command):
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         ext_name_list = self.positional_args[0]
         for ext_name in ext_name_list:  # type: ignore
-            if not sifter.handler.get('extension', ext_name):
+            if not ExtensionRegistry.has_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

@@ -16,6 +16,3 @@ class CommandStop(Command):
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         state.actions.append('stop')
         return None
-
-
-CommandStop.register()

sifter/comparator.py

@@ -4,22 +4,16 @@
     Text,
     Optional,
     Tuple,
-    Type,
     Union
 )
 
-import sifter.handler
+from sifter.extensions import ExtensionRegistry
 
 if TYPE_CHECKING:
-    from sifter.grammar.comparator import Comparator
     from sifter.grammar.tag import Tag
     from sifter.grammar.state import EvaluationState
 
 
-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[Union[Text, 'Tag']],
     match_type: Optional[Union[Text, 'Tag']]
@@ -37,7 +31,7 @@ def get_match_fn(
         match_type = 'IS'
 
     # TODO: support wildcard matching in comparator names (RFC 4790)
-    cmp_handler = sifter.handler.get('comparator', comparator)
+    cmp_handler = ExtensionRegistry.get_comparator(comparator)
     if not cmp_handler:
         raise RuntimeError("Comparator not supported: %s" % comparator)