مقدمه‌ای بر استاندارد PEP 8
در برنامه‌نویسی پایتون، داشتن یک استاندارد مشخص برای نوشتن کد، خوانایی و نگهداری آن را بسیار آسان‌تر می‌کند. PEP 8 استاندارد رسمی و پذیرفته‌شده‌ای است که توصیه می‌کند چگونه کد پایتون باید نوشته شود تا برای همه برنامه‌نویسان قابل فهم و یکدست باشد.
PEP 8 چیست؟
PEP مخفف Python Enhancement Proposal به معنای پیشنهاد بهبود پایتون است. PEP 8 یکی از این پیشنهادات است که توسط تیم توسعه پایتون تعریف شده و شامل راهنمای جامع و استانداردی برای قالب‌بندی و نگارش کد پایتون است. هدف اصلی آن افزایش خوانایی کد و کاهش تفاوت‌های سبک کدنویسی بین برنامه‌نویسان است.
قوانین کلی نگارش کد بر اساس PEP 8
- تورفتگی (Indentation): استفاده از ۴ فاصله (space) برای هر سطح تورفتگی. از تب (Tab) استفاده نکنید.
- طول خطوط: حداکثر طول خط باید ۷۹ کاراکتر باشد تا خوانایی حفظ شود و در نمایشگرهای مختلف مشکل ایجاد نکند.
- فاصله‌گذاری: بین عناصر کد به شکل مناسب فاصله بگذارید؛ مثلا بعد از کاما فاصله باشد اما قبل از آن خیر.
- نامگذاری:
- متغیرها و توابع با حروف کوچک و کلمات جداشده با آندرلاین (snake_case) باشند.
- کلاس‌ها با حروف بزرگ شروع و هر کلمه با حرف بزرگ (CamelCase) نوشته شود.
- ثوابت با حروف بزرگ و آندرلاین (UPPER_CASE) نامگذاری شوند. - خطوط خالی: بین توابع و کلاس‌ها دو خط خالی قرار دهید و بین خطوط داخلی توابع یک خط خالی کافی است.
- کامنت‌ها: کامنت‌ها باید واضح و مختصر باشند و در جای مناسب نوشته شوند. کامنت بلاک (توضیح چند خطی) با سه کوتیشن و کامنت تک‌خطی با # نوشته می‌شوند.
- بررسی فاصله‌ها در اطراف اپراتورها: به عنوان مثال
x = y + zبه جایx=y+z - پرانتز و کروشه: برای تابع و آرایه‌ها، فاصله اضافی داخل پرانتز یا کروشه نگذارید؛ مثلا
func(a, b)و نهfunc( a, b ). - ایمپورت‌ها: هر ایمپورت در یک خط جداگانه باشد و ایمپورت‌ها به ترتیب استاندارد (کتابخانه‌های استاندارد، کتابخانه‌های خارجی، کتابخانه‌های داخلی) مرتب شوند.
- عدم استفاده از خطوط طولانی برای کدهای پیچیده: در صورت نیاز به ادامه خط از \ یا پرانتز استفاده کنید.
رعایت PEP 8 باعث می‌شود کد شما خواناتر، قابل نگهداری‌تر و حرفه‌ای‌تر به نظر برسد و همچنین همکاری بین تیم‌های برنامه‌نویسی بسیار راحت‌تر شود.