如何递归运行 yapf

介绍

yapf 是一个 Python 代码格式化工具，可以帮助程序员自动化地调整 Python 代码的格式，使其更加规范、易读、易维护。但如果要运行 yapf 整个项目的所有文件，怎么做呢？接下来将介绍如何递归运行 yapf。

代码

下面是一段递归运行 yapf 的 Python 代码片段：

import os
import yapf

def reformat_file(filename):
    """
    用 yapf 格式化指定文件
    """
    with open(filename, "r", encoding="utf-8") as f:
        code = f.read()

    reformatted_code, _ = yapf.api.FormatCode(code, filename=filename)

    with open(filename, "w", encoding="utf-8") as f:
        f.write(reformatted_code)

def reformat_directory(directory):
    """
    递归地用 yapf 格式化指定目录下的所有文件
    """
    for filename in os.listdir(directory):
        file_path = os.path.join(directory, filename)
        if os.path.isdir(file_path):
            reformat_directory(file_path)
        elif filename.endswith(".py"):
            try:
                reformat_file(file_path)
                print(f"{file_path} formatted.")
            except:
                print(f"{file_path} format failed.")

reformat_directory("your_project_path")

代码中，reformat_file 函数是用 yapf 格式化指定文件的函数，该函数的参数为文件名。reformat_directory 函数是用 yapf 递归地格式化指定目录下的所有 Python 文件的函数，该函数的参数为目录名。最后，使用 reformat_directory 函数传入整个项目的路径，就可以递归地格式化项目中的所有 Python 文件了。

值得注意的是，如果你在格式化文件时遇到了无法解决的错误，该文件将不能被格式化。在这种情况下，代码会输出错误信息，并继续处理其他文件。

结论

递归运行 yapf 可以帮助程序员自动化地调整项目中所有 Python 文件的格式，从而提高代码的规范化程度和可读性，减少手动调整代码风格的工作量。