Package adams.flow.source
Class PythonVenvExec
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<Actor>
,SizeOfHandler
,Stoppable
,StoppableWithFeedback
,VariablesInspectionHandler
,VariableChangeListener
,Actor
,ErrorHandler
,OutputProducer
,com.github.fracpete.processoutput4j.core.StreamingProcessOwner
,Serializable
,Comparable
public class PythonVenvExec extends AbstractPythonExecution
Executes the specified executable in a Python virtual environment with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.
Fails if the specified environment does not contain any 'activate' scripts typically found in such directories.
Input/output:
- generates:
java.lang.String
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: PythonVenvExec
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors. default: false
-silent <boolean> (property: silent) If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well. default: false
-output-type <STDOUT|STDERR|BOTH> (property: outputType) Determines the output type; if BOTH is selected then an array is output with stdout as first element and stderr as second default: STDOUT
-prefix-stdout <java.lang.String> (property: prefixStdOut) The (optional) prefix to use for output from stdout. default:
-prefix-stderr <java.lang.String> (property: prefixStdErr) The (optional) prefix to use for output from stderr. default:
-time-out <int> (property: timeOut) The maximum time in seconds for the process to run before getting killed, ignored if less than 1. default: -1 minimum: -1
-executable <java.lang.String> (property: executable) The executable from the virtual environment to run (no path). default: python
-executable-options <adams.core.base.BaseText> (property: executableOptions) The command-line options for the executable. default:
-working-directory <java.lang.String> (property: workingDirectory) The current working directory for the command. default:
-placeholder <boolean> (property: optionsContainPlaceholder) Set this to true to enable automatic placeholder expansion for the option string. default: false
-variable <boolean> (property: optionsContainVariable) Set this to true to enable automatic variable expansion for the option string. default: false
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
m_Executable
the executable to run.protected BaseText
m_ExecutableOptions
the options for the executable.protected boolean
m_OptionsContainPlaceholder
whether the options contain placeholders, which need to be expanded first.protected boolean
m_OptionsContainVariable
whether the options contain variables, which need to be expanded first.protected String
m_WorkingDirectory
the current working directory.-
Fields inherited from class adams.flow.source.AbstractPythonExecution
m_Environment, m_ExecutionFailure, m_Monitor, m_Output, m_OutputType, m_PrefixStdErr, m_PrefixStdOut, m_ProcessOutput, m_TimeOut
-
Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ
-
-
Constructor Summary
Constructors Constructor Description PythonVenvExec()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected String
doExecute()
Executes the flow item.String
executableOptionsTipText()
Returns the tip text for this property.String
executableTipText()
Returns the tip text for this property.String
getExecutable()
Returns the executable from the virtualenv to run.BaseText
getExecutableOptions()
Returns the command-line options for the executable.boolean
getOptionsContainPlaceholder()
Returns whether the option string contains placeholders which need to be expanded first.boolean
getOptionsContainVariable()
Returns whether the option string contains variables which need to be expanded first.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.String
getWorkingDirectory()
Returns the current working directory for the command.String
globalInfo()
Returns a string describing the object.String
optionsContainPlaceholderTipText()
Returns the tip text for this property.String
optionsContainVariableTipText()
Returns the tip text for this property.void
setExecutable(String value)
Sets the executable from the virtualenv to run.void
setExecutableOptions(BaseText value)
Sets the command-line options for the executable.void
setOptionsContainPlaceholder(boolean value)
Sets whether the option string contains placeholders which need to be expanded first.void
setOptionsContainVariable(boolean value)
Sets whether the option string contains variables which need to be expanded first.void
setWorkingDirectory(String value)
Sets the current working directory for the command.String
workingDirectoryTipText()
Returns the tip text for this property.-
Methods inherited from class adams.flow.source.AbstractPythonExecution
generates, getOutputType, getPrefixStdErr, getPrefixStdOut, getTimeOut, hasPendingOutput, initialize, launch, output, outputTypeTipText, prefixStdErrTipText, prefixStdOutTipText, processOutput, reset, setOutputType, setPrefixStdErr, setPrefixStdOut, setTimeOut, setUp, stopExecution, timeOutTipText
-
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.flow.core.Actor
cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, toCommandLine, variableChanged, wrapUp
-
Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager
-
Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions
-
-
-
-
Field Detail
-
m_Executable
protected String m_Executable
the executable to run.
-
m_ExecutableOptions
protected BaseText m_ExecutableOptions
the options for the executable.
-
m_WorkingDirectory
protected String m_WorkingDirectory
the current working directory.
-
m_OptionsContainPlaceholder
protected boolean m_OptionsContainPlaceholder
whether the options contain placeholders, which need to be expanded first.
-
m_OptionsContainVariable
protected boolean m_OptionsContainVariable
whether the options contain variables, which need to be expanded first.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractPythonExecution
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceActor
- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractActor
- Returns:
- null if no info available, otherwise short string
-
setExecutable
public void setExecutable(String value)
Sets the executable from the virtualenv to run.- Parameters:
value
- the executable
-
getExecutable
public String getExecutable()
Returns the executable from the virtualenv to run.- Returns:
- the executable
-
executableTipText
public String executableTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setExecutableOptions
public void setExecutableOptions(BaseText value)
Sets the command-line options for the executable.- Parameters:
value
- the options
-
getExecutableOptions
public BaseText getExecutableOptions()
Returns the command-line options for the executable.- Returns:
- the options
-
executableOptionsTipText
public String executableOptionsTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setWorkingDirectory
public void setWorkingDirectory(String value)
Sets the current working directory for the command.- Parameters:
value
- the directory, ignored if empty
-
getWorkingDirectory
public String getWorkingDirectory()
Returns the current working directory for the command.- Returns:
- the directory, ignored if empty
-
workingDirectoryTipText
public String workingDirectoryTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOptionsContainPlaceholder
public void setOptionsContainPlaceholder(boolean value)
Sets whether the option string contains placeholders which need to be expanded first.- Parameters:
value
- true if option string contains placeholders
-
getOptionsContainPlaceholder
public boolean getOptionsContainPlaceholder()
Returns whether the option string contains placeholders which need to be expanded first.- Returns:
- true if command string contains placeholders
-
optionsContainPlaceholderTipText
public String optionsContainPlaceholderTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOptionsContainVariable
public void setOptionsContainVariable(boolean value)
Sets whether the option string contains variables which need to be expanded first.- Parameters:
value
- true if option string contains variables
-
getOptionsContainVariable
public boolean getOptionsContainVariable()
Returns whether the option string contains variables which need to be expanded first.- Returns:
- true if option string contains variables
-
optionsContainVariableTipText
public String optionsContainVariableTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecute
in classAbstractActor
- Returns:
- null if everything is fine, otherwise error message
-
-