Skip to content

[SPARK-31155] Remove pydocstyle tests #27912

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
nchammas wants to merge 8 commits into from
Closed

[SPARK-31155] Remove pydocstyle tests #27912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c8e7f50
enable pydocstyle in github build
nchammas Mar 14, 2020
3f09453
pin versions to match various READMEs
nchammas Mar 14, 2020
0e71162
derp: pip install -r
nchammas Mar 14, 2020
1adeef4
Merge branch 'master' of https://github.com/apache/spark into SPARK-3…
nchammas Mar 15, 2020
eed7164
reenable some pydocstyle tests
nchammas Mar 15, 2020
8248942
remove pydocstyle
nchammas Mar 16, 2020
18de9d7
revert dep changes
nchammas Mar 16, 2020
34ec6a3
re-trigger GitHub tests
nchammas Mar 16, 2020
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
46 changes: 0 additions & 46 deletions dev/lint-python
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@
# limitations under the License.
#
# define test binaries + versions
PYDOCSTYLE_BUILD="pydocstyle"
MINIMUM_PYDOCSTYLE="3.0.0"

FLAKE8_BUILD="flake8"
MINIMUM_FLAKE8="3.5.0"

Expand Down Expand Up @@ -165,48 +162,6 @@ flake8 checks failed."
fi
}

function pydocstyle_test {
local PYDOCSTYLE_REPORT=
local PYDOCSTYLE_STATUS=
local PYDOCSTYLE_VERSION=
local EXPECTED_PYDOCSTYLE=

# Exclude auto-generated configuration file.
local DOC_PATHS_TO_CHECK="$( cd "${SPARK_ROOT_DIR}" && find . -name "*.py" | grep -vF 'functions.py' )"

# Check python document style, skip check if pydocstyle is not installed.
if ! hash "$PYDOCSTYLE_BUILD" 2> /dev/null; then
echo "The pydocstyle command was not found. Skipping pydocstyle checks for now."
echo
return
fi

PYDOCSTYLE_VERSION="$($PYDOCSTYLE_BUILD --version)"
EXPECTED_PYDOCSTYLE="$(satisfies_min_version $PYDOCSTYLE_VERSION $MINIMUM_PYDOCSTYLE)"

if [[ "$EXPECTED_PYDOCSTYLE" == "False" ]]; then
echo "\
The minimum version of pydocstyle needs to be $MINIMUM_PYDOCSTYLE.
Your current version is $PYDOCSTYLE_VERSION.
Skipping pydocstyle checks for now."
echo
return
fi

echo "starting $PYDOCSTYLE_BUILD test..."
PYDOCSTYLE_REPORT=$( ($PYDOCSTYLE_BUILD --config=dev/tox.ini $DOC_PATHS_TO_CHECK) 2>&1)
PYDOCSTYLE_STATUS=$?

if [ "$PYDOCSTYLE_STATUS" -ne 0 ]; then
echo "pydocstyle checks failed:"
echo "$PYDOCSTYLE_REPORT"
exit "$PYDOCSTYLE_STATUS"
else
echo "pydocstyle checks passed."
echo
fi
}

function sphinx_test {
local SPHINX_REPORT=
local SPHINX_STATUS=
Expand Down Expand Up @@ -252,7 +207,6 @@ PYTHON_SOURCE="$(find . -name "*.py")"
compile_python_test "$PYTHON_SOURCE"
pycodestyle_test "$PYTHON_SOURCE"
flake8_test
pydocstyle_test
sphinx_test

echo
Expand Down
2 changes: 0 additions & 2 deletions dev/tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,3 @@
ignore=E226,E241,E305,E402,E722,E731,E741,W503,W504
max-line-length=100
exclude=cloudpickle.py,heapq3.py,shared.py,python/docs/conf.py,work/*/*.py,python/.eggs/*,dist/*,.git/*
[pydocstyle]
ignore=D100,D101,D102,D103,D104,D105,D106,D107,D200,D201,D202,D203,D204,D205,D206,D207,D208,D209,D210,D211,D212,D213,D214,D215,D300,D301,D302,D400,D401,D402,D403,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414