org.hkijena.jipipe.extensions.python

Class PythonUtils

java.lang.Object

org.hkijena.jipipe.extensions.python.PythonUtils

public class PythonUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PythonUtils.RawPythonCode

Field Summary

Fields

Modifier and Type	Field and Description
static Class<?>[]	ALLOWED_PARAMETER_CLASSES

Method Summary

Modifier and Type	Method and Description
static void	addPostprocessorCode(StringBuilder code, List<JIPipeOutputDataSlot> outputSlots)
static void	annotationsToPython(StringBuilder code, Collection<JIPipeTextAnnotation> annotations) Converts annotations into Python code.
static void	cleanup(Map<String,Path> inputSlotPaths, Map<String,Path> outputSlotPaths, JIPipeProgressInfo progressInfo)
static String	escapeString(String value) Escapes a string to be used within Python code Will not add quotes around the string
static void	extractOutputs(JIPipeDataBatch dataBatch, Map<String,Path> outputSlotPaths, List<JIPipeOutputDataSlot> outputSlots, JIPipeTextAnnotationMergeMode annotationMergeStrategy, JIPipeProgressInfo progressInfo)
static void	extractOutputs(JIPipeMergingDataBatch dataBatch, Map<String,Path> outputSlotPaths, List<JIPipeOutputDataSlot> outputSlots, JIPipeTextAnnotationMergeMode annotationMergeStrategy, JIPipeProgressInfo progressInfo)
static void	extractOutputs(Map<String,Path> outputSlotPaths, List<JIPipeOutputDataSlot> outputSlots, JIPipeProgressInfo progressInfo)
static void	inputSlotsToPython(StringBuilder code, Map<String,Path> inputSlotPaths)
static void	installAdapterCodeIfNeeded(StringBuilder pythonCode)
static Map<String,Path>	installInputSlots(StringBuilder code, JIPipeDataBatch dataBatch, JIPipeGraphNode node, List<JIPipeInputDataSlot> effectiveInputSlots, Path workDirectory, JIPipeProgressInfo progressInfo)
static Map<String,Path>	installInputSlots(StringBuilder code, JIPipeMergingDataBatch dataBatch, JIPipeGraphNode node, List<JIPipeInputDataSlot> effectiveInputSlots, Path workDirectory, JIPipeProgressInfo progressInfo)
static Map<String,Path>	installInputSlots(StringBuilder code, List<JIPipeInputDataSlot> effectiveInputSlots, Path workDirectory, JIPipeProgressInfo progressInfo)
static Map<String,Path>	installOutputSlots(StringBuilder code, List<JIPipeOutputDataSlot> outputSlots, Path workDirectory, JIPipeProgressInfo progressInfo)
static String	listToPythonArray(Collection<Object> items, boolean withSurroundingBrackets) Converts a collection into a Python array
static String	mapToPythonArguments(Map<String,Object> parameters) Converts a dictionary into a set of Python function arguments
static String	mapToPythonDict(Map<String,Object> parameters) Converts a dictionary into a set of Python function arguments
static String	objectToPython(Object object) Converts the object into valid Python code
static void	outputSlotsToPython(StringBuilder code, List<JIPipeOutputDataSlot> outputSlots, Map<String,Path> outputSlotPaths)
static void	parametersToPython(StringBuilder code, JIPipeParameterCollection parameterCollection) Converts parameters into Python code.
static PythonUtils.RawPythonCode	rawPythonCode(String code)
static void	runPython(Path scriptFile, PythonEnvironment environment, List<Path> libraryPaths, JIPipeProgressInfo progressInfo) Runs a Python script file
static void	runPython(String[] arguments, PythonEnvironment environment, List<Path> libraryPaths, Map<String,String> additionalEnvironmentVariables, JIPipeProgressInfo progressInfo) Runs Python with a set of arguments
static void	runPython(String code, PythonEnvironment environment, List<Path> libraryPaths, JIPipeProgressInfo progressInfo)
static void	setupLogger(org.apache.commons.exec.CommandLine commandLine, org.apache.commons.exec.DefaultExecutor executor, JIPipeProgressInfo progressInfo)

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWED_PARAMETER_CLASSES

public static Class<?>[] ALLOWED_PARAMETER_CLASSES

Method Detail

annotationsToPython

public static void annotationsToPython(StringBuilder code,
                                       Collection<JIPipeTextAnnotation> annotations)

Converts annotations into Python code.

Parameters:

code - the code

annotations - the annotations

parametersToPython

public static void parametersToPython(StringBuilder code,
                                      JIPipeParameterCollection parameterCollection)

Converts parameters into Python code. Only parameters in ALLOWED_PARAMETER_CLASSES are converted. All parameters are also available in a list JIPipe.Variables

Parameters:

code - the code

parameterCollection - the parameters

installAdapterCodeIfNeeded

