Login
Back to bricks list
Introduction Version

ShellProxy

Shell task proxy.

This class is a proxy to Shell commandes. It allow running commands in a shell and get the output and stdout.

Attributes

working_dir: str

Functions

__INIT__

summary

                If not provided, an new temp directory is created. defaults to None
                      Can be useful to log command outputs in task's logs. defaults to None
Parameters:
NameTypeDefault valueDescription
working_dirstr Working directory for the shell (all command will be executed from this dir). , optional
message_dispatcherMessageDispatcher If provided, the output of the command will be redirected to the dispatcher. , optional
ATTACH_OBSERVER

Attach a custom observer to the shell proxy. The logs of the proxy will be dispatch to the observer

Parameters:
NameTypeDefault valueDescription
observerMessageObserver
ATTACH_PROGRESS_BAR

Attach a progress_bar to the shell proxy. The logs of the proxy will be dispatch to the progress_bar logs

Parameters:
NameTypeDefault valueDescription
progress_barProgressBar
CHECK_OUTPUT

Run a command in a shell and return the output.

:raises Exception: description

Parameters:
NameTypeDefault valueDescription
cmdUnion Command to run [list, str]
envdict Environment variables to pass to the shell, defaults to none , optional
shell_modebool False If true, the command is run in a shell, defaults to false , optional
textbool True If true, the output is returned as a string, defaults to true , optional
Return type:
Any
CLEAN_WORKING_DIR
DISPATCH_WAITING_MESSAGES
GET_MESSAGE_DISPATCHER

Get the message dispatcher

Return type:
MessageDispatcher
LOG_ERROR_MESSAGE

Log an error message using the dispatcher

Parameters:
NameTypeDefault valueDescription
messagestr
LOG_INFO_MESSAGE

Log an info message using the dispatcher

Parameters:
NameTypeDefault valueDescription
messagestr
LOG_WARNING_MESSAGE

Log a warining message using the dispatcher

Parameters:
NameTypeDefault valueDescription
messagestr
RUN

Run a command in a shell. The logs of the command will be dispatched to the message dispatcher during the execution.

Parameters:
NameTypeDefault valueDescription
cmdUnion Command to run [list, str]
envdict Environment variables to pass to the shell, defaults to none , optional
shell_modebool False If true, the command is run in a shell, defaults to false , optional
Return type:
int