nunavut.cli

Command-line for using nunavut and jinja to generate code from dsdl definitions.

nunavut.cli.main() → int[source]

Main entry point for this program.

Submodules

nunavut.cli.runners

Objects that utilize command-line inputs to run a program using Nunavut.

class nunavut.cli.runners.ArgparseRunner(args: argparse.Namespace, extra_includes: Union[str, List[str], None])[source]

Bases: object

Runner that uses Python argparse arguments to define a run.

Parameters:
  • args (argparse.Namespace) – The commandline arguments.
  • typing.List[str]]] extra_includes (typing.Optional[typing.Union[str,) – A list of paths to additional DSDL root folders.
extra_includes
generator
support_generator
root_namespace
setup() → None[source]

Required to prepare this object to run (run method will raise exceptions if called before this method). While this may seem a bit clunky it helps isolate errors to two distinct stages; setup and run.

Setup never generates anything. It only parses the inputs and creates the generator arguments.

run() → None[source]

Perform actions defined by the arguments this object was created with. This may generate outputs where the arguments have requested this action.

Warning

setup() must be called before calling this method.