Merge pull request #1685 from byuccl/pylint_args

Update pylint_check.py to check individual files

Author: jgoeders

README.developers.md

@@ -177,7 +177,7 @@ For large scale reformatting (should only be performed by VTR maintainers) the s
 
 ## Python Linting
 
-Python files are automatically checked using `pylint` to ensure they follow established Python conventions.  You can check an individual Python file by running `pylint <your_python_file>`, or check the entire repository by running `./dev/pylint_check.py`.
+Python files are automatically checked using `pylint` to ensure they follow established Python conventions.  You can run `pylint` on the entire repository by running `./dev/pylint_check.py`.  Certain files which were created before we adopted Python lint checking are grandfathered and are not checked.  To check *all* files, provide the `--check_grandfathered` argument.  You can also manually check individual files using `./dev/pylint_check.py <path_to_file1> <path_to_file2> ...`.
 
 # Running Tests
 

dev/pylint_check.py

@@ -121,7 +121,7 @@ def expand_paths():
             if path.suffix.lower() != ".py":
                 print(path, "does note have extension '.py'")
                 sys.exit(-1)
-            paths.append(path)
+            paths.append(path.resolve())
 
         # If path is a directory, search for .py files
         elif path.is_dir():
@@ -151,11 +151,22 @@ def main():
         action="store_true",
         help="Also check grandfathered files for lint errors.",
     )
+    parser.add_argument("files", nargs="*", help="List of files to check using pylint.")
     args = parser.parse_args()
 
-    # Expand all paths
-    paths = expand_paths()
-    print(TermColor.BLUE + "Linting", len(paths), "python files.", TermColor.END)
+    # Check if we are doing all files, or user-provided list
+    if args.files:
+        # Check that all files exist, and build pathlib objects
+        paths = []
+        for file in args.files:
+            f_path = pathlib.Path(file).resolve()
+            if not f_path.is_file():
+                error(f_path, "does not exist")
+            paths.append(f_path)
+    else:
+        # Expand all paths
+        paths = expand_paths()
+    print(TermColor.BLUE + "Linting", len(paths), "python file(s).", TermColor.END)
 
     # Lint files
     num_error_files = 0