weka.knowledgeflow.steps

Class PythonScriptExecutor

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.PythonScriptExecutor

All Implemented Interfaces:

java.io.Serializable, weka.knowledgeflow.steps.BaseStepExtender, weka.knowledgeflow.steps.Step

@KFStep(name="PythonScriptExecutor",
        category="Scripting",
        toolTipText="CPython scripting step",
        iconPath="weka/gui/knowledgeflow/icons/PythonScriptExecutor.gif")
public class PythonScriptExecutor
extends weka.knowledgeflow.steps.BaseStep

Knowledge flow step (new knowledge flow) for executing a CPython script

Version:

$Revision: $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PythonScriptExecutor()

Method Summary

Modifier and Type	Method and Description
boolean	getContinueOnSysErr() Get whether to try and continue after seeing output on the sys error stream.
java.lang.String	getCustomEditorForStep()
boolean	getDebug() Get whether to output debugging info (both client and server side)
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get the incoming connection types we can accept at the given time
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get the outgoing connection types we can produce at the given time
java.lang.String	getPythonCommand()
java.lang.String	getPythonPathEntries() Get additional entries needed in the PATH for the specified python executable to work properly.
java.lang.String	getPythonScript() Get the python script to execute.
java.io.File	getScriptFile() Get the filename of the script to load at runtime
java.lang.String	getServerID() Get an optional server name by which to identify the python server to use.
java.lang.String	getVariablesToGetFromPython() Get the list of variables to retrieve from python.
void	processIncoming(weka.knowledgeflow.Data data) Process incoming instances
void	setContinueOnSysErr(boolean c) Set whether to try and continue after seeing output on the sys error stream.
void	setDebug(boolean debug) Set whether to output debugging info (both client and server side)
void	setPythonCommand(java.lang.String pyCommand) Set the python command to use.
void	setPythonPathEntries(java.lang.String pythonPathEntries) Set additional entries needed in the PATH for the specified python executable to work properly.
void	setPythonScript(java.lang.String script) Set the python script to execute.
void	setScriptFile(java.io.File scriptFile) Set the filename containing the script to be loaded at runtime
void	setServerID(java.lang.String serverID) Set an optional server name by which to identify the python server to use.
void	setVariablesToGetFromPython(java.lang.String varsToGet) Set the variables to retrieve from python
void	start() Executed if we are operating as a start point
void	stepInit() Initialize the step

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PythonScriptExecutor

public PythonScriptExecutor()

Method Detail

setContinueOnSysErr

public void setContinueOnSysErr(boolean c)

Set whether to try and continue after seeing output on the sys error stream. Some schemes write warnings (rather than errors) to sys error.

Parameters:

c - true if we should try to continue after seeing output on the sys error stream

getContinueOnSysErr

@OptionMetadata(displayName="Try to continue after sys err output from script",
                description="Try to continue after sys err output from script.\nSome schemes report warnings to the system error stream.",
                displayOrder=5)
public boolean getContinueOnSysErr()

Get whether to try and continue after seeing output on the sys error stream. Some schemes write warnings (rather than errors) to sys error.

Returns:

true if we should try to continue after seeing output on the sys error stream

setDebug

@OptionMetadata(displayName="Output debugging info from python",
                description="Whether to output debugging info from python",
                displayOrder=10)
public void setDebug(boolean debug)

Set whether to output debugging info (both client and server side)

Parameters:

debug - true if debugging info is to be output

getDebug

public boolean getDebug()

Get whether to output debugging info (both client and server side)

Returns:

true if debugging info is to be output

setPythonCommand

@OptionMetadata(displayName="Python command ",
                description="Path to python executable (empty string or \'default\' to use python in the PATH)",
                displayOrder=1)
public void setPythonCommand(java.lang.String pyCommand)

Set the python command to use. Empty string or "default" indicate that the python present in the PATH should be used.

Parameters:

pyCommand - the path to the python executable (or empty string/"default" to use python in the PATH)

getPythonCommand

public java.lang.String getPythonCommand()

setPythonPathEntries

@OptionMetadata(displayName="Python path",
                description="(Optional) path entries needed for python to execute correctly; only required when not using default python",
                displayOrder=2)
public void setPythonPathEntries(java.lang.String pythonPathEntries)

