استفاده از ماژول inspect در پایتون: بررسی عمیق اشیاء و کد

ماژول inspect در پایتون ابزاری قدرتمند برای بررسی و تحلیل اشیاء زنده (live objects) است. این ماژول به شما امکان می‌دهد تا اطلاعاتی در مورد ساختار داخلی توابع، کلاس‌ها، ماژول‌ها، و حتی کد منبع آن‌ها به دست آورید. این قابلیت برای اشکال‌زدایی، مستندسازی خودکار، و ایجاد ابزارهای توسعه‌ای بسیار مفید است. این مقاله به بررسی عمیق این ماژول و کاربردهای آن می‌پردازد. این آموزش در سطح مفاهیم متوسط پایتون قرار می‌گیرد و فرض بر این است که خواننده با مفاهیم پایه پایتون مانند توابع، کلاس‌ها و ماژول‌ها آشنایی دارد.

چرا از inspect استفاده کنیم؟

در طول توسعه نرم‌افزار، اغلب نیاز به درک دقیق نحوه عملکرد کد داریم. inspect به ما کمک می‌کند تا:

• ساختار اشیاء را بررسی کنیم: متغیرها، متدها و ویژگی‌های یک شیء را شناسایی کنیم.
• امضای توابع را ببینیم: آرگومان‌های مورد نیاز یک تابع، مقادیر پیش‌فرض و نوع آرگومان‌ها را بررسی کنیم.
• کد منبع را استخراج کنیم: کد منبع یک تابع یا کلاس را به صورت رشته‌ای دریافت کنیم.
• وراثت را بررسی کنیم: کلاس‌های والد یک کلاس را شناسایی کنیم.
• ماژول‌ها و بسته‌ها را تحلیل کنیم: محتویات یک ماژول یا بسته را بررسی کنیم.

وارد کردن ماژول inspect

برای استفاده از این ماژول، ابتدا باید آن را وارد (import) کنید:

import inspect

بررسی اشیاء با inspect

inspect.getmembers() یکی از مهم‌ترین توابع این ماژول است. این تابع لیستی از اعضای یک شیء (متدها، ویژگی‌ها، و غیره) را به همراه نام و نوع آن‌ها برمی‌گرداند.

class MyClass:
    """یک کلاس نمونه برای نمایش inspect."""
    def __init__(self, x):
        self.x = x

    def my_method(self, y):
        """یک متد نمونه."""
        return self.x + y

obj = MyClass(10)

members = inspect.getmembers(obj)
for name, value in members:
    print(f"{name}: {value}")

خروجی این کد، لیستی از اعضای شیء obj را نشان می‌دهد، از جمله ویژگی x و متد my_method.

بررسی توابع با inspect

inspect.signature() اطلاعات دقیقی در مورد امضای یک تابع (آرگومان‌ها، مقادیر پیش‌فرض، و غیره) ارائه می‌دهد.

def my_function(a, b=1, *args, **kwargs):
    """یک تابع نمونه برای نمایش inspect."""
    pass

sig = inspect.signature(my_function)
print(sig)
for param in sig.parameters.values():
    print(f"  {param.name}: {param.default}")

خروجی این کد، امضای تابع my_function را نشان می‌دهد و اطلاعاتی در مورد هر پارامتر (نام، مقدار پیش‌فرض) ارائه می‌دهد.

استخراج کد منبع با inspect

inspect.getsource() کد منبع یک تابع، کلاس، یا ماژول را به صورت رشته‌ای برمی‌گرداند.

def my_function(a, b):
    """یک تابع نمونه برای نمایش inspect."""
    return a + b

source_code = inspect.getsource(my_function)
print(source_code)

این کد، کد منبع تابع my_function را چاپ می‌کند.

نکته: inspect.getsource() فقط در صورتی کار می‌کند که کد منبع در دسترس باشد (به عنوان مثال، اگر تابع در یک فایل پایتون تعریف شده باشد).

بررسی وراثت با inspect

inspect.getmro() ترتیب وراثت یک کلاس را برمی‌گرداند (Method Resolution Order). این ترتیب نشان می‌دهد که پایتون چگونه متدها را در کلاس‌ها و کلاس‌های والد آن جستجو می‌کند.

class A:
    pass

class B(A):
    pass

class C(B):
    pass

mro = inspect.getmro(C)
print(mro)

خروجی این کد، لیستی از کلاس‌ها را به ترتیب وراثت نشان می‌دهد: (, , , ).

بررسی ماژول‌ها و بسته‌ها با inspect

inspect.getmembers() را می‌توان برای بررسی محتویات یک ماژول یا بسته نیز استفاده کرد.

import math

members = inspect.getmembers(math)
for name, value in members:
    print(f"{name}: {type(value)}")

این کد، لیستی از اعضای ماژول math را به همراه نوع آن‌ها چاپ می‌کند.

توابع کمکی inspect

ماژول inspect توابع کمکی دیگری نیز دارد که می‌توانند در تحلیل کد مفید باشند:

• inspect.isfunction(): بررسی می‌کند که آیا یک شیء یک تابع است یا خیر.
• inspect.isclass(): بررسی می‌کند که آیا یک شیء یک کلاس است یا خیر.
• inspect.ismethod(): بررسی می‌کند که آیا یک شیء یک متد است یا خیر.
• inspect.ismodule(): بررسی می‌کند که آیا یک شیء یک ماژول است یا خیر.
• inspect.isbuiltin(): بررسی می‌کند که آیا یک شیء یک تابع داخلی پایتون است یا خیر.

کاربردهای پیشرفته inspect

inspect می‌تواند در موارد پیشرفته‌تری نیز استفاده شود، مانند:

• ایجاد مستندسازی خودکار: با استفاده از inspect می‌توان اطلاعات مربوط به توابع و کلاس‌ها را استخراج کرد و مستندات آن‌ها را به صورت خودکار تولید کرد.
• ساخت ابزارهای اشکال‌زدایی: inspect می‌تواند برای بررسی وضعیت اشیاء و متغیرها در طول اجرای برنامه استفاده شود.
• ایجاد فریم‌ورک‌های تست: inspect می‌تواند برای شناسایی توابع و کلاس‌هایی که باید تست شوند استفاده شود.
• تحلیل کد استاتیک: inspect می‌تواند برای بررسی ساختار کد و شناسایی مشکلات احتمالی استفاده شود.

نتیجه‌گیری

ماژول inspect ابزاری قدرتمند و انعطاف‌پذیر برای بررسی و تحلیل کد پایتون است. با استفاده از این ماژول، می‌توانید درک عمیق‌تری از نحوه عملکرد کد خود به دست آورید و ابزارهای توسعه‌ای قدرتمندی ایجاد کنید. این ماژول برای هر توسعه‌دهنده پایتون که به دنبال درک بهتر کد و اشکال‌زدایی موثرتر است، ضروری است. با تمرین و آزمایش با توابع مختلف inspect، می‌توانید به طور کامل از قابلیت‌های آن بهره‌مند شوید.