hequn8128 commented on a change in pull request #10017: [FLINK-14019][python] add support for managing environment and dependencies of Python UDF in Flink Python API URL: https://github.com/apache/flink/pull/10017#discussion_r341149829
########## File path: flink-python/src/main/java/org/apache/flink/python/PythonDependencyManager.java ########## @@ -0,0 +1,183 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.python; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.api.common.cache.DistributedCache; + +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper; + +import java.io.File; +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; + +/** + * This class is used to parse the information of python dependency and environment management + * stored in GlobalJobParameters. + * The parse result will be used to create PythonEnvironmentManager. + */ +@Internal +public class PythonDependencyManager { + + public static final String PYTHON_FILE_MAP = "PYTHON_FILE_MAP"; + public static final String PYTHON_REQUIREMENTS = "PYTHON_REQUIREMENTS"; + public static final String PYTHON_REQUIREMENTS_DIR = "PYTHON_REQUIREMENTS_DIR"; + public static final String PYTHON_ARCHIVES_MAP = "PYTHON_ARCHIVES_MAP"; + public static final String PYTHON_EXEC = "PYTHON_EXEC"; + + private Map<String, String> filesInPythonPath; + private String requirementsFilePath; + private String requirementsDirPath; + private String pythonExec; + private Map<String, String> archives; + + /** + * @param filesInPythonPath Local path and origin file name of user python files uploaded by + * TableEnvironment#add_python_file() or command option "-pyfs". + * Key is local absolute path and value is origin file name. + * @param requirementsFilePath The file path of requirements.txt file specified by + * TableEnvironment#set_python_requirements() or command option "-pyreq". + * @param requirementsDirPath The path of the directory uploaded by TableEnvironment#set_python_requirements() + * or command option "-pyreq". It is used to support installing python packages offline. + * If exists it should contain all the packages listed in requirements.txt file. + * @param pythonExec The path of python interpreter (e.g. /usr/local/bin/python). + * It can be specified by TableConfig#set_python_executable() or command option "-pyexec". + * @param archives Local path and target directory name of user python archives uploaded by + * TableEnvironment#add_python_archive() or command option "-pyarch". + * Key is local absolute path and value is target directory name. + */ + public PythonDependencyManager( + Map<String, String> filesInPythonPath, + String requirementsFilePath, + String requirementsDirPath, + String pythonExec, + Map<String, String> archives) { + this.filesInPythonPath = filesInPythonPath; + this.requirementsFilePath = requirementsFilePath; + this.requirementsDirPath = requirementsDirPath; + this.pythonExec = pythonExec; + this.archives = archives; + } + + /** + * @return Local path and origin file name of user python files uploaded by + * TableEnvironment#add_python_file() or command option "-pyfs". + * Key is local absolute path and value is origin file name. + */ + public Map<String, String> getFilesInPythonPath() { + return filesInPythonPath; + } + + /** + * @return The file path of requirements.txt file specified by + * TableEnvironment#set_python_requirements() or command option "-pyreq". + */ + public String getRequirementsFilePath() { + return requirementsFilePath; + } + + /** + * @return The path of the directory uploaded by TableEnvironment#set_python_requirements() + * or command option "-pyreq". It is used to support installing python packages + * offline. + * If exists it should contain all the packages listed in requirements.txt file. + */ + public String getRequirementsDirPath() { + return requirementsDirPath; + } + + /** + * @return The path of python interpreter (e.g. /usr/local/bin/python). + * It can be specified by TableConfig#set_python_executable() or command option "-pyexec". + */ + public String getPythonExec() { + return pythonExec; + } + + /** + * @return Local path and target directory name of user python archives uploaded by + * TableEnvironment#add_python_archive() or command option "-pyarch". + * Key is local absolute path and value is target directory name. + */ + public Map<String, String> getArchives() { + return archives; + } + + /** + * Creates PythonDependencyManager from GlobalJobParameters and DistributedCache. + * + * @param dependencyMetaData The parameter map which contains information of python dependency. + * Usually it is the map of GlobalJobParameters. + * @param distributedCache The DistributedCache object of current task. + * @return The PythonDependencyManager object that contains whole information of python dependency. + */ + public static PythonDependencyManager createDependencyManager( Review comment: Just rename it create? There is no need to add key word `DependencyManager` in the method as it returns a `PythonDependencyManager`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
