Merge pull request #230 from InsightSoftwareConsortium/black-pre-commit

ENH: Add black style pre-commit hook

Author: thewtex

.gitattributes

@@ -8,6 +8,7 @@
 *.txx            our-c-style
 *.txt            whitespace=tab-in-indent,no-lf-at-eof
 *.cmake          whitespace=tab-in-indent,no-lf-at-eof
+*.py             hooks.style=black
 
 # ExternalData content links must have LF newlines
 *.md5            crlf=input

.github/workflows/clang-format-linter.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on: [push,pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+
+    - name: Lint C++
+      uses: InsightSoftwareConsortium/ITKClangFormatLinterAction@master
+
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+
+    - name: Install Python dependencies
+      run: pip install black
+
+    - name: Lint Python
+      uses: wearerequired/lint-action@v1
+      with:
+        black: true
+        black_dir: src/

.github/workflows/lint.yml

@@ -4,14 +4,19 @@ set(_itk_venv "${CMAKE_CURRENT_BINARY_DIR}/itkpython")
 if(WIN32)
   set(ITKPYTHON_EXECUTABLE "${_itk_venv}/python.exe" CACHE FILEPATH "Python executable with the ITK package installed" FORCE)
   set(SPHINX_EXECUTABLE "${_itk_venv}/Scripts/sphinx-build.exe" CACHE FILEPATH "Sphinx executable" FORCE)
+  set(BLACK_EXECUTABLE "${_itk_venv}/Scripts/black.exe" CACHE FILEPATH "black executable" FORCE)
 else()
   set(ITKPYTHON_EXECUTABLE "${_itk_venv}/bin/python" CACHE FILEPATH "Python executable with the ITK package installed" FORCE)
   set(SPHINX_EXECUTABLE "${_itk_venv}/bin/sphinx-build" CACHE FILEPATH "Sphinx executable" FORCE)
+  set(BLACK_EXECUTABLE "${_itk_venv}/bin/black" CACHE FILEPATH "black executable" FORCE)
 endif()
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/ITKBlackConfig.cmake.in"
+               "${CMAKE_CURRENT_BINARY_DIR}/ITKBlackConfig.cmake" @ONLY)
 
 ExternalProject_Add(ITKPython
   DOWNLOAD_COMMAND ""
   CONFIGURE_COMMAND ${PYTHON_EXECUTABLE} -m venv "${_itk_venv}"
   BUILD_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --upgrade pip
-  INSTALL_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --ignore-installed itk>=5.2rc3 sphinx==3.0.4 six
+  INSTALL_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --ignore-installed itk>=5.2rc3 sphinx==3.0.4 six black
+  COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/ITKBlackConfig.cmake
   )

Superbuild/External-Python.cmake

@@ -0,0 +1,17 @@
+set(ITKExamples_SOURCE_DIR "@ITKExamples_SOURCE_DIR@")
+set(CMAKE_SOURCE_DIR "@CMAKE_SOURCE_DIR@")
+set(BLACK_EXECUTABLE "@BLACK_EXECUTABLE@")
+
+set(WORKING_DIR "")
+if(ITKExamples_SOURCE_DIR)
+  set(WORKING_DIR "${ITKExamples_SOURCE_DIR}/..")
+else()
+  set(WORKING_DIR "${CMAKE_SOURCE_DIR}/..")
+endif()
+
+find_package(Git)
+if(GIT_FOUND AND EXISTS "${WORKING_DIR}/.git/config")
+  execute_process(COMMAND ${GIT_EXECUTABLE} config black.executable
+    "${BLACK_EXECUTABLE}"
+    WORKING_DIRECTORY ${WORKING_DIR})
+endif()

Superbuild/ITKBlackConfig.cmake.in

@@ -14,7 +14,7 @@
 # limitations under the License.
 #=============================================================================
 
-# Run clangformat and KWStyle pre-commit hooks.
+# Run clangformat, KWStyle, black pre-commit hooks.
 #
 # 'git config' is used to enable the hooks and set their configuration files.
 # The repository .gitattributes must also enable the hooks on the targeted
@@ -32,6 +32,8 @@ do_KWStyle=$(git config --bool hooks.KWStyle) || do_KWStyle=false
 
 do_clangformat=$(git config --bool hooks.clangformat) || do_clangformat=true
 
+do_black=$(git config --bool hooks.blackformat) || do_blackformat=true
+
 #-----------------------------------------------------------------------------
 # Check if we want to run the style on a given file.  Uses git attributes.  If
 # the hook.style attribute is set, then all styles are executed.  If the
