Addressed @mgermain's comments

Author: MarcCote

smartdispatch/argument.py smartdispatch/folded_argument_template.pysmartdispatch/argument.py renamed to smartdispatch/folded_argument_template.py

@@ -1,25 +1,25 @@
 import re
 
 
-class FoldedArgument(object):
+class FoldedArgumentTemplate(object):
     def __init__(self):
         self.name = ""
         self.regex = ""
 
     def unfold(self, match):
-        raise NotImplementedError("Subclass must implement this method!")
+        raise NotImplementedError("Subclass must implement method `unfold(self, match)`!")
 
 
-class EnumerationFoldedArgument(FoldedArgument):
+class ListFoldedArgumentTemplate(FoldedArgumentTemplate):
     def __init__(self):
-        self.name = "enumeration"
+        self.name = "list"
         self.regex = "\[[^]]*\]"
 
     def unfold(self, match):
         return match[1:-1].split(' ')
 
 
-class RangeFoldedArgument(FoldedArgument):
+class RangeFoldedArgumentTemplate(FoldedArgumentTemplate):
     def __init__(self):
         self.name = "range"
         self.regex = "\[(\d+):(\d+)(?::(\d+))?\]"

smartdispatch/smartdispatch.py

@@ -7,7 +7,7 @@
 
 import smartdispatch
 from smartdispatch import utils
-from smartdispatch.argument import EnumerationFoldedArgument, RangeFoldedArgument
+from smartdispatch.folded_argument_template import ListFoldedArgumentTemplate, RangeFoldedArgumentTemplate
 
 UID_TAG = "{UID}"
 
@@ -117,7 +117,7 @@ def get_commands_from_arguments(arguments):
 def unfold_arguments(arguments):
     ''' Unfolds folded arguments into a list of unfolded arguments.
 
-    An argument can be folded e.g. a list of unfolded arguments separated by commas.
+    An argument can be folded e.g. a list of unfolded arguments separated by spaces.
     An unfolded argument unfolds to itself.
 
     Parameters
@@ -132,16 +132,17 @@ def unfold_arguments(arguments):
 
     Complex arguments
     -----------------
-    *enumeration*: "[item1 item2 ... itemN]"
+    *list*: "[item1 item2 ... itemN]"
     *range*: "[start:end]" or "[start:end:step]"
     '''
-    text = utils.escape(" ".join(arguments))
+    text = utils.encode_escaped_characters(" ".join(arguments))
 
     # Order matter, if some regex is more greedy than another, the it should go after
-    arguments = [RangeFoldedArgument(), EnumerationFoldedArgument()]
+    folded_argument_templates = [RangeFoldedArgumentTemplate(), ListFoldedArgumentTemplate()]
+    folded_argument_templates_dict = {arg.name: arg for arg in folded_argument_templates}
 
     # Build the master regex with all argument's regex
-    regex = "(" + "|".join(["(?P<{0}>{1})".format(arg.name, arg.regex) for arg in arguments]) + ")"
+    regex = "(" + "|".join(["(?P<{0}>{1})".format(arg.name, arg.regex) for arg in folded_argument_templates]) + ")"
 
     pos = 0
     unfolded_arguments = []
@@ -150,15 +151,13 @@ def unfold_arguments(arguments):
         unfolded_arguments.append([text[pos:match.start()]])
 
         # Unfold argument
-        groupdict = match.groupdict()
-        for argument in arguments:
-            if groupdict[argument.name] is not None:
-                unfolded_arguments.append(argument.unfold(groupdict[argument.name]))
-
+        folded_argument_template_name, matched_text = [(k, v) for k, v in match.groupdict().items() if v is not None][0]
+        folded_argument_template = folded_argument_templates_dict[folded_argument_template_name]
+        unfolded_arguments.append(folded_argument_template.unfold(matched_text))
         pos = match.end()
 
     unfolded_arguments.append([text[pos:]])  # Add remaining unfolded arguments
-    unfolded_arguments = [map(utils.hex2str, argvalues) for argvalues in unfolded_arguments]
+    unfolded_arguments = [map(utils.decode_escaped_characters, argvalues) for argvalues in unfolded_arguments]
     return unfolded_arguments
 
 

smartdispatch/tests/test_argument.py …h/tests/test_folded_argument_template.pysmartdispatch/tests/test_argument.py renamed to smartdispatch/tests/test_folded_argument_template.py smartdispatch/tests/test_argument.py renamed to smartdispatch/tests/test_folded_argument_template.py