public static void installAdapterCodeIfNeeded(StringBuilder pythonCode)

inputSlotsToPython

public static void inputSlotsToPython(StringBuilder code,
                                      Map<String,Path> inputSlotPaths)

outputSlotsToPython

public static void outputSlotsToPython(StringBuilder code,
                                       List<JIPipeOutputDataSlot> outputSlots,
                                       Map<String,Path> outputSlotPaths)

addPostprocessorCode

public static void addPostprocessorCode(StringBuilder code,
                                        List<JIPipeOutputDataSlot> outputSlots)

installInputSlots

public static Map<String,Path> installInputSlots(StringBuilder code,
                                                 JIPipeDataBatch dataBatch,
                                                 JIPipeGraphNode node,
                                                 List<JIPipeInputDataSlot> effectiveInputSlots,
                                                 Path workDirectory,
                                                 JIPipeProgressInfo progressInfo)

installInputSlots

public static Map<String,Path> installInputSlots(StringBuilder code,
                                                 List<JIPipeInputDataSlot> effectiveInputSlots,
                                                 Path workDirectory,
                                                 JIPipeProgressInfo progressInfo)

installInputSlots

public static Map<String,Path> installInputSlots(StringBuilder code,
                                                 JIPipeMergingDataBatch dataBatch,
                                                 JIPipeGraphNode node,
                                                 List<JIPipeInputDataSlot> effectiveInputSlots,
                                                 Path workDirectory,
                                                 JIPipeProgressInfo progressInfo)

runPython

public static void runPython(String code,
                             PythonEnvironment environment,
                             List<Path> libraryPaths,
                             JIPipeProgressInfo progressInfo)

extractOutputs

public static void extractOutputs(JIPipeDataBatch dataBatch,
                                  Map<String,Path> outputSlotPaths,
                                  List<JIPipeOutputDataSlot> outputSlots,
                                  JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                                  JIPipeProgressInfo progressInfo)

extractOutputs

public static void extractOutputs(JIPipeMergingDataBatch dataBatch,
                                  Map<String,Path> outputSlotPaths,
                                  List<JIPipeOutputDataSlot> outputSlots,
                                  JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                                  JIPipeProgressInfo progressInfo)

extractOutputs

public static void extractOutputs(Map<String,Path> outputSlotPaths,
                                  List<JIPipeOutputDataSlot> outputSlots,
                                  JIPipeProgressInfo progressInfo)

setupLogger

public static void setupLogger(org.apache.commons.exec.CommandLine commandLine,
                               org.apache.commons.exec.DefaultExecutor executor,
                               JIPipeProgressInfo progressInfo)

runPython

public static void runPython(Path scriptFile,
                             PythonEnvironment environment,
                             List<Path> libraryPaths,
                             JIPipeProgressInfo progressInfo)

Runs a Python script file

Parameters:

scriptFile - the script file

environment - the environment

libraryPaths - additional library paths

progressInfo - the progress info

runPython

public static void runPython(String[] arguments,
                             PythonEnvironment environment,
                             List<Path> libraryPaths,
                             Map<String,String> additionalEnvironmentVariables,
                             JIPipeProgressInfo progressInfo)

Runs Python with a set of arguments

Parameters:

arguments - the arguments

environment - the environment

libraryPaths - additional library paths

additionalEnvironmentVariables - additional environment variables

progressInfo - the progress info

escapeString

public static String escapeString(String value)

Escapes a string to be used within Python code Will not add quotes around the string

Parameters:

value - unescaped string

Returns:

escaped string

objectToPython

public static String objectToPython(Object object)

Converts the object into valid Python code

Parameters:

object - the object

Returns:

Python code

listToPythonArray

public static String listToPythonArray(Collection<Object> items,
                                       boolean withSurroundingBrackets)

Converts a collection into a Python array

Parameters:

items - the items

withSurroundingBrackets - if enabled, surrounding brackets are added

Returns:

Python code

mapToPythonDict

public static String mapToPythonDict(Map<String,Object> parameters)

Converts a dictionary into a set of Python function arguments

Parameters:

parameters - the parameters

Returns:

Python code

mapToPythonArguments

public static String mapToPythonArguments(Map<String,Object> parameters)

Converts a dictionary into a set of Python function arguments

Parameters:

parameters - the parameters

Returns:

Python code

cleanup

public static void cleanup(Map<String,Path> inputSlotPaths,
                           Map<String,Path> outputSlotPaths,
                           JIPipeProgressInfo progressInfo)

installOutputSlots

public static Map<String,Path> installOutputSlots(StringBuilder code,
                                                  List<JIPipeOutputDataSlot> outputSlots,
                                                  Path workDirectory,
                                                  JIPipeProgressInfo progressInfo)

rawPythonCode

public static PythonUtils.RawPythonCode rawPythonCode(String code)