mirror of
https://github.com/vale981/ray
synced 2025-03-06 18:41:40 -05:00
42a9233e1d
* Allow yapf to lint individual files * Add tip for using yapf * Update doc * Update script to autoformat changed py files The new default is for the script to only updated changed files to encourage using it as a pre-push hook. Travis still checks all since it's not that big an increase to runtime. * Exclude formatting thirdparty/autogen py files * Symlink .travis -> scripts Hidden directories may get glossed over otherwise. * .travis -> scripts in docs They are symlinks to the same thing, but `scripts` is more dev-friendly, while `.travis` is really only for Travis CI. * Document different yapf format functions Most devs will only need `format_changed`, and this is run by default. `format_changed` should be fast enough in most cases to work as a pre-commit hook. * Speed up yapf by only formatting changed files * Update docs 1. Mention how yapf can be used a pre-commit hook 2. rm `bash`, script is executable * Update yapf.sh * Update development.rst * Update yapf.sh * Use bash arrays for correct argument splitting Playing fast and loose with whitespace in bash is a terrible idea. * Only format non-excluded by default * Check changes against master Normally, the remote is called `origin`, but naming it explicit * Adding missing directory to `format_all` * Cleanup YAPF code Remove unused function and move around code to make clearer and adding lines give cleaner diffs. * Ensure correct files are autoformatted * Fix cmd line arg splitting Each arg has to be in its own set of quotes. * Diff against mergebase TIL there's a clean syntax for doing that, but it's too clever to belong in a shell script. We use `mapfile -t` to ensure no problems down the line with weird filenames.
85 lines
2.5 KiB
Bash
Executable file
85 lines
2.5 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
|
|
# Cause the script to exit if a single command fails
|
|
set -eo pipefail
|
|
|
|
# this stops git rev-parse from failing if we run this from the .git directory
|
|
builtin cd "$(dirname "${BASH_SOURCE:-$0}")"
|
|
|
|
ROOT="$(git rev-parse --show-toplevel)"
|
|
builtin cd "$ROOT" || exit 1
|
|
|
|
# Add the upstream branch if it doesn't exist
|
|
if ! [[ -e "$ROOT/.git/refs/remotes/upstream" ]]; then
|
|
git remote add 'upstream' 'https://github.com/ray-project/ray.git'
|
|
fi
|
|
|
|
# Only fetch master since that's the branch we're diffing against.
|
|
git fetch upstream master
|
|
|
|
YAPF_FLAGS=(
|
|
'--style' "$ROOT/.style.yapf"
|
|
'--in-place'
|
|
'--recursive'
|
|
'--parallel'
|
|
)
|
|
|
|
YAPF_EXCLUDES=(
|
|
'--exclude' 'python/ray/dataframe'
|
|
'--exclude' 'python/ray/rllib'
|
|
'--exclude' 'python/ray/cloudpickle'
|
|
'--exclude' 'python/build'
|
|
'--exclude' 'python/ray/pyarrow_files'
|
|
'--exclude' 'python/ray/core/src/ray/gcs'
|
|
'--exclude' 'python/ray/common/thirdparty'
|
|
)
|
|
|
|
# Format specified files
|
|
format() {
|
|
yapf "${YAPF_FLAGS[@]}" -- "$@"
|
|
}
|
|
|
|
# Format files that differ from main branch. Ignores dirs that are not slated
|
|
# for autoformat yet.
|
|
format_changed() {
|
|
# The `if` guard ensures that the list of filenames is not empty, which
|
|
# could cause yapf to receive 0 positional arguments, making it hang
|
|
# waiting for STDIN.
|
|
#
|
|
# `diff-filter=ACM` and $MERGEBASE is to ensure we only format files that
|
|
# exist on both branches.
|
|
MERGEBASE="$(git merge-base upstream/master HEAD)"
|
|
|
|
if ! git diff --diff-filter=ACM --quiet --exit-code "$MERGEBASE" -- '*.py' &>/dev/null; then
|
|
declare -a unformatted_files && mapfile -t unformatted_files < <(git diff --name-only --diff-filter=ACM "$MERGEBASE" -- '*.py')
|
|
yapf "${YAPF_EXCLUDES[@]}" "${YAPF_FLAGS[@]}" -- "${unformatted_files[@]}"
|
|
fi
|
|
}
|
|
|
|
# Format all files
|
|
format_all() {
|
|
yapf "${YAPF_FLAGS[@]}" "${YAPF_EXCLUDES[@]}" test python
|
|
}
|
|
|
|
# This flag formats individual files. --files *must* be the first command line
|
|
# arg to use this option.
|
|
if [[ "$1" == '--files' ]]; then
|
|
format "${@:2}"
|
|
# If `--all` is passed, then any further arguments are ignored and the
|
|
# entire python directory is formatted.
|
|
elif [[ "$1" == '--all' ]]; then
|
|
format_all
|
|
else
|
|
# Format only the files that changed in last commit.
|
|
format_changed
|
|
fi
|
|
|
|
if ! git diff --quiet &>/dev/null; then
|
|
echo 'Reformatted changed files. Please review and stage the changes.'
|
|
echo 'Files updated:'
|
|
echo
|
|
|
|
git --no-pager diff --name-only
|
|
|
|
exit 1
|
|
fi
|