942f577b6e
### What changes were proposed in this pull request?
This PR proposes to add a way to select Hadoop and Hive versions in pip installation.
Users can select Hive or Hadoop versions as below:
```bash
HADOOP_VERSION=3.2 pip install pyspark
HIVE_VERSION=1.2 pip install pyspark
HIVE_VERSION=1.2 HADOOP_VERSION=2.7 pip install pyspark
```
When the environment variables are set, internally it downloads the corresponding Spark version and then sets the Spark home to it. Also this PR exposes a mirror to set as an environment variable, `PYSPARK_RELEASE_MIRROR`.
**Please NOTE that:**
- We cannot currently leverage pip's native installation option, for example:
```bash
pip install pyspark --install-option="hadoop3.2"
```
This is because of a limitation and bug in pip itself. Once they fix this issue, we can switch from the environment variables to the proper installation options, see SPARK-32837.
It IS possible to workaround but very ugly or hacky with a big change. See [this PR](https://github.com/microsoft/nni/pull/139/files) as an example.
- In pip installation, we pack the relevant jars together. This PR _does not touch existing packaging way_ in order to prevent any behaviour changes.
Once this experimental way is proven to be safe, we can avoid packing the relevant jars together (and keep only the relevant Python scripts). And downloads the Spark distribution as this PR proposes.
- This way is sort of consistent with SparkR:
SparkR provides a method `SparkR::install.spark` to support CRAN installation. This is fine because SparkR is provided purely as a R library. For example, `sparkr` script is not packed together.
PySpark cannot take this approach because PySpark packaging ships relevant executable script together, e.g.) `pyspark` shell.
If PySpark has a method such as `pyspark.install_spark`, users cannot call it in `pyspark` because `pyspark` already assumes relevant Spark is installed, JVM is launched, etc.
- There looks no way to release that contains different Hadoop or Hive to PyPI due to [the version semantics](https://www.python.org/dev/peps/pep-0440/). This is not an option.
The usual way looks either `--install-option` above with hacks or environment variables given my investigation.
### Why are the changes needed?
To provide users the options to select Hadoop and Hive versions.
### Does this PR introduce _any_ user-facing change?
Yes, users will be able to select Hive and Hadoop version as below when they install it from `pip`;
```bash
HADOOP_VERSION=3.2 pip install pyspark
HIVE_VERSION=1.2 pip install pyspark
HIVE_VERSION=1.2 HADOOP_VERSION=2.7 pip install pyspark
```
### How was this patch tested?
Unit tests were added. I also manually tested in Mac and Windows (after building Spark with `python/dist/pyspark-3.1.0.dev0.tar.gz`):
```bash
./build/mvn -DskipTests -Phive-thriftserver clean package
```
Mac:
```bash
SPARK_VERSION=3.0.1 HADOOP_VERSION=3.2 pip install pyspark-3.1.0.dev0.tar.gz
```
Windows:
```bash
set HADOOP_VERSION=3.2
set SPARK_VERSION=3.0.1
pip install pyspark-3.1.0.dev0.tar.gz
```
Closes #29703 from HyukjinKwon/SPARK-32017.
Authored-by: HyukjinKwon <gurwls223@apache.org>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
87 lines
3.9 KiB
Python
Executable file
87 lines
3.9 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
# This script attempt to determine the correct setting for SPARK_HOME given
|
|
# that Spark may have been installed on the system with pip.
|
|
|
|
import os
|
|
import sys
|
|
|
|
|
|
def _find_spark_home():
|
|
"""Find the SPARK_HOME."""
|
|
# If the environment has SPARK_HOME set trust it.
|
|
if "SPARK_HOME" in os.environ:
|
|
return os.environ["SPARK_HOME"]
|
|
|
|
def is_spark_home(path):
|
|
"""Takes a path and returns true if the provided path could be a reasonable SPARK_HOME"""
|
|
return (os.path.isfile(os.path.join(path, "bin/spark-submit")) and
|
|
(os.path.isdir(os.path.join(path, "jars")) or
|
|
os.path.isdir(os.path.join(path, "assembly"))))
|
|
|
|
# Spark distribution can be downloaded when HADOOP_VERSION environment variable is set.
|
|
# We should look up this directory first, see also SPARK-32017.
|
|
spark_dist_dir = "spark-distribution"
|
|
paths = [
|
|
"../", # When we're in spark/python.
|
|
# Two case belows are valid when the current script is called as a library.
|
|
os.path.join(os.path.dirname(os.path.realpath(__file__)), spark_dist_dir),
|
|
os.path.dirname(os.path.realpath(__file__))]
|
|
|
|
# Add the path of the PySpark module if it exists
|
|
import_error_raised = False
|
|
from importlib.util import find_spec
|
|
try:
|
|
module_home = os.path.dirname(find_spec("pyspark").origin)
|
|
paths.append(os.path.join(module_home, spark_dist_dir))
|
|
paths.append(module_home)
|
|
# If we are installed in edit mode also look two dirs up
|
|
# Downloading different versions are not supported in edit mode.
|
|
paths.append(os.path.join(module_home, "../../"))
|
|
except ImportError:
|
|
# Not pip installed no worries
|
|
import_error_raised = True
|
|
|
|
# Normalize the paths
|
|
paths = [os.path.abspath(p) for p in paths]
|
|
|
|
try:
|
|
return next(path for path in paths if is_spark_home(path))
|
|
except StopIteration:
|
|
print("Could not find valid SPARK_HOME while searching {0}".format(paths), file=sys.stderr)
|
|
if import_error_raised:
|
|
print(
|
|
"\nDid you install PySpark via a package manager such as pip or Conda? If so,\n"
|
|
"PySpark was not found in your Python environment. It is possible your\n"
|
|
"Python environment does not properly bind with your package manager.\n"
|
|
"\nPlease check your default 'python' and if you set PYSPARK_PYTHON and/or\n"
|
|
"PYSPARK_DRIVER_PYTHON environment variables, and see if you can import\n"
|
|
"PySpark, for example, 'python -c 'import pyspark'.\n"
|
|
"\nIf you cannot import, you can install by using the Python executable directly,\n"
|
|
"for example, 'python -m pip install pyspark [--user]'. Otherwise, you can also\n"
|
|
"explicitly set the Python executable, that has PySpark installed, to\n"
|
|
"PYSPARK_PYTHON or PYSPARK_DRIVER_PYTHON environment variables, for example,\n"
|
|
"'PYSPARK_PYTHON=python3 pyspark'.\n", file=sys.stderr)
|
|
sys.exit(-1)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
print(_find_spark_home())
|