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

Jump to bottom

include alternative names of easyconfig parameters in output of --avail-easyconfig-params #4549

Merged
merged 2 commits into from
Jun 17, 2024
Merged

include alternative names of easyconfig parameters in output of --avail-easyconfig-params #4549

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70a672a
include alternative names of easyconfig parameters in output of --ava…
boegel Jun 5, 2024
2b7fb6d
use alternative instead of alternate
jfgrimm Jun 17, 2024
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
37 changes: 26 additions & 11 deletions easybuild/tools/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from easybuild.framework.easyconfig.constants import EASYCONFIG_CONSTANTS
from easybuild.framework.easyconfig.easyconfig import get_easyblock_class, process_easyconfig
from easybuild.framework.easyconfig.licenses import EASYCONFIG_LICENSES_DICT
from easybuild.framework.easyconfig.parser import EasyConfigParser
from easybuild.framework.easyconfig.parser import ALTERNATE_PARAMETERS, EasyConfigParser
jfgrimm marked this conversation as resolved.
Show resolved Hide resolved
from easybuild.framework.easyconfig.templates import TEMPLATE_CONSTANTS, TEMPLATE_NAMES_CONFIG, TEMPLATE_NAMES_DYNAMIC
from easybuild.framework.easyconfig.templates import TEMPLATE_NAMES_EASYBLOCK_RUN_STEP, TEMPLATE_NAMES_EASYCONFIG
from easybuild.framework.easyconfig.templates import TEMPLATE_NAMES_LOWER, TEMPLATE_NAMES_LOWER_TEMPLATE
Expand Down Expand Up @@ -315,7 +315,7 @@ def avail_easyconfig_licenses_md():
return '\n'.join(doc)


def avail_easyconfig_params_md(title, grouped_params):
def avail_easyconfig_params_md(title, grouped_params, alternative_params):
"""
Compose overview of available easyconfig parameters, in MarkDown format.
"""
Expand All @@ -328,13 +328,14 @@ def avail_easyconfig_params_md(title, grouped_params):
for grpname in grouped_params:
# group section title
title = "%s%s parameters" % (grpname[0].upper(), grpname[1:])
table_titles = ["**Parameter name**", "**Description**", "**Default value**"]
table_titles = ["**Parameter name**", "**Description**", "**Default value**", "**Alternative name**"]
keys = sorted(grouped_params[grpname].keys())
values = [grouped_params[grpname][key] for key in keys]
table_values = [
['`%s`' % name for name in keys], # parameter name
[x[0].replace('<', '&lt;').replace('>', '&gt;') for x in values], # description
['`' + str(quote_str(x[1])) + '`' for x in values] # default value
['`' + str(quote_str(x[1])) + '`' for x in values], # default value
['`%s`' % alternative_params[name] if name in alternative_params else '' for name in keys],
]

doc.extend(md_title_and_table(title, table_titles, table_values, title_level=2))
Expand All @@ -343,7 +344,7 @@ def avail_easyconfig_params_md(title, grouped_params):
return '\n'.join(doc)


def avail_easyconfig_params_rst(title, grouped_params):
def avail_easyconfig_params_rst(title, grouped_params, alternative_params):
"""
Compose overview of available easyconfig parameters, in RST format.
"""
Expand All @@ -357,13 +358,14 @@ def avail_easyconfig_params_rst(title, grouped_params):
for grpname in grouped_params:
# group section title
title = "%s parameters" % grpname
table_titles = ["**Parameter name**", "**Description**", "**Default value**"]
table_titles = ["**Parameter name**", "**Description**", "**Default value**", "**Alternative name**"]
keys = sorted(grouped_params[grpname].keys())
values = [grouped_params[grpname][key] for key in keys]
table_values = [
['``%s``' % name for name in keys], # parameter name
[x[0] for x in values], # description
[str(quote_str(x[1])) for x in values] # default value
[str(quote_str(x[1])) for x in values], # default value
['``%s``' % alternative_params[name] if name in alternative_params else '' for name in keys],
]

doc.extend(rst_title_and_table(title, table_titles, table_values))
Expand All @@ -372,14 +374,14 @@ def avail_easyconfig_params_rst(title, grouped_params):
return '\n'.join(doc)


def avail_easyconfig_params_json():
def avail_easyconfig_params_json(*args):
"""
Compose overview of available easyconfig parameters, in json format.
"""
raise NotImplementedError("JSON output format not supported for avail_easyconfig_params_json")


def avail_easyconfig_params_txt(title, grouped_params):
def avail_easyconfig_params_txt(title, grouped_params, alternative_params):
"""
Compose overview of available easyconfig parameters, in plain text format.
"""
Expand All @@ -399,7 +401,17 @@ def avail_easyconfig_params_txt(title, grouped_params):

# line by parameter
for name, (descr, dflt) in sorted(grouped_params[grpname].items()):
doc.append("{0:<{nw}} {1:} [default: {2:}]".format(name, descr, str(quote_str(dflt)), nw=nw))
line = ' '.join([
'{0:<{nw}} ',
'{1:}',
'[default: {2:}]',
]).format(name, descr, str(quote_str(dflt)), nw=nw)

alternative = alternative_params.get(name)
if alternative:
line += ' {alternative: %s}' % alternative

doc.append(line)
doc.append('')

return '\n'.join(doc)
Expand All @@ -418,6 +430,9 @@ def avail_easyconfig_params(easyblock, output_format=FORMAT_TXT):
extra_params = app.extra_options()
params.update(extra_params)

# reverse mapping of alternative easyconfig parameter names
alternative_params = {v: k for k, v in ALTERNATE_PARAMETERS.items()}
jfgrimm marked this conversation as resolved.
Show resolved Hide resolved

# compose title
title = "Available easyconfig parameters"
if extra_params:
Expand All @@ -443,7 +458,7 @@ def avail_easyconfig_params(easyblock, output_format=FORMAT_TXT):
del grouped_params[grpname]

# compose output, according to specified format (txt, rst, ...)
return generate_doc('avail_easyconfig_params_%s' % output_format, [title, grouped_params])
return generate_doc('avail_easyconfig_params_%s' % output_format, [title, grouped_params, alternative_params])


def avail_easyconfig_templates(output_format=FORMAT_TXT):
Expand Down
Loading