armi.cli.cleanTemps module

class armi.cli.cleanTemps.CleanTemps

Bases: armi.cli.entryPoint.EntryPoint

Delete all temp directories created by any ARMI run.

Useful for occasionally cleaning temporary dirs from crashed runs.

Warning

This will break any ongoing runs.

name: Optional[str] = 'clean-temps'

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

invoke()

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

settingsArgument: Optional[str] = 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.