Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

verdi plugin list: Show full help for input and output ports #5711

Merged
merged 2 commits into from
Oct 24, 2022
Merged

verdi plugin list: Show full help for input and output ports #5711

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6a0f52
`verdi plugin list`: Show full help for input and output ports
sphuber Oct 21, 2022
3bae980
Add wrapping for exit code messages.
sphuber Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 27 additions & 29 deletions aiida/cmdline/utils/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import logging
import os
import sys
import textwrap
from typing import TYPE_CHECKING

from click import style
Expand Down Expand Up @@ -408,17 +409,11 @@ def print_process_info(process):
"""
docstring = process.__doc__

if docstring is not None:
docstring = docstring.strip().split('\n')

if not docstring:
docstring = ['No description available']
if docstring is None or docstring.strip() is None:
docstring = 'No description available'

echo.echo('Description:\n', fg=echo.COLORS['report'], bold=True)
for line in docstring:
echo.echo(f' {line.lstrip()}')
echo.echo('')

echo.echo(textwrap.indent('\n'.join(textwrap.wrap(docstring, 100)), ' '))
print_process_spec(process.spec())


Expand All @@ -443,37 +438,40 @@ def build_entries(ports):

valid_types = port.valid_type if isinstance(port.valid_type, (list, tuple)) else (port.valid_type,)
valid_types = ', '.join([valid_type.__name__ for valid_type in valid_types if valid_type is not None])
required = 'required' if port.required else 'optional'
info = port.help if port.help is not None else ''
info = f'{info[:75]} ...' if len(info) > 75 else info
result.append([name, required, valid_types, info])
info = textwrap.wrap(port.help if port.help is not None else '', width=75)
result.append([name, port.required, valid_types, info])

return result

template = '{:>{width_name}s}: {:10s}{:{width_type}}{}'
inputs = build_entries(process_spec.inputs)
outputs = build_entries(process_spec.outputs)
max_width_name = max([len(entry[0]) for entry in inputs + outputs]) + 2
max_width_type = max([len(entry[2]) for entry in inputs + outputs]) + 2

if process_spec.inputs:
echo.echo('Inputs:', fg=echo.COLORS['report'], bold=True)
for entry in inputs:
if entry[1] == 'required':
echo.echo(template.format(*entry, width_name=max_width_name, width_type=max_width_type), bold=True)
else:
echo.echo(template.format(*entry, width_name=max_width_name, width_type=max_width_type))
echo.echo('\nInputs:', fg=echo.COLORS['report'], bold=True)

table = []

for name, required, valid_types, info in inputs:
table.append((style(name, bold=required, fg='red' if required else 'white'), valid_types, '\n'.join(info)))

if table:
echo.echo(tabulate(table, tablefmt='plain', colalign=('right',)))
echo.echo(style('\nRequired inputs are displayed in bold red.\n', italic=True))

if process_spec.outputs:
echo.echo('Outputs:', fg=echo.COLORS['report'], bold=True)
for entry in outputs:
if entry[1] == 'required':
echo.echo(template.format(*entry, width_name=max_width_name, width_type=max_width_type), bold=True)
else:
echo.echo(template.format(*entry, width_name=max_width_name, width_type=max_width_type))

table = []

for name, required, valid_types, info in outputs:
table.append((style(name, bold=required, fg='red' if required else 'white'), valid_types, '\n'.join(info)))

if table:
echo.echo(tabulate(table, tablefmt='plain', colalign=('right',)))
echo.echo(style('\nRequired outputs are displayed in bold red.\n', italic=True))

if process_spec.exit_codes:
echo.echo('\nExit codes:\n', fg=echo.COLORS['report'], bold=True)
echo.echo('Exit codes:\n', fg=echo.COLORS['report'], bold=True)

table = [('0', 'The process finished successfully.')]

Expand All @@ -482,7 +480,7 @@ def build_entries(ports):
status = style(exit_code.status, bold=True, fg='red')
else:
status = exit_code.status
table.append((status, exit_code.message))
table.append((status, '\n'.join(textwrap.wrap(exit_code.message, width=75))))

echo.echo(tabulate(table, tablefmt='plain'))
echo.echo(style('\nExit codes that invalidate the cache are marked in bold red.\n', italic=True))
Expand Down