Merge pull request #488 from beer-garden/map-parameter-type-to-string

Parameter decorator map literal to string

CHANGELOG.rst

@@ -5,6 +5,7 @@ Brewtils Changelog
 ------
 TBD
 
+- Update Parameter decorator to map parameter type from literal to string value if possible
 - Added Subscriber Types to Subscriber model
 - Added Prefix Topics to System model
 - Support adding Prefix Topics for the Generated Subscribers. It is supported through the `@client` or SystemClient inputs or beer.conf

brewtils/decorators.py

@@ -296,12 +296,20 @@ def echo(self, message):
 
     """
 
-    # Allowing type matching: string == String == STRING
-    if type and type not in Parameter.TYPES:
+    # Validate type against permitted string literals
+    if not isinstance(type, str):
+        # Try to map literal to string equivalent
+        temp_type = _format_type(type)
+        if temp_type in Parameter.TYPES:
+            type = temp_type
+    elif type not in Parameter.TYPES:
+        # Allowing type matching: string == String == STRING
         for parameter_type in Parameter.TYPES:
             if type.upper() == parameter_type.upper():
                 type = parameter_type
                 break
+    if type not in Parameter.TYPES:
+        raise ValueError(f"Unable to map type {type} to string literal")
 
     if _wrapped is None:
         return functools.partial(

test/decorators_test.py

@@ -698,6 +698,54 @@ def cmd3(foo):
         assert cmd2.parameters[0].type == "String"
         assert cmd3.parameters[0].type == "String"
 
+    def test_literal_mapping(self, basic_param):
+
+        del basic_param["type"]
+
+        @parameter(**basic_param, type=str)
+        def cmd1(foo):
+            return foo
+
+        @parameter(**basic_param, type=int)
+        def cmd2(foo):
+            return foo
+
+        @parameter(**basic_param, type=float)
+        def cmd3(foo):
+            return foo
+
+        @parameter(**basic_param, type=bool)
+        def cmd4(foo):
+            return foo
+
+        @parameter(**basic_param, type=dict)
+        def cmd5(foo):
+            return foo
+
+        @parameter(**basic_param)
+        def cmd6(foo):
+            return foo
+
+        assert cmd1.parameters[0].type == "String"
+        assert cmd2.parameters[0].type == "Integer"
+        assert cmd3.parameters[0].type == "Float"
+        assert cmd4.parameters[0].type == "Boolean"
+        assert cmd5.parameters[0].type == "Dictionary"
+        assert cmd6.parameters[0].type == "Any"
+
+        with pytest.raises(ValueError):
+
+            class BadType:
+                bad = True
+
+            @parameter(**basic_param, type=BadType)
+            def cmd_bad_1(foo):
+                return foo
+
+            @parameter(**basic_param, type="Bad Type")
+            def cmd_bad_2(foo):
+                return foo
+
 
 class TestParameters(object):
     @pytest.fixture(autouse=True)