lint

Author: amogkam

.style.yapf

@@ -0,0 +1,5 @@
+[style]
+based_on_style=pep8
+allow_split_before_dict_value=False
+join_multiple_lines=False
+allow_multiline_lambdas=True

format.sh

@@ -0,0 +1,148 @@
+#!/usr/bin/env bash
+# YAPF + Clang formatter (if installed). This script formats all changed files from the last mergebase.
+# You are encouraged to run this locally before pushing changes for review.
+
+# Cause the script to exit if a single command fails
+set -eo pipefail
+
+FLAKE8_VERSION_REQUIRED="3.7.7"
+YAPF_VERSION_REQUIRED="0.23.0"
+
+check_command_exist() {
+    VERSION=""
+    case "$1" in
+        yapf)
+            VERSION=$YAPF_VERSION_REQUIRED
+            ;;
+        flake8)
+            VERSION=$FLAKE8_VERSION_REQUIRED
+            ;;
+        *)
+            echo "$1 is not a required dependency"
+            exit 1
+    esac
+    if ! [ -x "$(command -v $1)" ]; then
+        echo "$1 not installed. pip install $1==$VERSION"
+        exit 1
+    fi
+}
+
+check_command_exist yapf
+check_command_exist flake8
+
+ver=$(yapf --version)
+if ! echo $ver | grep -q 0.23.0; then
+    echo "Wrong YAPF version installed: 0.23.0 is required, not $ver. $YAPF_DOWNLOAD_COMMAND_MSG"
+    exit 1
+fi
+
+# 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 remote if it doesn't exist
+if ! git remote -v | grep -q upstream; then
+    git remote add 'upstream' 'https://github.com/ray-project/ray_lightning_accelerators.git'
+fi
+
+FLAKE8_VERSION=$(flake8 --version | awk '{print $1}')
+YAPF_VERSION=$(yapf --version | awk '{print $2}')
+
+# params: tool name, tool version, required version
+tool_version_check() {
+    if [[ $2 != $3 ]]; then
+        echo "WARNING: Ray uses $1 $3, You currently are using $2. This might generate different results."
+    fi
+}
+
+tool_version_check "flake8" $FLAKE8_VERSION $FLAKE8_VERSION_REQUIRED
+tool_version_check "yapf" $YAPF_VERSION $YAPF_VERSION_REQUIRED
+
+if which clang-format >/dev/null; then
+  CLANG_FORMAT_VERSION=$(clang-format --version | awk '{print $3}')
+  tool_version_check "clang-format" $CLANG_FORMAT_VERSION "7.0.0"
+else
+    echo "WARNING: clang-format is not installed!"
+fi
+
+# Only fetch main since that's the branch we're diffing against.
+git fetch upstream main || true
+
+YAPF_FLAGS=(
+    '--style' "$ROOT/.style.yapf"
+    '--recursive'
+    '--parallel'
+)
+
+YAPF_EXCLUDES=(
+    # '--exclude' 'python/ray/cloudpickle/*'
+    # '--exclude' 'python/build/*'
+    # '--exclude' 'python/ray/core/src/ray/gcs/*'
+    # '--exclude' 'python/ray/thirdparty_files/*'
+)
+
+# Format specified files
+format() {
+    yapf --in-place "${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=ACRM` and $MERGEBASE is to ensure we only format files that
+    # exist on both branches.
+    MERGEBASE="$(git merge-base upstream/main HEAD)"
+
+    if ! git diff --diff-filter=ACRM --quiet --exit-code "$MERGEBASE" -- '*.py' &>/dev/null; then
+        git diff --name-only --diff-filter=ACRM "$MERGEBASE" -- '*.py' | xargs -P 5 \
+             yapf --in-place "${YAPF_EXCLUDES[@]}" "${YAPF_FLAGS[@]}"
+        if which flake8 >/dev/null; then
+            git diff --name-only --diff-filter=ACRM "$MERGEBASE" -- '*.py' | xargs -P 5 \
+                 flake8 --inline-quotes '"' --no-avoid-escape --ignore=C408,E121,E123,E126,E226,E24,E704,W503,W504,W605
+        fi
+    fi
+
+    if ! git diff --diff-filter=ACRM --quiet --exit-code "$MERGEBASE" -- '*.pyx' '*.pxd' '*.pxi' &>/dev/null; then
+        if which flake8 >/dev/null; then
+            git diff --name-only --diff-filter=ACRM "$MERGEBASE" -- '*.pyx' '*.pxd' '*.pxi' | xargs -P 5 \
+                 flake8 --inline-quotes '"' --no-avoid-escape --ignore=C408,E121,E123,E126,E211,E225,E226,E227,E24,E704,E999,W503,W504,W605
+        fi
+    fi
+}
+
+# Format all files, and print the diff to stdout for travis.
+format_all() {
+    yapf --diff "${YAPF_FLAGS[@]}" "${YAPF_EXCLUDES[@]}" ray_lightning
+    flake8 --inline-quotes '"' --no-avoid-escape --ignore=C408,E121,E123,E126,E211,E225,E226,E227,E24,E704,E999,W503,W504,W605 ray_lightning
+}
+
+# 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
+
+echo 'Linting check finished successfully.'