hostsub_gp.scripts package

hostsub_gp.scripts.hostsub module

class hostsub_gp.scripts.hostsub.HostSub

Bases: ScriptBase

classmethod get_parser()

Construct the command-line argument parser.

Derived classes should override this. Ideally they should use this base-class method to instantiate the ArgumentParser object and then fill in the relevant parser arguments

Warning

Any argument that defaults to the string 'current working directory' will be replaced by the result of os.getcwd() when the script is executed. This means help dialogs will include this replacement, and parsing of the command line will use os.getcwd() as the default. This functionality is largely to allow for PypeIt’s automated documentation of script help dialogs without the “current working” directory being that of the developer that most recently compiled the docs.

main()

Execute the script.

Derived classes should override this to perform the desired.

hostsub_gp.scripts.scriptbase module

class hostsub_gp.scripts.scriptbase.ScriptBase

Bases: object

Base class for scripts.

classmethod entry_point()

Entry point for script.

classmethod get_parser(description: str = None) → ArgumentParser

Construct the command-line argument parser.

Derived classes should override this. Ideally they should use this base-class method to instantiate the ArgumentParser object and then fill in the relevant parser arguments

Warning

Any argument that defaults to the string 'current working directory' will be replaced by the result of os.getcwd() when the script is executed. This means help dialogs will include this replacement, and parsing of the command line will use os.getcwd() as the default. This functionality is largely to allow for PypeIt’s automated documentation of script help dialogs without the “current working” directory being that of the developer that most recently compiled the docs.

static main(args: Namespace)

Execute the script.

Derived classes should override this to perform the desired.

classmethod parse_args(options=None)

Parse the command-line arguments.