Package adams.flow.source

Class AbstractPythonExecution

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.AbstractPythonExecution

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

Direct Known Subclasses:

PipExec, PythonExec, PythonVenvExec

public abstract class AbstractPythonExecution
extends AbstractSource
implements com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Ancestor for sources that execute a Python executable.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PythonEnvironment	m_Environment	the environment in use.
protected IllegalStateException	m_ExecutionFailure	in case an exception occurred executing the command (gets rethrown).
protected RunnableWithLogging	m_Monitor	the runnable executing the command.
protected List	m_Output	the tokens to forward.
protected com.github.fracpete.processoutput4j.core.StreamingProcessOutputType	m_OutputType	whether to output stderr instead of stdout or both.
protected String	m_PrefixStdErr	the stderr prefix.
protected String	m_PrefixStdOut	the stdout prefix.
protected com.github.fracpete.processoutput4j.output.StreamingProcessOutput	m_ProcessOutput	the process monitor.
protected int	m_TimeOut	the time out in seconds.

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
AbstractPythonExecution()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
Class[]	generates()	Returns the class of objects that it generates.
com.github.fracpete.processoutput4j.core.StreamingProcessOutputType	getOutputType()	Returns what output from the process to forward.
String	getPrefixStdErr()	Returns the (optional) prefix to use for output from stderr.
String	getPrefixStdOut()	Returns the (optional) prefix to use for output from stdout.
int	getTimeOut()	Returns the time out for the process.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
protected void	initialize()	Initializes the members.
protected String	launch(List<String> cmd, String workingDir)	Launches the command.
Token	output()	Returns the generated token.
String	outputTypeTipText()	Returns the tip text for this property.
String	prefixStdErrTipText()	Returns the tip text for this property.
String	prefixStdOutTipText()	Returns the tip text for this property.
void	processOutput(String line, boolean stdout)	Adds the line from the output to the internal list of lines to output.
protected void	reset()	Resets the scheme.
void	setOutputType(com.github.fracpete.processoutput4j.core.StreamingProcessOutputType value)	Sets what output from the process to forward.
void	setPrefixStdErr(String value)	Sets the (optional) prefix to use for output from stderr.
void	setPrefixStdOut(String value)	Sets the (optional) prefix to use for output from stdout.
void	setTimeOut(int value)	Sets the time out for the process.
String	setUp()	Initializes the item for flow execution.
void	stopExecution()	Stops the execution.
String	timeOutTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, doExecute, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, 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, globalInfo, 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, getQuickInfo, 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_OutputType

protected com.github.fracpete.processoutput4j.core.StreamingProcessOutputType m_OutputType

whether to output stderr instead of stdout or both.

m_PrefixStdOut

protected String m_PrefixStdOut

the stdout prefix.

m_PrefixStdErr

protected String m_PrefixStdErr

the stderr prefix.

m_Output

protected List m_Output

the tokens to forward.

m_ProcessOutput

protected transient com.github.fracpete.processoutput4j.output.StreamingProcessOutput m_ProcessOutput

the process monitor.

m_Monitor

protected RunnableWithLogging m_Monitor

the runnable executing the command.

m_ExecutionFailure

protected IllegalStateException m_ExecutionFailure

in case an exception occurred executing the command (gets rethrown).

m_TimeOut

protected int m_TimeOut

the time out in seconds.

m_Environment

protected PythonEnvironment m_Environment

the environment in use.

Constructor Detail

AbstractPythonExecution

public AbstractPythonExecution()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractActor

setOutputType

public void setOutputType(com.github.fracpete.processoutput4j.core.StreamingProcessOutputType value)

Sets what output from the process to forward.

Parameters:

value - the output type

getOutputType

public com.github.fracpete.processoutput4j.core.StreamingProcessOutputType getOutputType()

Returns what output from the process to forward.

Specified by:

getOutputType in interface com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Returns:

the output type

outputTypeTipText

public String outputTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPrefixStdOut

public void setPrefixStdOut(String value)

Sets the (optional) prefix to use for output from stdout.

Parameters:

value - the prefix

getPrefixStdOut

public String getPrefixStdOut()

Returns the (optional) prefix to use for output from stdout.

Returns:

the prefix

prefixStdOutTipText

public String prefixStdOutTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPrefixStdErr

public void setPrefixStdErr(String value)

Sets the (optional) prefix to use for output from stderr.

Parameters:

value - the prefix

getPrefixStdErr

public String getPrefixStdErr()

Returns the (optional) prefix to use for output from stderr.

Returns:

the prefix

prefixStdErrTipText

public String prefixStdErrTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setTimeOut

public void setTimeOut(int value)

Sets the time out for the process.

Parameters:

value - the time out in seconds

getTimeOut

public int getTimeOut()

Returns the time out for the process.

Returns:

the time out in seconds

timeOutTipText

public String timeOutTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

java.lang.String.class

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

launch

protected String launch(List<String> cmd,
                        String workingDir)

Launches the command.

Parameters:

cmd - the command and its options

workingDir - the working directory, ignored if empty

Returns:

null if everything is fine, otherwise error message

processOutput

public void processOutput(String line,
                          boolean stdout)

Adds the line from the output to the internal list of lines to output.

Specified by:

processOutput in interface com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Parameters:

line - the line to add

stdout - whether stdout or stderr

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Returns:

true if there is pending output

stopExecution

public void stopExecution()

Stops the execution. No message set.

Specified by:

stopExecution in interface Actor

Specified by:

stopExecution in interface Stoppable

Overrides:

stopExecution in class AbstractActor