@@ -164,8 +166,8 @@ check_for_clangformat() {
   clangformat_path=$(type -p "$system_clang_format" >/dev/null) ||
   die "clang-format executable was not found.
 
-A clang-format binary will be downloaded and configured when ITK
-is built with the BUILD_TESTING CMake configuration option enabled.
+A clang-format binary will be downloaded and configured when the ITKExamples
+Superbuild is built with the BUILD_TESTING CMake configuration option enabled.
 
 Alternatively, install clang-format version $clangformat_required_version or set the executable location with
 
@@ -292,25 +294,81 @@ For more information, see
   done # end for changed files
 }
 
+#-----------------------------------------------------------------------------
+# black.
+check_for_black() {
+  system_black=""
+  if type -p "black" >/dev/null; then
+    system_black="black"
+  fi
+  black_path=$(git config black.executable) ||
+  black_path=$(type -p "$system_black" >/dev/null) ||
+  die "black executable was not found.
+
+A black Python formatting tool will be downloaded and configured when the ITKExamples
+Superbuild is built with the BUILD_TESTING CMake configuration option enabled.
+
+Alternatively, install black with:
+
+  python -m pip install black
+
+and set the executable location with
+
+  git config black.executable /path/to/black
+
+if it is not in the system's PATH.
+"
+}
+
+run_black_on_file() {
+  "$black_path" "$1"
+
+  if test $? -ne 0; then
+    die "black style application failed."
+  fi
+  return 0
+}
+
+run_black() {
+  $do_black && check_for_black
+  if test $?; then
+    have_black=true
+  else
+    have_black=false
+  fi
+
+  git diff-index --cached --diff-filter=ACMR --name-only HEAD -- |
+  while read f; do
+    if run_style_on_file "$f" "black"; then
+      run_black_on_file "$f"
+    fi || return
+  done
+}
+
 # Do not run during merge commits for now.
 if test -f "$GIT_DIR/MERGE_HEAD"; then
   :
-elif $do_clangformat; then
-  # We use git-mergetool settings to review the clangformat changes.
-  TOOL_MODE=merge
-  . "$(git --exec-path)/git-mergetool--lib"
-  # Redefine check_unchanged because we do not need to check if the merge was
-  # successful.
-  check_unchanged() {
-    status=0
-  }
-  check_for_clangformat
-  run_clangformat || exit 1
-# do_clangformat will run KWStyle on the files incrementally so excessive
-# clangformat merges do not have to occur.
-elif $do_KWStyle; then
-  if check_for_KWStyle; then
-    run_KWStyle || exit 1
+else
+  if $do_clangformat; then
+    # We use git-mergetool settings to review the clangformat changes.
+    TOOL_MODE=merge
+    . "$(git --exec-path)/git-mergetool--lib"
+    # Redefine check_unchanged because we do not need to check if the merge was
+    # successful.
+    check_unchanged() {
+      status=0
+    }
+    check_for_clangformat
+    run_clangformat || exit 1
+    # do_clangformat will run KWStyle on the files incrementally so excessive
+    # clangformat merges do not have to occur.
+  elif $do_KWStyle; then
+    if check_for_KWStyle; then
+      run_KWStyle || exit 1
+    fi
+  fi
+  if $do_black; then
+    run_black || exit 1
   fi
 fi
 

Utilities/Hooks/pre-commit-style.bash

@@ -18,12 +18,13 @@
 import itk
 
 from distutils.version import StrictVersion as VS
+
 if VS(itk.Version.GetITKVersion()) < VS("4.10.0"):
     print("ITK 4.10.0 is required.")
     sys.exit(1)
 
 if len(sys.argv) != 2:
-    print('Usage: ' + sys.argv[0] + ' <InputFileName>')
+    print("Usage: " + sys.argv[0] + " <InputFileName>")
     sys.exit(1)
 imageFileName = sys.argv[1]
 

src/Bridge/VtkGlue/ConvertAnRGBitkImageTovtkImageData/Code.py

@@ -18,7 +18,7 @@
 import itk
 
 if len(sys.argv) != 2:
-    print('Usage: ' + sys.argv[0] + ' <InputFileName>')
+    print("Usage: " + sys.argv[0] + " <InputFileName>")
     sys.exit(1)
 imageFileName = sys.argv[1]
 

src/Bridge/VtkGlue/ConvertAnitkImageTovtkImageData/Code.py

@@ -19,7 +19,7 @@
 import vtk
 
 if len(sys.argv) < 2:
-    print('Usage: ' + sys.argv[0] + ' <InputFileName>')
+    print("Usage: " + sys.argv[0] + " <InputFileName>")
     sys.exit(1)
 imageFileName = sys.argv[1]
 

src/Bridge/VtkGlue/ConvertRGBvtkImageDataToAnitkImage/Code.py

@@ -19,7 +19,7 @@
 import vtk
 
 if len(sys.argv) < 2:
-    print('Usage: ' + sys.argv[0] + ' <InputFileName>')
+    print("Usage: " + sys.argv[0] + " <InputFileName>")
     sys.exit(1)
 imageFileName = sys.argv[1]