Merge "[Docs] Fix metavars"

2016-01-06 17:30:39 +00:00 · 2016-01-06 17:30:39 +00:00 · 1cd84aecaa
commit 1cd84aecaa
parent 7f71e6c76b 54cc70c9ae
5 changed files with 81 additions and 51 deletions
--- a/rally/cli/cliutils.py
+++ b/rally/cli/cliutils.py
@ -309,6 +309,10 @@ def pretty_float_formatter(field, ndigits=None):
 def args(*args, **kwargs):
    def _decorator(func):
        func.__dict__.setdefault("args", []).insert(0, (args, kwargs))
+        if "metavar" not in kwargs and "action" not in kwargs:
+            # NOTE(andreykurilin): argparse constructs awful metavars...
+            kwargs["metavar"] = "<%s>" % args[0].replace(
+                "--", "").replace("-", "_")
        return func
    return _decorator

--- a/rally/cli/commands/deployment.py
+++ b/rally/cli/commands/deployment.py
@ -44,7 +44,7 @@ class DeploymentCommands(object):
                   help="A name of the deployment.")
    @cliutils.args("--fromenv", action="store_true",
                   help="Read environment variables instead of config file.")
-    @cliutils.args("--filename", type=str, required=False,
+    @cliutils.args("--filename", type=str, required=False, metavar="<path>",
                   help="A path to the configuration file of the "
                   "deployment.")
    @cliutils.args("--no-use", action="store_false", dest="do_use",
@ -111,7 +111,8 @@ class DeploymentCommands(object):
            self.use(deployment["uuid"])

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment.")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment()
    @plugins.ensure_plugins_are_loaded
    def recreate(self, deployment=None):
@ -125,7 +126,8 @@ class DeploymentCommands(object):
        api.Deployment.recreate(deployment)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment.")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment()
    @plugins.ensure_plugins_are_loaded
    def destroy(self, deployment=None):
@ -160,7 +162,8 @@ class DeploymentCommands(object):
                    "\nrally deployment create"))

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment.")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment()
    @cliutils.suppress_warnings
    def config(self, deployment=None):
@ -176,7 +179,8 @@ class DeploymentCommands(object):
        print(json.dumps(result, sort_keys=True, indent=4))

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment.")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment()
    def show(self, deployment=None):
        """Show the credentials of the deployment.
@ -200,7 +204,8 @@ class DeploymentCommands(object):
        cliutils.print_list(table_rows, headers)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment.")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment()
    def check(self, deployment=None):
        """Check keystone authentication and list all available services.
