Replace yapf Python formatter with black (#227)

Author: calcmogul

wpiformat/setup.py

@@ -26,11 +26,12 @@
             "--count",
             # Includes previous year's commits in case one was merged after the
             # year incremented. Otherwise, the version wouldn't increment.
-            "--after=\"main@{" + str(date.today().year - 1) + "-01-01}\"",
-            "main"
+            '--after="main@{' + str(date.today().year - 1) + '-01-01}"',
+            "main",
         ],
         stdout=subprocess.PIPE,
-        stderr=subprocess.STDOUT)
+        stderr=subprocess.STDOUT,
+    )
     # If there is no main branch, the commit count defaults to 0
     if proc.returncode:
         commit_count = "0"
@@ -41,9 +42,8 @@
     version = str(date.today().year) + "." + commit_count.strip()
 
     # Create the version.py file
-    with open(version_file, 'w') as fp:
-        fp.write("# Autogenerated by setup.py\n__version__ = \"{0}\"".format(
-            version))
+    with open(version_file, "w") as fp:
+        fp.write('# Autogenerated by setup.py\n__version__ = "{0}"'.format(version))
 
 if exists(version_file):
     with open(version_file, "r") as fp:
@@ -57,8 +57,7 @@
 setup(
     name="wpiformat",
     version=__version__,
-    description=
-    "Linters and formatters for ensuring WPILib's source code conforms to its style guide",
+    description="Linters and formatters for ensuring WPILib's source code conforms to its style guide",
     long_description=long_description,
     author="WPILib",
     maintainer="Tyler Veness",
@@ -70,13 +69,16 @@
     zip_safe=True,
     setup_requires=["pytest-runner"],
     tests_require=["pytest"],
-    install_requires=["regex==2021.11.10", "yapf==0.31.0"],
+    install_requires=["regex==2021.11.10", "black==22.6.0"],
     license="BSD License",
     classifiers=[
         "Development Status :: 5 - Production/Stable",
-        "Intended Audience :: Developers", "Intended Audience :: Education",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Education",
         "License :: OSI Approved :: BSD License",
-        "Operating System :: OS Independent", "Topic :: Scientific/Engineering",
-        "Programming Language :: Python :: 3"
+        "Operating System :: OS Independent",
+        "Topic :: Scientific/Engineering",
+        "Programming Language :: Python :: 3",
     ],
-    entry_points={"console_scripts": ["wpiformat = wpiformat:main"]})
+    entry_points={"console_scripts": ["wpiformat = wpiformat:main"]},
+)

wpiformat/wpiformat/__init__.py

@@ -41,7 +41,8 @@ def filter_ignored_files(names):
     proc = subprocess.run(
         ["git", "check-ignore", "--no-index", "-n", "-v", "--stdin"],
         input=encoded_names,
-        stdout=subprocess.PIPE)
+        stdout=subprocess.PIPE,
+    )
     if proc.returncode == 128:
         raise subprocess.CalledProcessError
 
@@ -51,7 +52,7 @@ def filter_ignored_files(names):
     # wraps names in quotes on Windows, and outputs "\n" line separators on all
     # platforms.
     return [
-        name[2:].lstrip().strip("\"").replace("\\\\", "\\")
+        name[2:].lstrip().strip('"').replace("\\\\", "\\")
         for name in output_list
         if name[0:2] == "::"
     ]
@@ -260,33 +261,33 @@ def run_batch(task_pipeline, args, file_batches):
 def main():
     # Parse command-line arguments
     parser = argparse.ArgumentParser(
-        description=
-        "Runs all formatting tasks on the code base. This should be invoked from a directory within the project."
+        description="Runs all formatting tasks on the code base. This should be invoked from a directory within the project."
     )
     parser.add_argument(
         "-v",
         dest="verbose1",
         action="store_true",
-        help="verbosity level 1 (prints names of processed files)")
+        help="verbosity level 1 (prints names of processed files)",
+    )
     parser.add_argument(
         "-vv",
         dest="verbose2",
         action="store_true",
-        help=
-        "verbosity level 2 (prints names of processed files and tasks run on them)"
+        help="verbosity level 2 (prints names of processed files and tasks run on them)",
     )
     list_files_group = parser.add_mutually_exclusive_group()
     list_files_group.add_argument(
         "-list-all-files",
         dest="list_all_files",
         action="store_true",
-        help="list files to be processed instead of processing them")
+        help="list files to be processed instead of processing them",
+    )
     list_files_group.add_argument(
         "-list-changed-files",
         dest="list_changed_files",
         action="store_true",
-        help=
-        "same as list-all-files, but list only files changed from main branch")
+        help="same as list-all-files, but list only files changed from main branch",
+    )
     # mp.Pool() uses WaitForMultipleObjects() to wait for subprocess completion
     # on Windows. WaitForMultipleObjects() cannot wait on more then 64 events at
     # once, and mp uses a few internal events. Therefore, the maximum number of
