Introduced argument factory

.gitignore

+*.pyc
+*.log
+*.pkl
+*.egg-info
+Pipfile
+Pipfile.lock
+.pre-commit-config.yaml
+
+__pycache__
+.cache
+
+build
+dist
+env
+venv
+
+.idea

rcli/__init__.py

+#!/usr/bin/env python3
+
+# Copyright (C) 2020-2021:
+#   Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see http://www.gnu.org/licenses/.

rcli/building_id_argument.py → rcli/argument_base.py

@@ -17,30 +17,26 @@
 # along with this program. If not, see http://www.gnu.org/licenses/.
 
 import re
-from argparse import ArgumentParser
-
-
-def format_argument(argument):
-    """Format arguments the same way as the `argparse.ArgumentParser` does."""
-
-    # strip possible preceding dashes
-    argument = re.sub(r"^-+", "", argument)
 
-    # replace intermediate dashes with underscore
-    return re.sub(r"-", "_", argument)
+from argparse import ArgumentParser
 
 
-class BuildingIDArgument:
+class ArgumentBase:
     def __init__(self):
-        self.argument = "--building-id"
-        self.rabotnik_message = "building"
+        self.argument = None
+        self.rabotnik_message = None
+        self.help_text = None
 
     def add_argument_to_parser(self, parser: ArgumentParser):
         """Attach this instance to a `parser`."""
-        parser.add_argument(
-            self.argument, type=str, help="Single `building_id` as integer", required=True
-        )
 
-    def process_arguments(self, arguments: dict):
-        arg = format_argument(self.argument)
-        return {arg: arguments[arg]}
+        parser.add_argument(self.argument, type=str, help=self.help_text)
+
+    def get_formatted_argument(self):
+        """Format arguments the same way as the `argparse.ArgumentParser` does."""
+
+        # strip possible preceding dashes
+        formatted_argument = re.sub(r"^-+", "", self.argument)
+
+        # replace intermediate dashes with underscore
+        return re.sub(r"-", "_", formatted_argument)

rcli/argument_factory.py

+#!/usr/bin/env python3
+
+# Copyright (c) 2020-2021:
+#   Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see http://www.gnu.org/licenses/.
+
+import logging
+from argparse import ArgumentParser
+
+from .argument_base import ArgumentBase
+from .arguments.building_id import ArgumentBuildingId
+
+logger = logging.getLogger(__name__)
+
+
+class ArgumentFactory:
+    def __init__(self):
+        """Create and import argument classes based on a given selector.
+
+        Args:
+            selector (str): The name to find the associated argument handler
+        """
+
+        self.arguments = {}
+        self.add_argument(ArgumentBuildingId())
+
+    def add_to_parser(self, parser: ArgumentParser):
+
+        group = parser.add_argument_group("rabotnik arguments").add_mutually_exclusive_group(
+            required=True
+        )
+
+        for argument_object in self.arguments.values():
+            argument_object.add_argument_to_parser(group)
+
+    def add_argument(self, argument_object: ArgumentBase):
+
+        argument = argument_object.get_formatted_argument()
+        self.arguments[argument] = argument_object

tests/test_argument.py → rcli/arguments/__init__.py

@@ -15,12 +15,3 @@
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see http://www.gnu.org/licenses/.
-
-from rcli.building_id_argument import format_argument
-
-
-def test_format_argument():
-    assert format_argument("--x") == "x"
-    assert format_argument("--x-x") == "x_x"
-    assert format_argument("x-x") == "x_x"
-    assert format_argument("x_x") == "x_x"

rcli/arguments/building_id.py

+#!/usr/bin/env python3
+
+# Copyright (C) 2020-2021:
+#   Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see http://www.gnu.org/licenses/.
+
+from ..argument_base import ArgumentBase
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class ArgumentBuildingId(ArgumentBase):
+    def __init__(self):
+        self.argument = "--building-id"
+        self.rabotnik_message = "building"
+        self.help_text = "Single `building_id` as integer"
+
+    async def execute(self, message_bus, argument, value):
+
+        logger.info(f"Dispatching `{argument}` with `{value}` on `{self.rabotnik_message}`.")
+
+        await message_bus.send(message=self.rabotnik_message, payload={argument: value})

rcli/rcli.py

@@ -23,7 +23,7 @@ import logging
 
 from rabotnik.bus import MessageBus, PASSWORD, USERNAME, URL
 
-from .building_id_argument import BuildingIDArgument
+from .argument_factory import ArgumentFactory
 
 logger = logging.getLogger(__name__)
 
@@ -36,17 +36,17 @@ class RCLI:
     Args:
         parser: Creates and parses command line arguments.
     Attributes:
-        argument: A `BuildingIDArgument` that is added the `parser`.
+        arguments: The arguments that are made available in the rcli.
     """
 
     def __init__(self, parser: argparse.ArgumentParser):
         self.parser = parser
 
-        self.argument = BuildingIDArgument()
+        self.arguments = ArgumentFactory()
         self.message_bus = None
 
     def setup_parser(self):
-        self.argument.add_argument_to_parser(self.parser)
+        self.arguments.add_to_parser(self.parser)
 
     def set_message_bus(self, message_bus: MessageBus):
         self.message_bus = message_bus
@@ -54,16 +54,15 @@ class RCLI:
     async def execute(self, args):
         await self.ensure_message_bus_connected()
 
-        try:
-            payload = self.argument.process_arguments(args)
-        except KeyError as ex:
-            logger.debug(f"Argument {ex} not provided")
-            return
+        # Find the argument to be put on the message bus
+        for key, value in args.items():
+            if key in self.arguments.arguments:
+                rabotnik_argument = key
+                rabotnik_value = value
 
-        message = self.argument.rabotnik_message
-
-        logger.info(f"Dispatching {payload} on {message}")
-        await self.message_bus.send(message=message, payload=payload)
+        await self.arguments.arguments[rabotnik_argument].execute(
+            self.message_bus, rabotnik_argument, rabotnik_value
+        )
 
     async def ensure_message_bus_connected(self):
         if not self.message_bus:

tests/test_arguments.py

+#!/usr/bin/env python3
+
+# Copyright (C) 2020-2021:
+#   Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see http://www.gnu.org/licenses/.
+
+from rcli.argument_base import ArgumentBase
+
+
+def test_get_format_argument():
+    class ArgumentTest1(ArgumentBase):
+        def __init__(self):
+            self.argument = "--x"
+
+    test_argument = ArgumentTest1()
+    assert test_argument.get_formatted_argument() == "x"
+
+    class ArgumentTest2(ArgumentBase):
+        def __init__(self):
+            self.argument = "--x-x"
+
+    test_argument = ArgumentTest2()
+    assert test_argument.get_formatted_argument() == "x_x"
+
+    class ArgumentTest3(ArgumentBase):
+        def __init__(self):
+            self.argument = "x-x"
+
+    test_argument = ArgumentTest3()
+    assert test_argument.get_formatted_argument() == "x_x"
+
+    class ArgumentTest4(ArgumentBase):
+        def __init__(self):
+            self.argument = "x_x"
+
+    test_argument = ArgumentTest4()
+    assert test_argument.get_formatted_argument() == "x_x"