快捷導航

Python??inspect?模塊的簡單使用及常用方法

更新時間：2024年03月28日 08:57:10 作者：小菠蘿測試筆記

Python的inspect模塊是一個強大的內(nèi)省工具，允許開發(fā)者檢查（inspect）活動對象和源代碼，這篇文章主要介紹了Python?inspect?模塊的簡單使用及常用方法,需要的朋友可以參考下

Python中的inspect模塊解析

Python的inspect模塊是一個強大的內(nèi)省工具，允許開發(fā)者檢查（inspect）活動對象和源代碼。它提供了一系列函數(shù)，用于獲取信息關(guān)于正在運行的程序和調(diào)用堆棧，非常適合進行調(diào)試和動態(tài)分析。本文將通過介紹inspect模塊的關(guān)鍵功能，并結(jié)合實際案例代碼，來探索其在日常開發(fā)中的應(yīng)用。

常用方法

1. 獲取當前執(zhí)行的函數(shù)或方法名、文件路徑【并不是調(diào)用方】

在日志記錄或調(diào)試時，知道當前執(zhí)行的函數(shù)名是非常有用的

import inspect
def who_am_i():
    # 輸出當前文件絕對路徑
    print(inspect.currentframe().f_code.co_filename)
    return inspect.currentframe().f_code.co_name
print(who_am_i())  # 輸出: who_am_i

個人認為比較有用的就是 co_filename、co_name

2. 獲取調(diào)用者信息

獲取當前函數(shù)或方法的調(diào)用者信息

import inspect
def caller_info():
    frame = inspect.currentframe().f_back
    print(f調(diào)用者 {frame.f_code.co_filename} 調(diào)用行號 d{frame.f_lineno}")
def test():
    caller_info()  # 調(diào)用以獲取調(diào)用者信息
test()

這個例子顯示了如何獲取調(diào)用當前函數(shù)的代碼位置，非常有助于調(diào)試復雜的調(diào)用鏈

3. 查看函數(shù)參數(shù)

inspect模塊可以用來檢查函數(shù)或方法的參數(shù)，這對于動態(tài)分析和生成文檔非常有用

import inspect
def sample_function(name, age=25):
    pass
sig = inspect.signature(sample_function)
print(sig)  # 輸出: (name, age=25)

4. 獲取源代碼

inspect還可以用來獲取函數(shù)、類或模塊的源代碼

import inspect
def my_function():
    """A simple function."""
    pass
print(inspect.getsource(my_function))

5. 檢查類和實例

inspect模塊提供了多種方式來檢查類和實例，比如獲取類的所有方法、屬性等

class MyClass:
    def method_one(self):
        pass
    def method_two(self):
        pass
# 獲取類的所有成員方法
methods = inspect.getmembers(MyClass, predicate=inspect.isfunction)
print(methods)  # 輸出 MyClass 中定義的方法

實際案例：自動化場景下的應(yīng)用

一個常見的使用場景是動態(tài)地調(diào)用函數(shù)或方法，并基于它們的簽名自動生成文檔。

def test():
    # 獲取調(diào)用方
    frame = inspect.currentframe().f_back
    # 獲取調(diào)用方文件絕對路徑
    caller_file = inspect.getfile(frame)
    # 這種方式也可以
    caller_file = frame.f_code.co_filename
    ...
    params = [
        caller_file,
        "--env-data",
        env_data.json(),
        f"--count={count}",
        "-m",
        mark,
    ]

一個基于 Pytest 自動化測試項目