0e31e28d48
## What changes were proposed in this pull request?
Currently, if we run `./python/run-tests.py` and they are aborted without cleaning up this directory, it fails pep8 check due to some Python scripts generated. For example, 7387126f83/python/pyspark/tests.py (L1955-L1968)
```
PEP8 checks failed.
./work/app-20170531190857-0000/0/test.py:5:55: W292 no newline at end of file
./work/app-20170531190909-0000/0/test.py:5:55: W292 no newline at end of file
./work/app-20170531190924-0000/0/test.py:3:1: E302 expected 2 blank lines, found 1
./work/app-20170531190924-0000/0/test.py:7:52: W292 no newline at end of file
./work/app-20170531191016-0000/0/test.py:5:55: W292 no newline at end of file
./work/app-20170531191030-0000/0/test.py:5:55: W292 no newline at end of file
./work/app-20170531191045-0000/0/test.py:3:1: E302 expected 2 blank lines, found 1
./work/app-20170531191045-0000/0/test.py:7:52: W292 no newline at end of file
```
For me, it is sometimes a bit annoying. This PR proposes to exclude these (assuming we want to skip per https://github.com/apache/spark/blob/master/.gitignore#L73).
Also, it moves other pep8 configurations in the script into ini configuration file in pep8.
## How was this patch tested?
Manually tested via `./dev/lint-python`.
Author: hyukjinkwon <gurwls223@gmail.com>
Closes #18161 from HyukjinKwon/work-exclude-pep8.
108 lines
3.8 KiB
Bash
Executable file
108 lines
3.8 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
|
|
SPARK_ROOT_DIR="$(dirname "$SCRIPT_DIR")"
|
|
# Exclude auto-geneated configuration file.
|
|
PATHS_TO_CHECK="$( cd "$SPARK_ROOT_DIR" && find . -name "*.py" )"
|
|
PEP8_REPORT_PATH="$SPARK_ROOT_DIR/dev/pep8-report.txt"
|
|
PYLINT_REPORT_PATH="$SPARK_ROOT_DIR/dev/pylint-report.txt"
|
|
PYLINT_INSTALL_INFO="$SPARK_ROOT_DIR/dev/pylint-info.txt"
|
|
SPHINXBUILD=${SPHINXBUILD:=sphinx-build}
|
|
SPHINX_REPORT_PATH="$SPARK_ROOT_DIR/dev/sphinx-report.txt"
|
|
|
|
cd "$SPARK_ROOT_DIR"
|
|
|
|
# compileall: https://docs.python.org/2/library/compileall.html
|
|
python -B -m compileall -q -l $PATHS_TO_CHECK > "$PEP8_REPORT_PATH"
|
|
compile_status="${PIPESTATUS[0]}"
|
|
|
|
# Get pep8 at runtime so that we don't rely on it being installed on the build server.
|
|
#+ See: https://github.com/apache/spark/pull/1744#issuecomment-50982162
|
|
#+ TODOs:
|
|
#+ - Download pep8 from PyPI. It's more "official".
|
|
PEP8_VERSION="1.7.0"
|
|
PEP8_SCRIPT_PATH="$SPARK_ROOT_DIR/dev/pep8-$PEP8_VERSION.py"
|
|
PEP8_SCRIPT_REMOTE_PATH="https://raw.githubusercontent.com/jcrocholl/pep8/$PEP8_VERSION/pep8.py"
|
|
|
|
if [ ! -e "$PEP8_SCRIPT_PATH" ]; then
|
|
curl --silent -o "$PEP8_SCRIPT_PATH" "$PEP8_SCRIPT_REMOTE_PATH"
|
|
curl_status="$?"
|
|
|
|
if [ "$curl_status" -ne 0 ]; then
|
|
echo "Failed to download pep8.py from \"$PEP8_SCRIPT_REMOTE_PATH\"."
|
|
exit "$curl_status"
|
|
fi
|
|
fi
|
|
|
|
# Easy install pylint in /dev/pylint. To easy_install into a directory, the PYTHONPATH should
|
|
# be set to the directory.
|
|
# dev/pylint should be appended to the PATH variable as well.
|
|
# Jenkins by default installs the pylint3 version, so for now this just checks the code quality
|
|
# of python3.
|
|
export "PYTHONPATH=$SPARK_ROOT_DIR/dev/pylint"
|
|
export "PYLINT_HOME=$PYTHONPATH"
|
|
export "PATH=$PYTHONPATH:$PATH"
|
|
|
|
# There is no need to write this output to a file
|
|
#+ first, but we do so so that the check status can
|
|
#+ be output before the report, like with the
|
|
#+ scalastyle and RAT checks.
|
|
python "$PEP8_SCRIPT_PATH" --config=dev/tox.ini $PATHS_TO_CHECK >> "$PEP8_REPORT_PATH"
|
|
pep8_status="${PIPESTATUS[0]}"
|
|
|
|
if [ "$compile_status" -eq 0 -a "$pep8_status" -eq 0 ]; then
|
|
lint_status=0
|
|
else
|
|
lint_status=1
|
|
fi
|
|
|
|
if [ "$lint_status" -ne 0 ]; then
|
|
echo "PEP8 checks failed."
|
|
cat "$PEP8_REPORT_PATH"
|
|
rm "$PEP8_REPORT_PATH"
|
|
exit "$lint_status"
|
|
else
|
|
echo "PEP8 checks passed."
|
|
rm "$PEP8_REPORT_PATH"
|
|
fi
|
|
|
|
# Check that the documentation builds acceptably, skip check if sphinx is not installed.
|
|
if hash "$SPHINXBUILD" 2> /dev/null; then
|
|
cd python/docs
|
|
make clean
|
|
# Treat warnings as errors so we stop correctly
|
|
SPHINXOPTS="-a -W" make html &> "$SPHINX_REPORT_PATH" || lint_status=1
|
|
if [ "$lint_status" -ne 0 ]; then
|
|
echo "pydoc checks failed."
|
|
cat "$SPHINX_REPORT_PATH"
|
|
echo "re-running make html to print full warning list"
|
|
make clean
|
|
SPHINXOPTS="-a" make html
|
|
rm "$SPHINX_REPORT_PATH"
|
|
exit "$lint_status"
|
|
else
|
|
echo "pydoc checks passed."
|
|
rm "$SPHINX_REPORT_PATH"
|
|
fi
|
|
cd ../..
|
|
else
|
|
echo >&2 "The $SPHINXBUILD command was not found. Skipping pydoc checks for now"
|
|
fi
|