Improve CLI multiple behaviour and builtin type output

Author: timothycrosley

CHANGELOG.md

@@ -11,6 +11,10 @@ Ideally, within a virtual environment.
 
 Changelog
 =========
+### 2.6.0 - August 28, 2019
+- Improved CLI multiple behaviour with empty defaults
+- Improved CLI type output for built-in types
+
 ### 2.5.6 - June 20, 2019
 - Fixed issue #815: map_params() causes api documentation to lose param type information
 - Improved project testing: restoring 100% coverage

examples/cli_multiple.py

@@ -0,0 +1,9 @@
+import hug
+
+@hug.cli()
+def add(numbers: list=None):
+    return sum([int(number) for number in numbers])
+
+
+if __name__ == "__main__":
+    add.interface.cli()

hug/interface.py

@@ -48,6 +48,12 @@
     text,
 )
 
+DOC_TYPE_MAP = {str: "String", bool: "Boolean", list: "Multiple", int: "Integer", float: "Float"}
+
+
+def _doc(kind):
+    return DOC_TYPE_MAP.get(kind, kind.__doc__)
+
 
 def asyncio_call(function, *args, **kwargs):
     loop = asyncio.get_event_loop()
@@ -227,7 +233,7 @@ def __init__(self, route, function):
             self.output_doc = self.transform.__doc__
         elif self.transform or self.interface.transform:
             output_doc = self.transform or self.interface.transform
-            self.output_doc = output_doc if type(output_doc) is str else output_doc.__doc__
+            self.output_doc = output_doc if type(output_doc) is str else _doc(output_doc)
 
         self.raise_on_invalid = route.get("raise_on_invalid", False)
         if "on_invalid" in route:
@@ -310,7 +316,7 @@ def documentation(self, add_to=None):
                 for requirement in self.requires
             ]
         doc["outputs"] = OrderedDict()
-        doc["outputs"]["format"] = self.outputs.__doc__
+        doc["outputs"]["format"] = _doc(self.outputs)
         doc["outputs"]["content_type"] = self.outputs.content_type
         parameters = [
             param
@@ -329,7 +335,7 @@ def documentation(self, add_to=None):
                     continue
 
                 input_definition = inputs.setdefault(argument, OrderedDict())
-                input_definition["type"] = kind if isinstance(kind, str) else kind.__doc__
+                input_definition["type"] = kind if isinstance(kind, str) else _doc(kind)
                 default = self.defaults.get(argument, None)
                 if default is not None:
                     input_definition["default"] = default
@@ -505,7 +511,7 @@ def exit(self, status=0, message=None):
             if option in self.interface.input_transformations:
                 transform = self.interface.input_transformations[option]
                 kwargs["type"] = transform
-                kwargs["help"] = transform.__doc__
+                kwargs["help"] = _doc(transform)
                 if transform in (list, tuple) or isinstance(transform, types.Multiple):
                     kwargs["action"] = "append"
                     kwargs["type"] = Text()
@@ -588,9 +594,12 @@ def exit_callback(message):
 
         for field, type_handler in self.reaffirm_types.items():
             if field in pass_to_function:
-                pass_to_function[field] = self.initialize_handler(
-                    type_handler, pass_to_function[field], context=context
-                )
+                if not pass_to_function[field] and type_handler in (list, tuple, hug.types.Multiple):
+                    pass_to_function[field] = type_handler(())
+                else:
+                    pass_to_function[field] = self.initialize_handler(
+                        type_handler, pass_to_function[field], context=context
+                    )
 
         if getattr(self, "validate_function", False):
             errors = self.validate_function(pass_to_function)

tests/test_decorators.py

@@ -1936,3 +1936,11 @@ def pull_record(record_id: hug.types.number = 1):
 
     assert hug.test.get(hug_api, "pull_record").data == 1
     assert hug.test.get(hug_api, "pull_record", id=10).data == 10
+
+
+def test_multiple_cli(hug_api):
+    @hug.cli(api=hug_api)
+    def multiple(items: list=None):
+        return items
+
+    hug_api.cli([None, "multiple", "-i", "one", "-i", "two"])