如何在基于libcst的Codemod中跳过test_开头的测试文件？

要跳过所有以test_开头的测试文件，有两种高效实现方式，优先推荐第一种：

方法一：重写should_process_file方法（推荐） #

这个方法在文件被读取解析前就会判断是否跳过，能最大化提升效率。只需在你的Codemod类中重写该方法，添加文件名判断逻辑：

from libcst.codemod import VisitorBasedCodemodCommand

class YourCustomCodemod(VisitorBasedCodemodCommand):
    def should_process_file(self, filename: str) -> bool:
        # 跳过test_开头的文件
        if filename.startswith("test_"):
            return False
        # 继承父类的默认判断逻辑
        return super().should_process_file(filename)

返回False时，libcst会直接跳过该文件，不会执行后续的解析和转换操作。

方法二：在transform_module中抛出SkipFile异常 #

如果需要在解析模块后再做判断（比如结合模块内容做更复杂的跳过逻辑），可以在transform_module方法开头添加判断并抛出SkipFile异常：

from libcst import Module
from libcst.codemod import VisitorBasedCodemodCommand, SkipFile

class YourCustomCodemod(VisitorBasedCodemodCommand):
    def transform_module(self, tree: Module) -> Module:
        # 获取当前处理的文件名
        current_filename = self.context.filename
        if current_filename.startswith("test_"):
            raise SkipFile("跳过测试文件")
        # 执行你的转换逻辑
        return super().transform_module(tree)

抛出SkipFile后，libcst会终止当前文件的处理流程，直接跳过。

内容的提问来源于stack exchange，提问作者Martin Faucheux