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 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.

    • Constructor Detail

      • PythonVenvExec

        public PythonVenvExec()

    • Method Detail

      • 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 class AbstractActor
        Returns:
        null if everything is fine, otherwise error message