Add isort to ramble style check

Author: linsword13

lib/ramble/ramble/cmd/style.py

@@ -14,11 +14,10 @@
 import sys
 import tempfile
 
-from llnl.util.filesystem import working_dir, mkdirp
+from llnl.util.filesystem import mkdirp, working_dir
+from spack.util.executable import ProcessError, which
 
 import ramble.paths
-from spack.util.executable import which, ProcessError
-
 
 description = "runs source code style checks on Ramble."
 section = "developer"
@@ -119,7 +118,7 @@ def is_object(f):
 }
 
 # Tools run in the given order, with flake8 as the last check.
-tool_names = ["black", "flake8"]
+tool_names = ["isort", "black", "flake8"]
 
 tools = {}
 
@@ -473,6 +472,20 @@ def run_black(black_cmd, file_list, args):
     return returncode
 
 
+@tool("isort")
+def run_isort(isort_cmd, file_list, args):
+    isort_args = ("--sp", os.path.join(ramble.paths.prefix, "pyproject.toml"))
+    if not args.fix:
+        isort_args += ("--check", "--diff")
+    output = isort_cmd(
+        *(isort_args + tuple(file_list)), fail_on_error=False, output=str, error=str
+    )
+    returncode = isort_cmd.returncode
+    print_output(output, args)
+    print_tool_result("isort", returncode)
+    return returncode
+
+
 def validate_toolset(arg_value):
     """Validate --tool and --skip arguments (sets of optionally comma-separated tools)."""
     tools = set(",".join(arg_value).split(","))  # allow args like 'black,flake8'

pyproject.toml

@@ -17,6 +17,16 @@ force-exclude = '''
 )/
 '''
 
+[tool.isort]
+line_length = 99
+profile = "black"
+filter_files = true
+skip_glob = [
+  "**/lib/ramble/external/**",
+  "**/lib/ramble/llnl/**",
+  "**/lib/ramble/spack/**",
+]
+
 [tool.coverage.run]
 parallel = true
 data_file = "./tests-coverage/.coverage"

requirements-dev.txt

@@ -7,3 +7,4 @@ pre-commit
 pytest-xdist
 pytest-cov
 line_profiler
+isort