@@ -1,17 +1,14 @@
 from nose.tools import assert_equal, assert_true
 from numpy.testing import assert_array_equal
 
-from smartdispatch.argument import EnumerationFoldedArgument, RangeFoldedArgument
-import smartdispatch
+from smartdispatch.folded_argument_template import ListFoldedArgumentTemplate, RangeFoldedArgumentTemplate
 
 import re
-import os
-import unittest
 
 
-def test_enumeration_folded_argument():
+def test_list_folded_argument_template():
     # Test valid enumeration folded arguments
-    arg = EnumerationFoldedArgument()
+    arg = ListFoldedArgumentTemplate()
     folded_arguments = [("[]", [""]),
                         ("[1]", ["1"]),
                         ("[1 ]", ["1", ""]),
@@ -27,8 +24,8 @@ def test_enumeration_folded_argument():
     assert_true(re.match(arg.regex, "[1 2 3") is None)
 
 
-def test_range_folded_argument():
-    arg = RangeFoldedArgument()
+def test_range_folded_argument_template():
+    arg = RangeFoldedArgumentTemplate()
     folded_arguments = [("[1:4]", ["1", "2", "3"]),
                         ("[1:4:2]", ["1", "3"]),
                         ]

smartdispatch/tests/test_smartdispatch.py

@@ -107,7 +107,7 @@ def test_get_commands_from_arguments():
                                                                    "python my_command.py 0.00000000001 -1 omicron",
                                                                    "python my_command.py 0.00000000001 -1 mu"])
 
-    # Test multiple unfolded arguments and not unfoldable brackets
+    # Test multiple folded arguments and not unfoldable brackets
     args = smartdispatch.unfold_arguments(["python my_command.py [0.01 0.000001 0.00000000001] -1 \[[42 133,666]\] slow [omicron mu]"])
     assert_equal(smartdispatch.get_commands_from_arguments(args), ["python my_command.py 0.01 -1 [42] slow omicron",
                                                                    "python my_command.py 0.01 -1 [42] slow mu",
@@ -122,6 +122,27 @@ def test_get_commands_from_arguments():
                                                                    "python my_command.py 0.00000000001 -1 [133,666] slow omicron",
                                                                    "python my_command.py 0.00000000001 -1 [133,666] slow mu"])
 
+    # Test multiple different folded arguments
+    args = smartdispatch.unfold_arguments(["python my_command.py [0.01 0.001] -[1:5] slow"])
+    assert_equal(smartdispatch.get_commands_from_arguments(args), ["python my_command.py 0.01 -1 slow",
+                                                                   "python my_command.py 0.01 -2 slow",
+                                                                   "python my_command.py 0.01 -3 slow",
+                                                                   "python my_command.py 0.01 -4 slow",
+                                                                   "python my_command.py 0.001 -1 slow",
+                                                                   "python my_command.py 0.001 -2 slow",
+                                                                   "python my_command.py 0.001 -3 slow",
+                                                                   "python my_command.py 0.001 -4 slow"])
+
+    args = smartdispatch.unfold_arguments(["python my_command.py -[1:5] slow [0.01 0.001]"])
+    assert_equal(smartdispatch.get_commands_from_arguments(args), ["python my_command.py -1 slow 0.01",
+                                                                   "python my_command.py -1 slow 0.001",
+                                                                   "python my_command.py -2 slow 0.01",
+                                                                   "python my_command.py -2 slow 0.001",
+                                                                   "python my_command.py -3 slow 0.01",
+                                                                   "python my_command.py -3 slow 0.001",
+                                                                   "python my_command.py -4 slow 0.01",
+                                                                   "python my_command.py -4 slow 0.001"])
+
 
 def test_replace_uid_tag():
     command = "command without uid tag"

smartdispatch/utils.py

@@ -35,15 +35,15 @@ def slugify(value):
     return str(re.sub('[-\s]+', '_', value))
 
 
-def escape(text, escaping_character="\\"):
+def encode_escaped_characters(text, escaping_character="\\"):
     """ Escape the escaped character using its hex representation """
     def hexify(match):
         return "\\x{0}".format(match.group()[-1].encode("hex"))
 
     return re.sub(r"\\.", hexify, text)
 
 
-def hex2str(text):
+def decode_escaped_characters(text):
     """ Convert hex representation to the character it represents """
     if len(text) == 0:
         return ''