mirror of
https://github.com/ARM-software/workload-automation.git
synced 2024-10-06 19:01:15 +01:00
544f5f0b92
terminalsize was loaded from a location added to sys.path during bootstrap. This appeared to be causing import issues. There is no longer a good reason for terminalsize to be loaded that way, so just moved it under wlauto.utils so that it can be loaded normally.
103 lines
3.8 KiB
Python
103 lines
3.8 KiB
Python
# Copyright 2014-2015 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.
|
|
#
|
|
|
|
|
|
import sys
|
|
import subprocess
|
|
from cStringIO import StringIO
|
|
|
|
from wlauto import Command, ExtensionLoader, settings
|
|
from wlauto.utils.doc import (get_summary, get_description, get_type_name, format_column, format_body,
|
|
format_paragraph, indent, strip_inlined_text)
|
|
from wlauto.utils.misc import get_pager
|
|
from wlauto.utils.terminalsize import get_terminal_size
|
|
|
|
|
|
class ShowCommand(Command):
|
|
|
|
name = 'show'
|
|
|
|
description = """
|
|
Display documentation for the specified extension (workload, instrument, etc.).
|
|
"""
|
|
|
|
def initialize(self):
|
|
self.parser.add_argument('name', metavar='EXTENSION',
|
|
help='''The name of the extension for which information will
|
|
be shown.''')
|
|
|
|
def execute(self, args):
|
|
# pylint: disable=unpacking-non-sequence
|
|
ext_loader = ExtensionLoader(packages=settings.extension_packages, paths=settings.extension_paths)
|
|
extension = ext_loader.get_extension_class(args.name)
|
|
out = StringIO()
|
|
term_width, term_height = get_terminal_size()
|
|
format_extension(extension, out, term_width)
|
|
text = out.getvalue()
|
|
pager = get_pager()
|
|
if len(text.split('\n')) > term_height and pager:
|
|
sp = subprocess.Popen(pager, stdin=subprocess.PIPE)
|
|
sp.communicate(text)
|
|
else:
|
|
sys.stdout.write(text)
|
|
|
|
|
|
def format_extension(extension, out, width):
|
|
format_extension_name(extension, out)
|
|
out.write('\n')
|
|
format_extension_summary(extension, out, width)
|
|
out.write('\n')
|
|
if extension.parameters:
|
|
format_extension_parameters(extension, out, width)
|
|
out.write('\n')
|
|
format_extension_description(extension, out, width)
|
|
|
|
|
|
def format_extension_name(extension, out):
|
|
out.write('\n{}\n'.format(extension.name))
|
|
|
|
|
|
def format_extension_summary(extension, out, width):
|
|
out.write('{}\n'.format(format_body(strip_inlined_text(get_summary(extension)), width)))
|
|
|
|
|
|
def format_extension_description(extension, out, width):
|
|
# skip the initial paragraph of multi-paragraph description, as already
|
|
# listed above.
|
|
description = get_description(extension).split('\n\n', 1)[-1]
|
|
out.write('{}\n'.format(format_body(strip_inlined_text(description), width)))
|
|
|
|
|
|
def format_extension_parameters(extension, out, width, shift=4):
|
|
out.write('parameters:\n\n')
|
|
param_texts = []
|
|
for param in extension.parameters:
|
|
description = format_paragraph(strip_inlined_text(param.description or ''), width - shift)
|
|
param_text = '{}'.format(param.name)
|
|
if param.mandatory:
|
|
param_text += " (MANDATORY)"
|
|
param_text += '\n{}\n'.format(description)
|
|
param_text += indent('type: {}\n'.format(get_type_name(param.kind)))
|
|
if param.allowed_values:
|
|
param_text += indent('allowed values: {}\n'.format(', '.join(map(str, param.allowed_values))))
|
|
elif param.constraint:
|
|
param_text += indent('constraint: {}\n'.format(get_type_name(param.constraint)))
|
|
if param.default:
|
|
param_text += indent('default: {}\n'.format(param.default))
|
|
param_texts.append(indent(param_text, shift))
|
|
|
|
out.write(format_column('\n'.join(param_texts), width))
|
|
|