@@ -297,51 +298,49 @@ def main():
         dest="jobs",
         type=int,
         default=cpu_count,
-        help="number of jobs to run (default is number of cores)")
+        help="number of jobs to run (default is number of cores)",
+    )
     parser.add_argument(
         "-clang",
         dest="clang_version",
         type=str,
         default="",
-        help=
-        "version suffix for clang-format (invokes \"clang-format-CLANG_VERSION\" or \"clang-format\" if no suffix provided)"
+        help='version suffix for clang-format (invokes "clang-format-CLANG_VERSION" or "clang-format" if no suffix provided)',
     )
     tidy_group = parser.add_mutually_exclusive_group()
     tidy_group.add_argument(
         "-tidy-changed",
         dest="tidy_changed",
         action="store_true",
-        help=
-        "also runs clang-tidy-CLANG_VERSION on changed files; this requires a compile_commands.json file"
+        help="also runs clang-tidy-CLANG_VERSION on changed files; this requires a compile_commands.json file",
     )
     tidy_group.add_argument(
         "-tidy-all",
         dest="tidy_all",
         action="store_true",
-        help=
-        "also runs clang-tidy-CLANG_VERSION on all files (this takes a while); this requires a compile_commands.json file"
+        help="also runs clang-tidy-CLANG_VERSION on all files (this takes a while); this requires a compile_commands.json file",
     )
     parser.add_argument(
         "-compile-commands",
         dest="compile_commands",
         type=str,
         default="",
-        help=
-        "path to directory containing compile_commands.json; if unset will search in parent paths"
+        help="path to directory containing compile_commands.json; if unset will search in parent paths",
     )
     parser.add_argument(
         "-f",
         dest="file",
         type=str,
         default="",
         nargs="+",
-        help=
-        "file or directory names (can be path relative to python invocation directory or absolute path)"
+        help="file or directory names (can be path relative to python invocation directory or absolute path)",
+    )
+    parser.add_argument(
+        "-no-format",
+        dest="no_format",
+        action="store_true",
+        help="disable formatting steps, only run linting",
     )
-    parser.add_argument("-no-format",
-                        dest="no_format",
-                        action="store_true",
-                        help="disable formatting steps, only run linting")
     args = parser.parse_args()
 
     # tidy requires compile_commands.json
@@ -350,7 +349,8 @@ def main():
         if not os.path.exists(ccloc):
             print(
                 f"error: clang-tidy: {ccloc} not found (try -compile-commands)",
-                file=sys.stderr)
+                file=sys.stderr,
+            )
             sys.exit(1)
 
     # All discovered files are relative to Git repo root directory, so find the
@@ -373,9 +373,7 @@ def main():
             os.remove(f)
 
         # Recursively create list of files in given directory
-        files = [
-            os.path.join(dp, f) for dp, dn, fn in os.walk(root_path) for f in fn
-        ]
+        files = [os.path.join(dp, f) for dp, dn, fn in os.walk(root_path) for f in fn]
 
         if not files:
             print("Error: no files found to format", file=sys.stderr)
@@ -385,11 +383,9 @@ def main():
         for name in args.file:
             # If a directory was specified, recursively expand it
             if os.path.isdir(name):
-                files.extend([
-                    os.path.join(dp, f)
-                    for dp, dn, fn in os.walk(name)
-                    for f in fn
-                ])
+                files.extend(
+                    [os.path.join(dp, f) for dp, dn, fn in os.walk(name) for f in fn]
+                )
             else:
                 files.append(name)
 
@@ -412,8 +408,9 @@ def main():
     branch_options = ["master", "main"]
     main_branch = ""
     for branch in branch_options:
-        proc = subprocess.run(["git", "rev-parse", "-q", "--verify", branch],
-                              stdout=subprocess.DEVNULL)
+        proc = subprocess.run(
+            ["git", "rev-parse", "-q", "--verify", branch], stdout=subprocess.DEVNULL
+        )
         if proc.returncode == 0:
             main_branch = branch
             break
@@ -426,10 +423,9 @@ def main():
 
     # Create list of all changed files
     output_list = subprocess.check_output(
-        ["git", "diff", "--name-only", main_branch], encoding="ascii").split()
-    changed_file_list = [
-        root_path + os.sep + line.strip() for line in output_list
-    ]
+        ["git", "diff", "--name-only", main_branch], encoding="ascii"
+    ).split()
+    changed_file_list = [root_path + os.sep + line.strip() for line in output_list]
 
     # Don't run tasks on modifiable or generated files
     work = []
@@ -461,9 +457,7 @@ def main():
 
     # Prepare file batches for batch tasks
     chunksize = math.ceil(len(files) / args.jobs)
-    file_batches = [
-        files[i:i + chunksize] for i in range(0, len(files), chunksize)
-    ]
+    file_batches = [files[i : i + chunksize] for i in range(0, len(files), chunksize)]
 
     if args.no_format:
         # Only run Lint

