Convert check_banned_imports.sh to Python to workaround Bash array issues and for less duplication

build-support/bin/BUILD

@@ -7,6 +7,12 @@ python_library(
   compatibility = ['CPython>=3.6'],
 )
 
+python_binary(
+  name = 'check_banned_imports',
+  sources = 'check_banned_imports.py',
+  compatibility = ['CPython>=3.6'],
+)
+
 python_binary(
   name = 'check_header_helper',
   sources = 'check_header_helper.py',

build-support/bin/check_banned_imports.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+import re
+from glob import glob
+from typing import List
+
+from common import die
+
+
+def main() -> None:
+  python_files = find_files(
+      "src", "tests", "pants-plugins", "examples", "contrib", extension=".py"
+  )
+  rust_files = find_files("src/rust/engine", extension=".rs")
+
+  check_banned_import(
+    python_files,
+    bad_import_regex=r"^import subprocess$",
+    correct_import_message="`from pants.util.process_handler import subprocess`"
+  )
+  check_banned_import(
+    python_files,
+    bad_import_regex=r"^import future.moves.collections|^from future.moves.collections import|^from future.moves import .*collections",
+    correct_import_message="`import collections` or `from pants.util.collections_abc_backport`"
+  )
+  check_banned_import(
+    rust_files,
+    bad_import_regex=r"^use std::sync::.*(Mutex|RwLock)",
+    correct_import_message="`parking_lot::(Mutex|RwLock)`"
+  )
+
+
+def find_files(*directories: str, extension: str) -> List[str]:
+  return [
+    fp
+    for directory in directories
+    for fp in glob(f"{directory}/**/*{extension}", recursive=True)
+  ]
+
+
+def check_banned_import(files: List[str], *, bad_import_regex: str, correct_import_message: str) -> None:
+  regex = re.compile(bad_import_regex)
+  bad_files: List[str] = []
+  for fp in files:
+    with open(fp, 'r') as f:
+      if any(re.search(regex, line) for line in f.readlines()):
+        bad_files.append(fp)
+  if bad_files:
+    bad_files_str = "\n".join(bad_files)
+    die(
+      f"Found forbidden imports matching `{bad_import_regex}`. Instead, you should use "
+      f"{correct_import_message}. Bad files:\n{bad_files_str}")
+
+
+if __name__ == "__main__":
+  main()

build-support/githooks/pre-commit

@@ -47,7 +47,7 @@ printf "%s\n" "${ADDED_FILES[@]}" \
   | ./build-support/bin/check_header_helper.py "${DIRS_TO_CHECK[@]}"
 
 echo "* Checking for banned imports"
-./build-support/bin/check_banned_imports.sh
+./build-support/bin/check_banned_imports.py
 
 echo "* Checking for bad shell patterns" && ./build-support/bin/check_shell.sh || exit 1