fix: account for multiple inner traits and TraitCompound (e.g., Either) objects

Author: satra

nipype/scripts/utils.py

@@ -3,9 +3,12 @@
 Utilities for the CLI functions.
 """
 from __future__ import print_function, division, unicode_literals, absolute_import
-import re
 
+from builtins import bytes, str
+
+import re
 import click
+import json
 
 from .instance import import_module
 from ..interfaces.base import InputMultiPath, traits
@@ -16,7 +19,6 @@
 UNKNOWN_OPTIONS = dict(allow_extra_args=True,
                        ignore_unknown_options=True)
 
-
 # specification of existing ParamTypes
 ExistingDirPath  = click.Path(exists=True, file_okay=False, resolve_path=True)
 ExistingFilePath = click.Path(exists=True,  dir_okay=False, resolve_path=True)
@@ -63,22 +65,33 @@ def add_args_options(arg_parser, interface):
         # Escape any % signs with a %
         desc = desc.replace('%', '%%')
         args = {}
+        has_multiple_inner_traits = False
 
         if spec.is_trait_type(traits.Bool):
             args["default"] = getattr(inputs, name)
             args["action"] = 'store_true'
 
+        print(name, spec.trait_type)
         # current support is for simple trait types
         if not spec.inner_traits:
-            trait_type = type(spec.trait_type.default_value)
-            if trait_type in (str, int, float):
+            if not spec.is_trait_type(traits.TraitCompound):
+                trait_type = type(spec.trait_type.default_value)
+            if trait_type in (bytes, str, int, float):
+                if trait_type == bytes:
+                    trait_type = str
                 args["type"] = trait_type
         elif len(spec.inner_traits) == 1:
             trait_type = type(spec.inner_traits[0].trait_type.default_value)
-            if trait_type in (bool, str, int, float):
+            if trait_type == bytes:
+                trait_type = str
+            if trait_type in (bytes, bool, str, int, float):
                 args["type"] = trait_type
+        else:
+            if len(spec.inner_traits) > 1:
+                if not spec.is_trait_type(traits.Dict):
+                    has_multiple_inner_traits = True
 
-        if hasattr(spec, "mandatory") and spec.mandatory:
+        if getattr(spec, "mandatory", False):
             if spec.is_trait_type(InputMultiPath):
                 args["nargs"] = "+"
             elif spec.is_trait_type(traits.List):
@@ -87,6 +100,15 @@ def add_args_options(arg_parser, interface):
                     args["nargs"] = spec.trait_type.maxlen
                 else:
                     args["nargs"] = "+"
+            elif spec.is_trait_type(traits.Dict):
+                args["type"] = json.loads
+
+            if has_multiple_inner_traits:
+                raise NotImplementedError(
+                    ('This interface cannot be used. via the'
+                     ' command line as multiple inner traits'
+                     ' are currently not supported for mandatory'
+                     ' argument: {}.'.format(name)))
             arg_parser.add_argument(name, help=desc, **args)
         else:
             if spec.is_trait_type(InputMultiPath):
@@ -97,6 +119,8 @@ def add_args_options(arg_parser, interface):
                     args["nargs"] = spec.trait_type.maxlen
                 else:
                     args["nargs"] = "*"
-            arg_parser.add_argument("--%s" % name, dest=name,
-                                    help=desc, **args)
+            if not has_multiple_inner_traits:
+                arg_parser.add_argument("--%s" % name, dest=name,
+                                        help=desc, **args)
+
     return arg_parser