CommandSetup

class biotite.application_v2.CommandSetup(*, evaluate: Callable[[bytes, bytes], T], parameters: Sequence[CLIParameter] = (), cleanup: Callable[[], None] | None = None, input: bytes | None = None, exec_dir: PathLike[str] | str | None = None)

Bases: Generic[T]

The specification of a single command line run.

A LocalApp method decorated with command() returns a CommandSetup, which the decorator turns into a launched LocalProcessFuture.

Attributes:

evaluatecallable

A callable parsing the finished run into its result object. It is passed the captured standard output and standard error as raw bytes.

parameterssequence of CLIParameter, optional

The command line flags, options and arguments.

cleanupcallable, optional

A zero-argument callable releasing resources of the run.

inputbytes, optional

Bytes written to the standard input of the run.

exec_dirstr or Path, optional

The working directory of the run.