org.apache.flink.python.env.beam

Class ProcessPythonEnvironmentManager

java.lang.Object

org.apache.flink.python.env.beam.ProcessPythonEnvironmentManager

All Implemented Interfaces:

AutoCloseable, PythonEnvironmentManager

@Internal
public final class ProcessPythonEnvironmentManager
extends Object
implements PythonEnvironmentManager

The ProcessPythonEnvironmentManager is used to prepare the working dir of python UDF worker and create ProcessPythonEnvironment object of Beam Fn API. It's used when the python function runner is configured to run python UDF in process mode.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PYTHON_REQUIREMENTS_CACHE
static String	PYTHON_REQUIREMENTS_FILE
static String	PYTHON_REQUIREMENTS_INSTALL_DIR
static String	PYTHON_WORKING_DIR

Constructor Summary

Constructors

Constructor and Description
ProcessPythonEnvironmentManager(PythonDependencyInfo dependencyInfo, String[] tmpDirectories, Map<String,String> systemEnv)

Method Summary

Modifier and Type	Method and Description
void	close()
PythonEnvironment	createEnvironment() Creates the PythonEnvironment object used in PythonFunctionRunner.
String	createRetrievalToken() Returns an empty RetrievalToken because no files will be transmit via ArtifactService in process mode.
String	getBootLog() Returns the boot log of the Python Environment.
void	open() Initialize the environment manager.
void	setEnvironmentVariable(String key, String value)

Methods inherited from class java.lang.Object

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

Field Detail

PYTHON_REQUIREMENTS_FILE

@VisibleForTesting
public static final String PYTHON_REQUIREMENTS_FILE

See Also:

Constant Field Values

PYTHON_REQUIREMENTS_CACHE

@VisibleForTesting
public static final String PYTHON_REQUIREMENTS_CACHE

See Also:

Constant Field Values

PYTHON_REQUIREMENTS_INSTALL_DIR

@VisibleForTesting
public static final String PYTHON_REQUIREMENTS_INSTALL_DIR

See Also:

Constant Field Values

PYTHON_WORKING_DIR

@VisibleForTesting
public static final String PYTHON_WORKING_DIR

See Also:

Constant Field Values

Constructor Detail

ProcessPythonEnvironmentManager

public ProcessPythonEnvironmentManager(@NotNull
                                       PythonDependencyInfo dependencyInfo,
                                       @NotNull
                                       String[] tmpDirectories,
                                       @NotNull
                                       Map<String,String> systemEnv)

Method Detail

open

public void open()
          throws Exception

Description copied from interface: PythonEnvironmentManager

Initialize the environment manager.

Specified by:

open in interface PythonEnvironmentManager

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

createEnvironment

public PythonEnvironment createEnvironment()
                                    throws IOException

Description copied from interface: PythonEnvironmentManager

Creates the PythonEnvironment object used in PythonFunctionRunner.

Specified by:

createEnvironment in interface PythonEnvironmentManager

Returns:

The PythonEnvironment object which represents the environment(process, docker, etc) the python worker would run in.

Throws:

IOException

createRetrievalToken

public String createRetrievalToken()
                            throws IOException

Returns an empty RetrievalToken because no files will be transmit via ArtifactService in process mode.

Specified by:

createRetrievalToken in interface PythonEnvironmentManager

Returns:

The path of empty RetrievalToken.

Throws:

IOException

setEnvironmentVariable

public void setEnvironmentVariable(String key,
                                   String value)

getBootLog

public String getBootLog()
                  throws Exception

Description copied from interface: PythonEnvironmentManager

Returns the boot log of the Python Environment.

Specified by:

getBootLog in interface PythonEnvironmentManager

Throws:

Exception