gaps.cli.command.AbstractBaseCLICommandConfiguration#

class AbstractBaseCLICommandConfiguration(name, add_collect=False, split_keys=None, config_preprocessor=None, skip_doc_params=None)[source]#

Bases: ABC

Abstract Base CLI Command representation.

This base implementation provides helper methods to determine wether a given command is split spatially.

Note that runner is a required part of the interface but is not listed as an abstract property to avoid unnecessary function wrapping.

Methods

Attributes

`documentation`	Documentation object.
`is_split_spatially`	`True` if execution is split spatially across nodes.

property is_split_spatially#

True if execution is split spatially across nodes.

Type:: bool

abstract property documentation#

Documentation object.

Type:: CommandDocumentation