armi.cli.entryPoint module

EntryPoint base classes.

See Entry Points.

class armi.cli.entryPoint.EntryPoint

Bases: object

Generic command line entry point.

A valid subclass must provide at least a name class attribute, and may also specify the other class attributes described below.

Implementation: Generic CLI base class for developers to use. I_ARMI_CLI_GEN

signature: EntryPoint requirements: R_ARMI_CLI_GEN

Provides a base class for plugin developers to use in creating application-specific CLIs. Valid subclasses must at least provide a name class attribute. Optional class attributes that a subclass may provide include description, a string describing the command’s actions, splash, a boolean specifying whether to display a splash screen upon execution, and settingsArgument. If settingsArgument is specified as required, then a settings files is a required positional argument. If settingsArgument is set to optional, then a settings file is an optional positional argument. If None is specified for the settingsArgument, then no settings file argument is added.

name: str | None = None

The <command-name> that is used to call the command from the command line

description: str | None = None

A string summarizing the command’s actions. This is summary that is printed when you run python -m armi –list-commands or python -m armi <command-name> –help. If not provided, the docstring of the decorated class will be used instead. In general, the docstring is probably sufficient but this argument allows you to provide a short description of the command while retaining a long and detailed docstring.

settingsArgument: str | None = None

One of {‘optional’, ‘required’, None}, or unspecified. Specifies whether a settings file argument is to be added to the command’s argument parser. If settingsArgument == ‘required’, then a settings file is a required positional argument. If settingsArgument == ‘optional’, then it is an optional positional argument. Finally, if settingsArgument is None, then no settings file argument is added.

splash = True

Whether running the entry point should produce a splash text upon executing.

Setting this to False is useful for utility commands that produce standard output that would be needlessly cluttered by the splash text.

mode: int | None = None

One of {armi.Mode.BATCH, armi.Mode.INTERACTIVE, armi.Mode.GUI}, optional. Specifies the ARMI mode in which the command is run. Default is armi.Mode.BATCH.

addOptions()

Add additional command line options.

Values of options added to self.parser will be available on self.args. Values added with createOptionFromSetting will override the setting values in the settings input file.

See also

createOptionFromSetting

A method often called from here to creat CLI options from application settings.

argparse.ArgumentParser.add_argument

Often called from here using self.parser.add_argument to add custom argparse arguments.

parse_args(args)

parse(args)

Parse the command line arguments, with the command specific arguments.

invoke() → int | None

Body of the entry point.

This is an abstract method, and must must be overridden in sub-classes.

Returns:

exitcode – Implementations should return an exit code, or None, which is interpreted the same as zero (successful completion).

Return type:

int or None

createOptionFromSetting(settingName: str, additionalAlias: str = None, suppressHelp: bool = False)

Create a CLI option from an ARMI setting.

This will override whatever is in the settings file.

Parameters:

• settingName (str) – the setting name

• additionalAlises (str) – additional alias for the command line option, be careful and make sure they are all distinct!

• supressHelp (bool) – option to suppress the help message when using the command line --help function. This is particularly beneficial when many options are being added as they can clutter the --help to be almost unusable.

armi.cli.entryPoint.storeBool(boolDefault, ep)

armi.cli.entryPoint.setSetting(ep)

armi.cli.entryPoint.setCaseTitle(cs)

armi.cli.entryPoint.loadSettings(cs)