کشف توابع و راهنمای آن‌ها در پایتون تنها با دو دستور ساده

وقتی با یک ماژول یا کلاس جدید در پایتون روبه‌رو می‌شوید، اولین سؤالتان این است: «چه توابعی دارد؟ چطور باید از آن‌ها استفاده کنم؟» خوشبختانه پایتون دو ابزار ساده اما بسیار قدرتمند در اختیارتان می‌گذارد: یکی `dir()` که فهرست تمام متدها را به شما نشان می‌دهد، و دیگری `__doc__` که مستند توکار هر تابع را برایتان چاپ می‌کند. در این مقاله با چند خط کد ساده یاد می‌گیرید چگونه بدون جستجوی بی‌نتیجه، مستقیماً از خود پایتون راهنمای دقیق توابع را بیرون بکشید — و اگر باز هم کم آوردید، بدانید کجا دنبال پاسخ بگردید.

برای گرفتن methodهای یک کلاس، می‌توان از دستور dir به صورت زیر استفاده کرد:

print(dir(module_class))

یک تابع یا method از یک ماژول در پایتون به فرمت زیر نوشته می‌شود:

def module_method(inputs):
"""
    documentation
"""
    statements
    return outputs

 در بخش documentation اطلاعاتی درباره کارکرد تابع، ورودی‌ها، خروجی‌ها، نوع داده‌های آنها، مثال‌ها، توابع مشابه و … داده می‌شود. به طور کلی، اطلاعاتی در این بخش ارائه می‌شود که بتوان به درستی از آن تابع استفاده کرد. برای دسترسی به اطلاعات این بخش می‌توان از دستور زیر استفاده کرد:

print(module_method.__doc__)

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

به عنوان نمونه، در ادامه با کدنویسی زیر توابع کلاس figure و توضیحات تابع add_axes از این کلاس را می‌توان درخروجی نمایش داد.

fh1 = figure()
print(dir(fh1))
print(fh1.add_axes.__doc__)

به خاطر بسپارید: هیچ‌کس همه توابع پایتون را حفظ نیست. حرفه‌ای‌ها دقیقاً از همین `dir()` و `__doc__` استفاده می‌کنند تا در لحظه کدنویسی، راهنمای لازم را بگیرند. دفعه بعد که یک ماژول ناآشنا دیدید، اول `dir()` بزنید تا ببینید چه امکاناتی دارد، بعد با `.__doc__` مستندش را بخوانید. همین دو دستور ساده، شما را از یک مبتدی که مدام گوگل می‌کند به یک برنامه‌نویس مستقل و توانا تبدیل می‌کند. حالا بروید و همین الان در کد خودتان امتحانش کنید — نتیجه شگفت‌زده‌تان خواهد کرد.