@ -264,8 +269,9 @@ class DeploymentCommands(object):
            os.remove(expanded_path)
        os.symlink(openrc_path, expanded_path)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   help="UUID or name of the deployment.")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    def use(self, deployment):
        """Set active deployment.

--- a/rally/cli/commands/show.py
+++ b/rally/cli/commands/show.py
@ -51,7 +51,8 @@ class ShowCommands(object):
        return credentials + deployment.deployment.get("users", [])

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    @cliutils.process_keystone_exc
    def images(self, deployment=None):
@ -82,7 +83,8 @@ class ShowCommands(object):
                                mixed_case_fields=mixed_case_fields)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    @cliutils.process_keystone_exc
    def flavors(self, deployment=None):
@ -113,7 +115,8 @@ class ShowCommands(object):
                                mixed_case_fields=mixed_case_fields)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    @cliutils.process_keystone_exc
    def networks(self, deployment=None):
@ -136,7 +139,8 @@ class ShowCommands(object):
                                mixed_case_fields=mixed_case_fields)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    @cliutils.process_keystone_exc
    def secgroups(self, deployment=None):
@ -160,7 +164,8 @@ class ShowCommands(object):
                mixed_case_fields=mixed_case_fields)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    @cliutils.process_keystone_exc
    def keypairs(self, deployment=None):
--- a/rally/cli/commands/task.py
+++ b/rally/cli/commands/task.py
@ -138,14 +138,15 @@ class TaskCommands(object):
        print(_("Task config is valid :)"))
        return input_task

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of the deployment")
-    @cliutils.args("--task", "--filename",
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
+    @cliutils.args("--task", "--filename", metavar="<path>",
                   help="Path to the file with full configuration of task")
-    @cliutils.args("--task-args", dest="task_args",
+    @cliutils.args("--task-args", metavar="<json>", dest="task_args",
                   help="Input task args (dict in json). These args are used "
                        "to render input task that is jinja2 template.")
-    @cliutils.args("--task-args-file", dest="task_args_file",
+    @cliutils.args("--task-args-file", metavar="<path>", dest="task_args_file",
                   help="Path to the file with input task args (dict in "
                        "json/yaml). These args are used to render input "
                        "task that is jinja2 template.")
@ -174,13 +175,15 @@ class TaskCommands(object):
            print(e, file=sys.stderr)
            return(1)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of the deployment")
-    @cliutils.args("--task", "--filename", help="Path to the input task file")
-    @cliutils.args("--task-args", dest="task_args",
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
+    @cliutils.args("--task", "--filename", metavar="<path>",
+                   help="Path to the input task file")
+    @cliutils.args("--task-args", dest="task_args", metavar="<json>",
                   help="Input task args (dict in json). These args are used "
                        "to render input task that is jinja2 template.")
-    @cliutils.args("--task-args-file", dest="task_args_file",
+    @cliutils.args("--task-args-file", dest="task_args_file", metavar="<path>",
                   help="Path to the file with input task args (dict in "
                        "json/yaml). These args are used to render input "
                        "task that is jinja2 template.")
@ -514,9 +517,9 @@ class TaskCommands(object):
                task_id, consts.TaskStatus.FAILED, consts.TaskStatus.FINISHED))
            return(1)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   help="List tasks from specified deployment."
-                   "By default tasks listed from active deployment.")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @cliutils.args("--all-deployments", action="store_true",
                   dest="all_deployments",
                   help="List tasks from all deployments.")
@ -581,7 +584,8 @@ class TaskCommands(object):

    @cliutils.args("--tasks", dest="tasks", nargs="+",
                   help="uuids of tasks or json files with task results")
-    @cliutils.args("--out", type=str, dest="out",
+    @cliutils.args("--out", metavar="<path>",
+                   type=str, dest="out", required=False,
                   help="Path to output file.")
    @cliutils.args("--open", dest="open_it", action="store_true",
                   help="Open it in browser.")
--- a/rally/cli/commands/verify.py
+++ b/rally/cli/commands/verify.py
@ -44,20 +44,22 @@ class VerifyCommands(object):
    """

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
-    @cliutils.args("--set", dest="set_name", type=str, required=False,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
+    @cliutils.args("--set", metavar="<set_name>", dest="set_name", type=str,
+                   required=False,
                   help="Name of a Tempest test set. "
                        "Available sets are %s" % ", ".join(AVAILABLE_SETS))
    @cliutils.args("--regex", dest="regex", type=str, required=False,
                   help="Regular expression of test")
-    @cliutils.args("--tests-file", dest="tests_file", type=str,
-                   help="Path to a file with a list of Tempest tests",
-                   required=False)
+    @cliutils.args("--tests-file", metavar="<path>", dest="tests_file",
+                   type=str, required=False,
+                   help="Path to a file with a list of Tempest tests")
    @cliutils.args("--tempest-config", dest="tempest_config", type=str,
-                   required=False,
+                   required=False, metavar="<path>",
                   help="User specified Tempest config file location")
    @cliutils.args("--xfails-file", dest="xfails_file", type=str,
-                   required=False,
+                   required=False, metavar="<path>",
                   help="Path to a file in YAML format with a list of Tempest "
                        "tests that are expected to fail")
    @cliutils.args("--no-use", action="store_false", dest="do_use",
@ -72,7 +74,8 @@ class VerifyCommands(object):
    @cliutils.deprecated_args("--system-wide-install", dest="system_wide",
                              required=False, action="store_true",
                              release="0.1.2", alternative="--system-wide")
-    @cliutils.args("--concurrency", dest="concur", type=int, required=False,
+    @cliutils.args("--concurrency", metavar="N", dest="concur", type=int,
+                   required=False,
                   help="How many processes to use to run Tempest tests. "
                        "The default value (0) auto-detects your CPU count")
    @envutils.with_default_deployment(cli_arg_name="deployment")
@ -138,12 +141,14 @@ class VerifyCommands(object):
            self.use(verification["uuid"])

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
-    @cliutils.args("--set", dest="set_name", type=str, required=False,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
+    @cliutils.args("--set", metavar="<set_name>", dest="set_name", type=str,
+                   required=False,
                   help="Name of a Tempest test set. "
                        "Available sets are %s" % ", ".join(AVAILABLE_SETS))
    @cliutils.args("--file", dest="log_file", type=str,
-                   required=True,
+                   required=True, metavar="<path>",
                   help="User specified Tempest log file location. "
                        "Note, Tempest log file needs to be in subunit format")
    @cliutils.args("--no-use", action="store_false", dest="do_use",
@ -190,7 +195,7 @@ class VerifyCommands(object):
    @cliutils.args("--json", action="store_true", dest="output_json",
                   help="Display results in JSON format")
    @cliutils.args("--output-file", type=str, required=False,
-                   dest="output_file",
+                   dest="output_file", metavar="<path>",
                   help="Path to a file to save results")
    @envutils.with_default_verification_id
    @cliutils.suppress_warnings
@ -228,7 +233,8 @@ class VerifyCommands(object):
    @cliutils.args("--uuid", dest="verification", type=str,
                   required=False,
                   help="UUID of a verification")
-    @cliutils.args("--sort-by", dest="sort_by", type=str, required=False,
+    @cliutils.args("--sort-by", metavar="<query>", dest="sort_by", type=str,
+                   required=False,
                   help="Sort results by 'name' or 'duration'")
    @cliutils.args("--detailed", dest="detailed", action="store_true",
                   required=False,
@ -368,9 +374,10 @@ class VerifyCommands(object):
        fileutils.update_globals_file("RALLY_VERIFICATION", verification)

    @cliutils.args("--deployment", dest="deployment", type=str,
-                   required=False, help="UUID or name of a deployment")
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @cliutils.args("--tempest-config", dest="tempest_config", type=str,
-                   required=False,
+                   required=False, metavar="<path>",
                   help="User specified Tempest config file location")
    @cliutils.args("--override", dest="override",
                   help="Override existing Tempest config file",
@ -387,8 +394,9 @@ class VerifyCommands(object):
        api.Verification.configure_tempest(deployment, tempest_config,
                                           override)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of a deployment")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @cliutils.args("--source", type=str, dest="source", required=False,
                   help="Path/URL to repo to clone Tempest from")
    @cliutils.args("--no-tempest-venv", dest="no_tempest_venv",
@ -406,8 +414,9 @@ class VerifyCommands(object):
        """
        api.Verification.install_tempest(deployment, source, no_tempest_venv)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of a deployment")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    def uninstall(self, deployment=None):
        """Remove deployment's local Tempest installation.
@ -416,10 +425,11 @@ class VerifyCommands(object):
        """
        api.Verification.uninstall_tempest(deployment)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of a deployment")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @cliutils.args("--tempest-config", dest="tempest_config", type=str,
-                   required=False,
+                   required=False, metavar="<path>",
                   help="User specified Tempest config file location")
    @cliutils.args("--source", type=str, dest="source", required=False,
                   help="Path/URL to repo to clone Tempest from")
@ -441,8 +451,9 @@ class VerifyCommands(object):
        api.Verification.reinstall_tempest(deployment, tempest_config,
                                           source, no_tempest_venv)

-    @cliutils.args("--deployment", type=str, dest="deployment",
-                   required=False, help="UUID or name of a deployment")
+    @cliutils.args("--deployment", dest="deployment", type=str,
+                   metavar="<uuid>", required=False,
+                   help="UUID or name of a deployment.")
    @envutils.with_default_deployment(cli_arg_name="deployment")
    def showconfig(self, deployment=None):
        """Show configuration file of Tempest.