omero.plugins.basics module

load, quit, version, help plugins

Plugin read by omero.cli.Cli during initialization. The method(s) defined here will be added to the Cli class for later use.

The load plugin is used to read in files with omero cli commands (omitting the omero). For example,

./omero load some/file.osh

The help, quit, and version plugins are self-explanatory.

class plugins.basics.ErrorsControl(*args: Any, **kwargs: Any)

Bases: BaseControl

class plugins.basics.HelpControl(*args: Any, **kwargs: Any)

Bases: BaseControl

Defined here since the background loading might be too slow to have all help available

format_title(command, sep='-')

Create heading for command or topic help

print_all_commands_and_topics(args)

Print the help for all commands and topics

print_command_help(control, args)

Print help for a single command and optionally its subcommand

print_commands_list(args)

Print a list of all commands

print_single_command_or_topic(args)

Print the help for a command or a topic

print_usage()

class plugins.basics.LoadControl(*args: Any, **kwargs: Any)

Bases: BaseControl

class plugins.basics.QuitControl(*args: Any, **kwargs: Any)

Bases: BaseControl

class plugins.basics.ShellControl(*args: Any, **kwargs: Any)

Bases: BaseControl

class plugins.basics.VersionControl(*args: Any, **kwargs: Any)

Bases: BaseControl