Add GitHub Actions Workflow for Python Code Formatting and Linting

.github/workflows/test-python.yaml

@@ -26,15 +26,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-        # TODO (andreyvelich): We need to replace this action with script to do
-        # linting and formatting for Training Operator SDK.
-      - name: Check Python code with Black
-        uses: psf/black@stable
-        with:
-          version: 24.2.0
-          options: --check --exclude '/*kubeflow_org_v1*|__init__.py|api_client.py|configuration.py|exceptions.py|rest.py'
-          src: sdk/
-
+      - name: Check Python code with Black and Flake8
+        run: |
+          pip install black Flake8
+          make fmt-python
       - name: Install dependencies
         run: |
           pip install pytest python-dateutil urllib3 kubernetes

Makefile

@@ -116,3 +116,6 @@ controller-gen: ## Download controller-gen locally if necessary.
 KUSTOMIZE = $(shell pwd)/bin/kustomize
 kustomize: ## Download kustomize locally if necessary.
 	GOBIN=$(PROJECT_DIR)/bin go install sigs.k8s.io/kustomize/kustomize/[email protected]
+
+fmt-python:
+	hack/verify-python.sh

hack/verify-python.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+SCRIPT_ROOT=$(dirname "${BASH_SOURCE}")/..
+DIFFROOT="${SCRIPT_ROOT}/sdk"
+TMP_DIFFROOT="${SCRIPT_ROOT}/_tmp/sdk"
+_tmp="${SCRIPT_ROOT}/_tmp"
+
+cleanup() {
+  rm -rf "${_tmp}"
+}
+trap "cleanup" EXIT SIGINT
+
+cleanup
+
+mkdir -p "${TMP_DIFFROOT}"
+cp -a "${DIFFROOT}"/* "${TMP_DIFFROOT}"
+
+black "${DIFFROOT}" --exclude '/*kubeflow_org_v1*|__init__.py|api_client.py|configuration.py|exceptions.py|rest.py'
+
+echo "Comparing ${DIFFROOT} with ${TMP_DIFFROOT}..."
+ret=0
+diff -Naupr "${DIFFROOT}" "${TMP_DIFFROOT}" || ret=$?
+
+cp -a "${TMP_DIFFROOT}"/* "${DIFFROOT}"
+
+if [[ $ret -eq 0 ]]; then
+  echo "Code is properly formatted."
+else
+  echo "Code is not properly formatted. Please run 'make fmt-python'"
+  exit 1
+fi
+
+if ! flake8 "${DIFFROOT}" --exclude='/*kubeflow_org_v1*,__init__.py,api_client.py,configuration.py,exceptions.py,rest.py'; then
+  echo "Code linting failed. Please fix the issues reported by flake8."
+  exit 1
+fi