ICommand¶

The ICommand abstract class provides…

Using Jupy4Syn Commands ICommand¶

Usage of Python class using basic ICommand fields.

class jupy4syn.commands.ICommand.ICommand[source]¶

args(self, initial_args)[source]¶

Abstract method to get initial arguments of the command. These arguments will be show at the text box (if the text box is enabled for this command, see show()).

Parameters:	initial_args : `str` or `list` The initial arguments that will be show in the text box and will be sent to execution as shell arguments
Returns:	out : `str` Returns a single string with the arguments or its representation

exec(self, parameters)[source]¶

Abstract method to execute the command.

Parameters:	parameters : `str` or `list` The parameters that will be sent to execution as a shell argument
Returns:	None

text_box(self, initial_args)[source]¶

Abstract method check if the command will need a text box and if its text can be modified.

Parameters:	initial_args : `str` or `list` The initial arguments that will be used to check if a text box will be needed.
Returns:	out : `tuple` of `bool` Returns (True, True) if a text box will be needed and if its text can be modified.