Improve error handling of the API commands

Author: const-cloudinary

cloudinary_cli/cli.py

@@ -44,6 +44,9 @@ def main():
         else:
             log_exception(e, "Command execution failed")
 
+    if type(exit_status) == int:
+        return exit_status
+
     return 0 if exit_status or exit_status is None else 1
 
 

cloudinary_cli/cli_group.py

@@ -40,4 +40,4 @@ def cli(config, config_saved):
     if not is_valid_cloudinary_config():
         logger.warning("No Cloudinary configuration found.")
 
-    return 0
+    return True

cloudinary_cli/core/utils.py

@@ -22,7 +22,13 @@ def utils(params, optional_parameter, optional_parameter_parsed, ls):
     if ls or len(params) < 1:
         return print_api_help(cld_utils, allow_list=utils_list)
 
-    echo(handle_command(params, optional_parameter, optional_parameter_parsed, cld_utils, "Utils"))
+    res = handle_command(params, optional_parameter, optional_parameter_parsed, cld_utils, "Utils")
+    if not res:
+        return False
+
+    echo(res)
+
+    return True
 
 
 @command("url", help="Generate a Cloudinary URL, which you can optionally open in your browser.")

cloudinary_cli/utils/api_utils.py

@@ -118,7 +118,11 @@ def asset_source(asset_details):
 
 
 def call_api(func, args, kwargs):
-    return func(*args, **kwargs)
+    try:
+        return func(*args, **kwargs)
+    except Exception as e:
+        log_exception(e, f"Failed calling '{func.__name__}' with args: {args} and optional args {kwargs}")
+        raise
 
 
 def handle_command(
@@ -127,11 +131,13 @@ def handle_command(
         optional_parameter_parsed,
         module,
         module_name):
-    func, args, kwargs = get_command_params(params,
-                                            optional_parameter,
-                                            optional_parameter_parsed,
-                                            module,
-                                            module_name)
+    try:
+        func, args, kwargs = get_command_params(params, optional_parameter, optional_parameter_parsed, module,
+                                                module_name)
+    except Exception as e:
+        log_exception(e)
+        return False
+
     return call_api(func, args, kwargs)
 
 
@@ -157,17 +163,20 @@ def handle_api_command(
     if ls or len(params) < 1:
         return print_api_help(api_instance)
 
-    func, args, kwargs = get_command_params(
-        params,
-        optional_parameter,
-        optional_parameter_parsed,
-        api_instance,
-        api_name)
+    try:
+        func, args, kwargs = get_command_params(params, optional_parameter, optional_parameter_parsed, api_instance,
+                                                api_name)
+    except Exception as e:
+        log_exception(e)
+        return False
 
     if not is_valid_cloudinary_config():
         raise ConfigurationError("No Cloudinary configuration found.")
 
-    res = call_api(func, args, kwargs)
+    try:
+        res = call_api(func, args, kwargs)
+    except Exception:
+        return False
 
     if auto_paginate:
         res = handle_auto_pagination(res, func, args, kwargs, force, filter_fields)

cloudinary_cli/utils/utils.py

@@ -54,7 +54,8 @@ def get_help_str(module, block_list=(), allow_list=()):
 
     funcs = OrderedDict(sorted(funcs.items()))
 
-    template = "{0:" + str(len(max(funcs.keys(), key=len)) + 1) + "}({1:30} {2}"  # Gets the max length of the functions' names
+    # Gets the max length of the functions' names
+    template = "{0:" + str(len(max(funcs.keys(), key=len)) + 1) + "}({1:30} {2}"
 
     return '\n'.join(
         [
@@ -115,7 +116,8 @@ 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))
+        func_sig = signature(func)
+        raise Exception(f"Function '{func.__name__}{func_sig}' requires {n_req} positional arguments")
     # consume required args
     args = [parse_option_value(p) for p in params[:n_req]]
     kwargs = {}
@@ -205,7 +207,7 @@ def get_command_params(
     if not callable(func):
         raise Exception(f"{params[0]} is not callable.")
 
-    args, kwargs = parse_args_kwargs(func, params[1:]) if len(params) > 1 else ([], {})
+    args, kwargs = parse_args_kwargs(func, params[1:])
 
     kwargs = {
         **kwargs,

test/test_utils.py

@@ -30,7 +30,7 @@ def test_parse_args_kwargs(self):
         self.assertListEqual(["a1", "a2"], args)
         self.assertEqual(0, len(kwargs))
 
-        with self.assertRaisesRegex(Exception, "requires 2 arguments"):
+        with self.assertRaisesRegex(Exception, "requires 2 positional arguments"):
             parse_args_kwargs(_only_args_test_func, ["a1"])
 
         args, kwargs = parse_args_kwargs(_args_kwargs_test_func, ["a1", 'arg2=a2'])