Set additional entries needed in the PATH for the specified python executable to work properly. Generally not needed for the default python (assuming python is in the PATH). E.g. Windows anaconda needs Library/bin to be in the path as well as the directory that contains the python.exe.

Parameters:

pythonPathEntries - additional PATH entries needed for python to execute correctly

getPythonPathEntries

public java.lang.String getPythonPathEntries()

Get additional entries needed in the PATH for the specified python executable to work properly. Generally not needed for the default python (assuming python is in the PATH). E.g. Windows anaconda needs Library/bin to be in the path as well as the directory that contains the python.exe.

Returns:

additional PATH entries needed for python to execute correctly

setServerID

@OptionMetadata(displayName="Server name/ID",
                description="Optional name to identify this server - can be used to share a given server instance",
                displayOrder=3)
public void setServerID(java.lang.String serverID)

Set an optional server name by which to identify the python server to use. Can be used share a given server amongst selected instances or reserve a server specifically for this classifier. Python command + server name uniquely identifies the server to use.

Parameters:

serverID - the name of the server to use (or leave blank for no specific server name).

getServerID

public java.lang.String getServerID()

Get an optional server name by which to identify the python server to use. Can be used share a given server amongst selected instances or reserve a server specifically for this classifier. Python command + server name uniquely identifies the server to use.

Returns:

the name of the server to use (or leave blank for no specific server name).

setPythonScript

@ProgrammaticProperty
public void setPythonScript(java.lang.String script)

Set the python script to execute. This will get ignored if a file to load a script at run time has been set

Parameters:

script - the script to execute

getPythonScript

public java.lang.String getPythonScript()

Get the python script to execute. This might be null or empty if a script is being sourced from a file at run time

Returns:

the script to execute

setScriptFile

@OptionMetadata(displayName="File to load script from",
                description="A file to load the python script from (if set takes precendenceover any script from the editor",
                displayOrder=4)
 @FilePropertyMetadata(fileChooserDialogType=0,
                      directoriesOnly=false)
public void setScriptFile(java.io.File scriptFile)

Set the filename containing the script to be loaded at runtime

Parameters:

scriptFile - the name of the script file to load at runtime

getScriptFile

public java.io.File getScriptFile()

Get the filename of the script to load at runtime

Returns:

the filename of the script to load at runtime

setVariablesToGetFromPython

@OptionMetadata(displayName="Variables to get from Python",
                description="A comma-separated list of variables to retrieve from Python",
                displayOrder=5)
public void setVariablesToGetFromPython(java.lang.String varsToGet)

Set the variables to retrieve from python

Parameters:

varsToGet - a comma-separated list of variables to get from python

getVariablesToGetFromPython

public java.lang.String getVariablesToGetFromPython()

Get the list of variables to retrieve from python.

Returns:

a comma-separated list of variables to retrieve from python

stepInit

public void stepInit()
              throws weka.core.WekaException

Initialize the step

Throws:

weka.core.WekaException - if a problem occurs

start

public void start()
           throws weka.core.WekaException

Executed if we are operating as a start point

Specified by:

start in interface weka.knowledgeflow.steps.BaseStepExtender

Specified by:

start in interface weka.knowledgeflow.steps.Step

Overrides:

start in class weka.knowledgeflow.steps.BaseStep

Throws:

weka.core.WekaException - if a problem occurs

processIncoming

public void processIncoming(weka.knowledgeflow.Data data)
                     throws weka.core.WekaException

Process incoming instances

Specified by:

processIncoming in interface weka.knowledgeflow.steps.BaseStepExtender

Specified by:

processIncoming in interface weka.knowledgeflow.steps.Step

Overrides:

processIncoming in class weka.knowledgeflow.steps.BaseStep

Parameters:

data - data object - we process dataSet, trainingSet and testSet connections

Throws:

weka.core.WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Get the incoming connection types we can accept at the given time

Returns:

a list of incoming connection types

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Get the outgoing connection types we can produce at the given time

Returns:

a list of outgoing connection types

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Specified by:

getCustomEditorForStep in interface weka.knowledgeflow.steps.Step

Overrides:

getCustomEditorForStep in class weka.knowledgeflow.steps.BaseStep