wpiformat/wpiformat/bracecomment.py

@@ -8,7 +8,6 @@
 
 
 class BraceComment(Task):
-
     @staticmethod
     def should_process_file(config_file, name):
         return config_file.is_c_file(name) or config_file.is_cpp_file(name)
@@ -21,9 +20,14 @@ def run_pipeline(self, config_file, name, lines):
         brace_postfix = r"[ \t]*/(/|\*)[^\r\n]*"
 
         brace_regex = regex.compile(
-            r"/\*|\*/|//|\\\\|\\\"|\"|\\'|'|" + linesep + r"|" + \
-            r"(" + brace_prefix + r"\s*)?{|"  # "{" with optional prefix
-            r"}(" + brace_postfix + r")?")  # "}" with optional comment postfix
+            r"/\*|\*/|//|\\\\|\\\"|\"|\\'|'|"
+            + linesep
+            + r"|"
+            + r"("
+            + brace_prefix
+            + r"\s*)?{|"  # "{" with optional prefix
+            r"}(" + brace_postfix + r")?"
+        )  # "}" with optional comment postfix
 
         name_stack = []
         brace_count = 0
@@ -52,9 +56,9 @@ def run_pipeline(self, config_file, name, lines):
                 # Tokens processed after this branch are ignored if they are in
                 # comments
                 continue
-            elif token == "\\\"":
+            elif token == '\\"':
                 continue
-            elif token == "\"":
+            elif token == '"':
                 if not in_char:
                     in_string = not in_string
             elif token == "\\'":
@@ -72,12 +76,14 @@ def run_pipeline(self, config_file, name, lines):
             elif "{" in token:
                 brace_count += 1
             elif token.startswith("}"):
-                output += lines[extract_location:match.start()]
-                if len(name_stack) > 0 and name_stack[len(name_stack) -
-                                                      1][0] == brace_count:
+                output += lines[extract_location : match.start()]
+                if (
+                    len(name_stack) > 0
+                    and name_stack[len(name_stack) - 1][0] == brace_count
+                ):
                     output += "}  // " + name_stack.pop()[1]
                 else:
-                    output += lines[match.start():match.end()]
+                    output += lines[match.start() : match.end()]
                 extract_location = match.end()
                 brace_count -= 1
 

wpiformat/wpiformat/cidentlist.py

@@ -6,12 +6,13 @@
 
 
 class CIdentList(Task):
-
     @staticmethod
     def __print_failure(name):
-        print("Error: " + name + ": unmatched curly braces when scanning for "
-              "C identifier lists. If the code compiles, this is a bug in "
-              "wpiformat.")
+        print(
+            "Error: " + name + ": unmatched curly braces when scanning for "
+            "C identifier lists. If the code compiles, this is a bug in "
+            "wpiformat."
+        )
 
     @staticmethod
     def should_process_file(config_file, name):
@@ -44,9 +45,15 @@ def run_pipeline(self, config_file, name, lines):
         extern_str = r"(?P<ext_decl>extern \"C(\+\+)?\")\s+(?P<ext_brace>\{)?|"
         braces_str = r"\{|\}|;|def\s+\w+|\w+\s+\w+\s*(?P<paren>\(\))"
         postfix_str = r"(?=\s*(;|\{))"
-        token_regex = regex.compile(preproc_str + comment_str + string_str +
-                                    char_str + extern_str + braces_str +
-                                    postfix_str)
+        token_regex = regex.compile(
+            preproc_str
+            + comment_str
+            + string_str
+            + char_str
+            + extern_str
+            + braces_str
+            + postfix_str
+        )
 
         EXTRA_POP_OFFSET = 2
 
@@ -95,9 +102,9 @@ def run_pipeline(self, config_file, name, lines):
                 # Tokens processed after this branch are ignored if they are in
                 # comments
                 continue
-            elif token == "\\\"":
+            elif token == '\\"':
                 continue
-            elif token == "\"":
+            elif token == '"':
                 if not in_char:
                     in_string = not in_string
             elif token == "\\'":
@@ -146,14 +153,13 @@ def run_pipeline(self, config_file, name, lines):
                     extern_brace_indices.append(is_c + EXTRA_POP_OFFSET)
 
                 # Change language based on extern declaration
-                if match.group("ext_decl") == "extern \"C\"":
+                if match.group("ext_decl") == 'extern "C"':
                     is_c = True
                 else:
                     is_c = False
-            elif match.group(
-                    "paren") and "return " not in match.group() and is_c:
+            elif match.group("paren") and "return " not in match.group() and is_c:
                 # Replaces () with (void)
-                output += lines[pos:match.span("paren")[0]] + "(void)"
+                output += lines[pos : match.span("paren")[0]] + "(void)"
                 pos = match.span("paren")[0] + len("()")
 
         # Write rest of file if it wasn't all processed