org.apache.flink.python.env.PythonEnvironmentManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-python Show documentation

There is a newer version: 2.0-preview1

/*
 * 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.env;

import org.apache.flink.annotation.Internal;

/**
 * The base interface of python environment manager which is used to create the PythonEnvironment
 * object used to execute Python functions.
 */
@Internal
public interface PythonEnvironmentManager extends AutoCloseable {

    /** Initialize the environment manager. */
    void open() throws Exception;

    /**
     * Creates the PythonEnvironment object used to execute Python functions.
     *
     * @return The PythonEnvironment object which represents the environment(embedded thread,
     *     process, docker, etc) the python worker would run in.
     */
    PythonEnvironment createEnvironment() throws Exception;
}