From 386dede4a8f1ba49342e1a9e7d7850aacea55418 Mon Sep 17 00:00:00 2001
From: Sergei Trofimov <sergei.trofimov@arm.com>
Date: Thu, 13 Apr 2017 11:13:15 +0100
Subject: [PATCH] command: added support for sub-commands
---
wa/__init__.py | 2 +-
wa/framework/command.py | 51 +++++++++++++++++++++++++++++++++++++----
2 files changed, 48 insertions(+), 5 deletions(-)
diff --git a/wa/__init__.py b/wa/__init__.py
index d005ef27..a4e286d1 100644
--- a/wa/__init__.py
+++ b/wa/__init__.py
@@ -1,5 +1,5 @@
from wa.framework import pluginloader, log, signal
-from wa.framework.command import Command
+from wa.framework.command import Command, ComplexCommand, SubCommand
from wa.framework.configuration import settings
from wa.framework.configuration.core import Status
from wa.framework.exception import HostError, JobError, InstrumentError, ConfigError
diff --git a/wa/framework/command.py b/wa/framework/command.py
index 443a54f0..ba0df09f 100644
--- a/wa/framework/command.py
+++ b/wa/framework/command.py
@@ -15,6 +15,7 @@
import textwrap
+from wa.framework.exception import CommandError
from wa.framework.plugin import Plugin
from wa.framework.version import get_wa_version
from wa.utils.doc import format_body
@@ -30,7 +31,7 @@ def init_argument_parser(parser):
return parser
-class Command(Plugin):
+class SubCommand(object):
"""
Defines a Workload Automation command. This will be executed from the
command line as ``wa <command> [args ...]``. This defines the name to be
@@ -39,15 +40,14 @@ class Command(Plugin):
command line arguments.
"""
- kind = "command"
help = None
usage = None
description = None
epilog = None
formatter_class = None
- def __init__(self, subparsers):
- super(Command, self).__init__()
+ def __init__(self, logger, subparsers):
+ self.logger = logger
self.group = subparsers
desc = format_body(textwrap.dedent(self.description), 80)
parser_params = dict(help=(self.help or self.description), usage=self.usage,
@@ -79,3 +79,46 @@ class Command(Plugin):
"""
raise NotImplementedError()
+
+
+class Command(Plugin, SubCommand):
+ """
+ Defines a Workload Automation command. This will be executed from the
+ command line as ``wa <command> [args ...]``. This defines the name to be
+ used when invoking wa, the code that will actually be executed on
+ invocation and the argument parser to be used to parse the reset of the
+ command line arguments.
+
+ """
+ kind = "command"
+
+ def __init__(self, subparsers):
+ Plugin.__init__(self)
+ SubCommand.__init__(self, self.logger, subparsers)
+
+
+class ComplexCommand(Command):
+ """
+ A command that defines sub-commands.
+
+ """
+
+ subcmd_classes = []
+
+ def __init__(self, subparsers):
+ self.subcommands = []
+ super(ComplexCommand, self).__init__(subparsers)
+
+ def initialize(self, context):
+ subparsers = self.parser.add_subparsers(dest='what', metavar='SUBCMD')
+ for subcmd_cls in self.subcmd_classes:
+ subcmd = subcmd_cls(self.logger, subparsers)
+ self.subcommands.append(subcmd)
+
+ def execute(self, state, args):
+ for subcmd in self.subcommands:
+ if subcmd.name == args.what:
+ subcmd.execute(state, args)
+ break
+ else:
+ raise CommandError('Not a valid create parameter: {}'.format(args.name))