Fix issue with optional arguments

Author: const-cloudinary

cloudinary_cli/utils/utils.py

@@ -93,9 +93,19 @@ def parse_args_kwargs(func, params):
     n_req = n_args - n_defaults
     if len(params) < n_req:
         raise Exception("Function '{}' requires {} arguments".format(func.__name__, n_req))
-    args = [parse_option_value(x) for x in params[:n_req]]
+    # consume required args
+    args = [parse_option_value(p) for p in params[:n_req]]
+    kwargs = {}
+
+    for p in params[n_req:]:
+        if '=' not in p:
+            # named/positional with default value args passed as positional
+            args.append(parse_option_value(p))
+            continue
+
+        k, v = p.split('=', 1)
+        kwargs[k] = parse_option_value(v)
 
-    kwargs = {k: parse_option_value(v) for k, v in [x.split('=') for x in params[n_req:]]} if params[n_req:] else {}
     return args, kwargs
 
 

test/test_utils.py

@@ -1,6 +1,7 @@
 import unittest
 
-from cloudinary_cli.utils.utils import parse_option_value, whitelist_keys, merge_responses, normalize_list_params
+from cloudinary_cli.utils.utils import parse_option_value, parse_args_kwargs, whitelist_keys, merge_responses, \
+    normalize_list_params
 
 
 class UtilsTest(unittest.TestCase):
@@ -19,6 +20,32 @@ def test_parse_option_value_converts_int_to_str(self):
         """ should convert a parsed int to a str """
         self.assertEqual("1", parse_option_value(1))
 
+    def test_parse_args_kwargs(self):
+        args, kwargs = parse_args_kwargs(_no_args_test_func, [])
+        self.assertEqual(0, len(args))
+        self.assertEqual(0, len(kwargs))
+
+        args, kwargs = parse_args_kwargs(_only_args_test_func, ["a1", "a2"])
+        self.assertListEqual(["a1", "a2"], args)
+        self.assertEqual(0, len(kwargs))
+
+        with self.assertRaisesRegex(Exception, "requires 2 arguments"):
+            parse_args_kwargs(_only_args_test_func, ["a1"])
+
+        args, kwargs = parse_args_kwargs(_args_kwargs_test_func, ["a1", 'arg2=a2'])
+        self.assertListEqual(["a1"], args)
+        self.assertDictEqual({"arg2": "a2"}, kwargs)
+
+        # should parse values
+        args, kwargs = parse_args_kwargs(_args_kwargs_test_func, ['["a1"]', 'arg2={"k2":"a2"}'])
+        self.assertListEqual([["a1"]], args)
+        self.assertDictEqual({"arg2": {"k2": "a2"}}, kwargs)
+
+        # should allow passing optional args as positional
+        args, kwargs = parse_args_kwargs(_args_kwargs_test_func, ["a1", "a2"])
+        self.assertListEqual(["a1", "a2"], args)
+        self.assertEqual(0, len(kwargs))
+
     def test_whitelist_keys(self):
         """ should whitelist keys correctly """
         self.assertEqual([{"k1": "v1"}], whitelist_keys([{"k1": "v1", "k2": "v2"}], ["k1"]))
@@ -61,3 +88,15 @@ def test_merge_responses(self):
     def test_normalize_list_params(self):
         """ should normalize a list of parameters """
         self.assertEqual(["f1", "f2", "f3"], normalize_list_params(["f1,f2", "f3"]))
+
+
+def _no_args_test_func():
+    pass
+
+
+def _only_args_test_func(arg1, arg2):
+    return arg1, arg2
+
+
+def _args_kwargs_test_func(arg1, arg2=None):
+    return arg1, arg2