مقدمه

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

راهنمای نگارش کدهای پایتون

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

وقتی کسی بخواهد تغییری در زبان پایتون ایجاد کند، یک Python Enhancement Proposal یا PEP می‌نویسد. PEP 8 یکی از این پروپوزال‌هاست که به نحوه‌ی استایل‌دهی به کدهای پایتون مربوط است و در واقع، یک راهنمای نگارش برای برنامه‌نویسان پایتون است. این راهنما با در نظر گرفتن یک موضوع خاص ایجاد شده و آن موضوع این است که: کدها فقط یک بار نوشته می‌شوند اما بارها و بارها خوانده می‌شوند. وقتی کدهایتان را دیباگ می‌کنید یا وقتی قصد دارید قابلیتی به برنامه اضافه کنید یا وقتی کدهایتان را به هر دلیلی با دیگران به اشتراک می‌گذارید، در همه‌ی این موارد، باید کدها خوانده شوند. پس، بین کدی که نوشتنش ساده‌تر است و کدی که خواندنش ساده‌تر است، قطعاً باید اولویت را به دومی بدهید.

در ادامه، به چند استایل قراردادی که در PEP 8 توصیه شده‌اند، اشاره می‌کنیم.

تورفتگی

در PEP 8 توصیه شده که برای هر سطح از تورفتگی از ۴ کاراکتر فاصله استفاده کنیم. استفاده از Tab برای تورفتگی پیشنهاد نمی‌شود، چون در اکثر محیط‌ها ترکیب Space با Tab می‌تواند مشکلاتی ایجاد کند.

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

طول خطوط

مطابق توصیه‌های PEP 8 طول خطوط کد پایتون باید حداکثر 79 کاراکتر باشد. در گذشته کامپیوترها قادر بودند تا ۷۹ کاراکتر را در ترمینال نمایش دهند و در واقع، به این دلیل تاریخی است که 79 کاراکتر برای طول خط تعیین شده اما به هر حال، این کار باعث می‌شود که خطوط کد در اکثر ویرایشگرها و نمایشگرها به خوبی نمایش داده شود و به اسکرول افقی نیاز پیدا نشود. برای کامنت‌ها هم باید طول خطوط حداکثر ۷۲ کاراکتر باشد.

در برخی موارد، مثل آدرس‌های URL یا رشته‌های طولانی که شکستن آن‌ها باعث پیچیدگی یا ناخوانایی کد می‌شود، می‌توان خطوط طولانی‌تر از ۷۹ کاراکتر داشت. در چنین مواردی باید توجه داشت که خوانایی و نظم کد به خطر نیفتد.

خطوط خالی

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

سایر راهماهای استایل

PEP 8 خیلی مفصل‌تر از این حرف‌هاست و قراردادها و توصیه‌های بسیار زیادی دارد. اما فعلاً به همین چند توصیه‌ی ساده اکتفا می‌کنیم و در درس‌ها و فصل‌های آینده هر جا لازم شود، موارد دیگری از PEP 8 بیان می‌کنیم.