chore: rename `what` to `gitlab_resource`

Naming a variable `what` makes it difficult to understand what it is
used for.

Rename it to `gitlab_resource` as that is what is being stored.

The Gitlab documentation talks about them being resources:
https://docs.gitlab.com/ee/api/api_resources.html

This will improve code readability.

2 files changed, 17 insertions, 15 deletions

diff --git a/gitlab/cli.py b/gitlab/cli.py
index 4159632..c9e182d 100644
--- a/gitlab/cli.py
+++ b/gitlab/cli.py
@@ -91,14 +91,16 @@ def die(msg: str, e: Optional[Exception] = None) -> None:
     sys.exit(1)
 
 
-def what_to_cls(what: str, namespace: ModuleType) -> Type[RESTObject]:
+def gitlab_resource_to_cls(
+    gitlab_resource: str, namespace: ModuleType
+) -> Type[RESTObject]:
     classes = CaseInsensitiveDict(namespace.__dict__)
-    lowercase_class = what.replace("-", "")
+    lowercase_class = gitlab_resource.replace("-", "")
 
     return classes[lowercase_class]
 
 
-def cls_to_what(cls: RESTObject) -> str:
+def cls_to_gitlab_resource(cls: RESTObject) -> str:
     dasherized_uppercase = camel_upperlower_regex.sub(r"\1-\2", cls.__name__)
     dasherized_lowercase = camel_lowerupper_regex.sub(r"\1-\2", dasherized_uppercase)
     return dasherized_lowercase.lower()
@@ -322,7 +324,7 @@ def main() -> None:
         fields = [x.strip() for x in args.fields.split(",")]
     debug = args.debug
     action = args.whaction
-    what = args.what
+    gitlab_resource = args.gitlab_resource
 
     args_dict = vars(args)
     # Remove CLI behavior-related args
@@ -331,7 +333,7 @@ def main() -> None:
         "config_file",
         "verbose",
         "debug",
-        "what",
+        "gitlab_resource",
         "whaction",
         "version",
         "output",
@@ -359,4 +361,4 @@ def main() -> None:
     if debug:
         gl.enable_debug()
 
-    gitlab.v4.cli.run(gl, what, action, args_dict, verbose, output, fields)
+    gitlab.v4.cli.run(gl, gitlab_resource, action, args_dict, verbose, output, fields)
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
index 226459e..18bd3f0 100644
--- a/gitlab/v4/cli.py
+++ b/gitlab/v4/cli.py
@@ -29,13 +29,13 @@ from gitlab import cli
 
 class GitlabCLI:
     def __init__(
-        self, gl: gitlab.Gitlab, what: str, action: str, args: Dict[str, str]
+        self, gl: gitlab.Gitlab, gitlab_resource: str, action: str, args: Dict[str, str]
     ) -> None:
-        self.cls: Type[gitlab.base.RESTObject] = cli.what_to_cls(
-            what, namespace=gitlab.v4.objects
+        self.cls: Type[gitlab.base.RESTObject] = cli.gitlab_resource_to_cls(
+            gitlab_resource, namespace=gitlab.v4.objects
         )
         self.cls_name = self.cls.__name__
-        self.what = what.replace("-", "_")
+        self.gitlab_resource = gitlab_resource.replace("-", "_")
         self.action = action.lower()
         self.gl = gl
         self.args = args
@@ -81,7 +81,7 @@ class GitlabCLI:
 
     def run(self) -> Any:
         # Check for a method that matches object + action
-        method = f"do_{self.what}_{self.action}"
+        method = f"do_{self.gitlab_resource}_{self.action}"
         if hasattr(self, method):
             return getattr(self, method)()
 
@@ -333,7 +333,7 @@ def _populate_sub_parser_by_class(
 
 def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     subparsers = parser.add_subparsers(
-        title="object", dest="what", help="Object to manipulate."
+        title="object", dest="gitlab_resource", help="Object to manipulate."
     )
     subparsers.required = True
 
@@ -347,7 +347,7 @@ def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
                 classes.add(cls._obj_cls)
 
     for cls in sorted(classes, key=operator.attrgetter("__name__")):
-        arg_name = cli.cls_to_what(cls)
+        arg_name = cli.cls_to_gitlab_resource(cls)
         object_group = subparsers.add_parser(arg_name)
 
         object_subparsers = object_group.add_subparsers(
@@ -497,14 +497,14 @@ PRINTERS: Dict[
 
 def run(
     gl: gitlab.Gitlab,
-    what: str,
+    gitlab_resource: str,
     action: str,
     args: Dict[str, Any],
     verbose: bool,
     output: str,
     fields: List[str],
 ) -> None:
-    g_cli = GitlabCLI(gl=gl, what=what, action=action, args=args)
+    g_cli = GitlabCLI(gl=gl, gitlab_resource=gitlab_resource, action=action, args=args)
     data = g_cli.run()
 
     printer: Union[JSONPrinter, LegacyPrinter, YAMLPrinter] = PRINTERS[output]()