1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 10:51:13 +01:00
workload-automation/wa/commands/list.py
2018-07-06 14:39:41 +01:00

128 lines
4.4 KiB
Python

# Copyright 2014-2018 ARM Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from wa import Command
from wa.framework import pluginloader
from wa.framework.target.descriptor import list_target_descriptions
from wa.utils.doc import get_summary
from wa.utils.formatter import DescriptionListFormatter
class ListCommand(Command):
name = 'list'
description = 'List available WA plugins with a short description of each.'
def initialize(self, context):
kinds = get_kinds()
kinds.extend(['augmentations', 'all'])
self.parser.add_argument('kind', metavar='KIND',
help=('Specify the kind of plugin to list. Must be '
'one of: {}'.format(', '.join(sorted(kinds)))),
choices=sorted(kinds))
self.parser.add_argument('-n', '--name',
help='Filter results by the name specified')
self.parser.add_argument('-o', '--packaged-only', action='store_true',
help='''
Only list plugins packaged with WA itself. Do
not list plugins installed locally or from
other packages.
''')
self.parser.add_argument('-p', '--platform',
help='''
Only list results that are supported by the
specified platform.
''')
# pylint: disable=superfluous-parens
def execute(self, state, args):
filters = {}
if args.name:
filters['name'] = args.name
if args.kind == 'targets':
list_targets()
elif args.kind == 'augmentations':
print('instruments:')
args.kind = 'instruments'
list_plugins(args, filters)
print('\noutput processors:')
args.kind = 'output_processors'
list_plugins(args, filters)
elif args.kind == 'all':
for kind in sorted(get_kinds()):
print('\n{}:'.format(kind))
if kind == 'targets':
list_targets()
else:
args.kind = kind
list_plugins(args, filters)
else:
list_plugins(args, filters)
def get_kinds():
kinds = pluginloader.kinds
if 'target_descriptor' in kinds:
kinds.remove('target_descriptor')
kinds.append('target')
return ['{}s'.format(name) for name in kinds]
# pylint: disable=superfluous-parens
def list_targets():
targets = list_target_descriptions()
targets = sorted(targets, key=lambda x: x.name)
output = DescriptionListFormatter()
for target in targets:
output.add_item(target.description or '', target.name)
print(output.format_data())
print('')
def list_plugins(args, filters):
results = pluginloader.list_plugins(args.kind[:-1])
if filters or args.platform:
filtered_results = []
for result in results:
passed = True
for k, v in filters.items():
if getattr(result, k) != v:
passed = False
break
if passed and args.platform:
passed = check_platform(result, args.platform)
if passed:
filtered_results.append(result)
else: # no filters specified
filtered_results = results
if filtered_results:
output = DescriptionListFormatter()
for result in sorted(filtered_results, key=lambda x: x.name):
output.add_item(get_summary(result), result.name)
print(output.format_data())
print('')
def check_platform(plugin, platform):
supported_platforms = getattr(plugin, 'supported_platforms', [])
if supported_platforms:
return platform in supported_platforms
return True