Skip to content

[SPARK-8706] [PySpark] [Project infra] Add pylint checks to PySpark #7241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

[SPARK-8706] [PySpark] [Project infra] Add pylint checks to PySpark #7241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7871bb1
[SPARK-8706] [PySpark] [Project infra] Add pylint checks to PySpark
MechCoder Jul 6, 2015
8b8aa8a
Add pylint configuration file
MechCoder Jul 6, 2015
1dbd094
Disable all checks for now
MechCoder Jul 8, 2015
8498ff9
Remove blacklisted arguments and pointless statements check
MechCoder Jul 9, 2015
71629f8
remove trailing whitespace
MechCoder Jul 9, 2015
ca8b749
Minor changes
MechCoder Jul 9, 2015
f3a5e17
undefined-variable
MechCoder Jul 9, 2015
6d883a2
Silence warnings and make pylint tests fail to check if it works in j…
MechCoder Jul 10, 2015
2fc7291
Remove pylint test fail
MechCoder Jul 13, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 49 additions & 8 deletions dev/lint-python
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
SPARK_ROOT_DIR="$(dirname "$SCRIPT_DIR")"
PATHS_TO_CHECK="./python/pyspark/ ./ec2/spark_ec2.py ./examples/src/main/python/ ./dev/sparktestsupport"
PATHS_TO_CHECK="$PATHS_TO_CHECK ./dev/run-tests.py ./python/run-tests.py"
PYTHON_LINT_REPORT_PATH="$SPARK_ROOT_DIR/dev/python-lint-report.txt"
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"

cd "$SPARK_ROOT_DIR"

# compileall: https://docs.python.org/2/library/compileall.html
python -B -m compileall -q -l $PATHS_TO_CHECK > "$PYTHON_LINT_REPORT_PATH"
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.
Expand All @@ -47,11 +49,36 @@ if [ ! -e "$PEP8_SCRIPT_PATH" ]; then
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"
Copy link
Contributor

@davies davies Jul 10, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we put these somewhere outside of SPARK_HOME? Because we will call git clean in jenkins. It will be good if we could re-use the installed pylint.

Copy link
Contributor

@JoshRosen JoshRosen Jul 10, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK the PEP8 script currently suffers from this problem as well. I'm talking with Shane about configuring some per-build space which lives outside of the work directory that's cleaned by git clean (I want to use these for holding separate .ivy2 caches for each PRB workspace).

Copy link
Contributor Author

@MechCoder MechCoder Jul 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be done? What if the devloper does not want these pylint files outside the spark directory?

export "PYLINT_HOME=$PYTHONPATH"
export "PATH=$PYTHONPATH:$PATH"

if [ ! -d "$PYLINT_HOME" ]; then
mkdir "$PYLINT_HOME"
# Redirect the annoying pylint installation output.
easy_install -d "$PYLINT_HOME" pylint==1.4.4 &>> "$PYLINT_INSTALL_INFO"
easy_install_status="$?"

if [ "$easy_install_status" -ne 0 ]; then
echo "Unable to install pylint locally in \"$PYTHONPATH\"."
cat "$PYLINT_INSTALL_INFO"
exit "$easy_install_status"
fi

rm "$PYLINT_INSTALL_INFO"

fi

# 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" --ignore=E402,E731,E241,W503,E226 $PATHS_TO_CHECK >> "$PYTHON_LINT_REPORT_PATH"
python "$PEP8_SCRIPT_PATH" --ignore=E402,E731,E241,W503,E226 $PATHS_TO_CHECK >> "$PEP8_REPORT_PATH"
pep8_status="${PIPESTATUS[0]}"

if [ "$compile_status" -eq 0 -a "$pep8_status" -eq 0 ]; then
Expand All @@ -61,13 +88,27 @@ else
fi

if [ "$lint_status" -ne 0 ]; then
echo "Python lint checks failed."
cat "$PYTHON_LINT_REPORT_PATH"
echo "PEP8 checks failed."
cat "$PEP8_REPORT_PATH"
else
echo "PEP8 checks passed."
fi

rm "$PEP8_REPORT_PATH"

for to_be_checked in "$PATHS_TO_CHECK"
do
pylint --rcfile="$SPARK_ROOT_DIR/pylintrc" $to_be_checked >> "$PYLINT_REPORT_PATH"
done

if [ "${PIPESTATUS[0]}" -ne 0 ]; then
lint_status=1
echo "Pylint checks failed."
cat "$PYLINT_REPORT_PATH"
else
echo "Python lint checks passed."
echo "Pylint checks passed."
fi

# rm "$PEP8_SCRIPT_PATH"
rm "$PYTHON_LINT_REPORT_PATH"
rm "$PYLINT_REPORT_PATH"

exit "$lint_status"
Loading