Warning
THIS MODULE DOES NOT HAVE STABLE PUBLIC API
Bases: plainbox.impl.clitools.LazyLoadingToolMixIn, plainbox.impl.commands.PlainBoxToolBase
Command line interface to PlainBox
Add top-level subcommands to the argument parser.
Parameters: |
|
---|
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Add top-level subcommands to the argument parser, using a list of hints.
Parameters: |
|
---|
This method tries to optimize the time needed to register and setup all of the subcommands by looking at a list of hints in search for the (likely) command that will be executed.
Things that look like options are ignored. The first element of hint_list that matches a known command name, as provided by meth:get_command_collection(), is used as a sign that that command will be executed and all other commands don’t have to be loaded or initialized. If no hints are found (e.g. when running tool --help) the slower fallback mode is used and all subcommands are added.
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Add top-level subcommands to the argument parser (fallback mode)
Parameters: |
|
---|
This method is called when hint-based optimization cannot be used and all commands need to be loaded and initialized.
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Create a parser that captures some of the early data we need to be able to have a real parser and initialize the rest.
Do very early initialization. This is where we initialize stuff even without seeing a shred of command line data or anything else.
Do some final initialization just before the command gets dispatched. This is empty here but maybe useful for subclasses.
Get the Config class that is used by this implementation.
This can be overridden by subclasses to use a different config class that is suitable for the particular application.
Initialize with early command line arguments being already parsed
Run as if invoked from command line directly
Setup i18n and l10n system.
Bases: plainbox.impl.box.PlainBoxTool
Command line interface to StubBox
The ‘stubbox’ executable is just just like plainbox but it contains the special stubbox provider with representative test jobs.
Add top-level subcommands to the argument parser.
Parameters: |
|
---|
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Add top-level subcommands to the argument parser, using a list of hints.
Parameters: |
|
---|
This method tries to optimize the time needed to register and setup all of the subcommands by looking at a list of hints in search for the (likely) command that will be executed.
Things that look like options are ignored. The first element of hint_list that matches a known command name, as provided by meth:get_command_collection(), is used as a sign that that command will be executed and all other commands don’t have to be loaded or initialized. If no hints are found (e.g. when running tool --help) the slower fallback mode is used and all subcommands are added.
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Add top-level subcommands to the argument parser (fallback mode)
Parameters: |
|
---|
This method is called when hint-based optimization cannot be used and all commands need to be loaded and initialized.
Note
This method is customized by LazyLoadingToolMixIn and should not be overriden directly. To register your commands use get_command_collection()
Create a parser that captures some of the early data we need to be able to have a real parser and initialize the rest.
Do very early initialization. This is where we initialize stuff even without seeing a shred of command line data or anything else.
Do some final initialization just before the command gets dispatched. This is empty here but maybe useful for subclasses.
Get the Config class that is used by this implementation.
This can be overridden by subclasses to use a different config class that is suitable for the particular application.
Get the version reported by this executable
Initialize with early command line arguments being already parsed
Run as if invoked from command line directly
Setup i18n and l10n system.