快捷導(dǎo)航

python實現(xiàn)獲取文件中的類方式

更新時間：2025年12月31日 09:26:16 作者：我一個搬磚人

本文介紹了兩種獲取Python文件中類的方法：一種是通過導(dǎo)入文件,另一種是通過不導(dǎo)入文件獲取類名,不導(dǎo)入文件的方法通過解析抽象語法樹（AST）并使用正則表達(dá)式來過濾出特定類名,從而避免了全量導(dǎo)入帶來的問題

1. 導(dǎo)入文件的方式獲取文件中的類

由于工作需求，需要獲得文件中的某一些類的內(nèi)容。

一般比較常用的方法是通過遍歷文件，然后通過調(diào)用importlib包導(dǎo)入文件，就能獲得文件中的內(nèi)容，從而獲取想要的類。

代碼如下：

for importer, package_name, is_pkg in pkgutil.walk_packages('.'):
	importlib.import_module(package_name)
	module = sys.modules[package_name]

	for cls_name, cls in inspect.getmembers(module, inspect.isclass):
		if is_want_class(cls):  
			do_something()

該方法十分簡單，但是也有弊端。由于需要導(dǎo)入文件，因此文件中的內(nèi)容都會被執(zhí)行。而在一個項目中，存在著成百上千的文件，有一些代碼是相斥的。

如果通過這種方法獲取類，輕則出現(xiàn)邏輯問題，重則出現(xiàn)異常，報錯。

2. 通過不導(dǎo)入文件的方式獲取文件中的類名，從而過濾文件

為了防止上面說到的問題影響項目，我們不能將所有文件通通導(dǎo)入進(jìn)來。

但是換個思路，可以先通過不導(dǎo)入文件的方式獲取文件中中存在的類名，如果存在的類名中有想要獲取的類，再導(dǎo)入文件。通過這種方式避免導(dǎo)入所有文件，從而大大降低出錯的可能性。

我們知道，python解釋器在運行時候，對文件做了下列操作:

Parse source code into a parse tree (Parser/pgen.c)
Transform parse tree into an Abstract Syntax Tree (Python/ast.c)
Transform AST into a Control Flow Graph (Python/compile.c)
Emit bytecode based on the Control Flow Graph (Python/compile.c)

其中1，2步執(zhí)行之后，會生成一棵抽象語法樹，從而幫助解釋器去解析代碼結(jié)構(gòu)。

因此想要獲得文件中的類，可以通過ast包獲得生成的ast樹，再通過遍歷樹節(jié)點的方式獲得相應(yīng)的內(nèi)容。通過該方法，可以獲得定義的變量和類名的文本信息。

在項目代碼中，一般對于類的命名有特定的規(guī)范。因此需要正則表達(dá)式，可以過濾出文件中是否含有想要查找的類。

代碼如下：

for root, dirs, files in os.walk("."):
	for file in files:
	    file_name = os.path.join(root, file)

	    with open(file_name, "r") as source:
                    # 將文件轉(zhuǎn)化為ast樹
                tree = ast.parse(source.read())
                # 獲取樹中的類
                class_name_list = [node.name for node in ast.walk(tree) if isinstance(node, ast.ClassDef)]
                # 這里通過正則want_pattern去匹配類，從而過濾出想要的類
                want_class_name_list = [name for name in class_name_list if re.search(want_pattern, name) is not None]

最后得到的want_class_name_list就是通過正則匹配出來的類的類名。通過判斷want_class_name_list是否為空，就能知道文件中是否定義了自己想要的類。

如果定義了，再用方法1獲取文件中的類即可。