PEP 8: دوست یا دشمن؟! 🐍

PEP 8: دوست یا دشمن؟! 🐍

اگر Python یک زبان برنامه‌نویسی شاعرانه باشد، PEP 8 همان دیوان شعر حافظ است!
فقط فرقش این است که به جای غزلیات عاشقانه، یک سری قوانین کدنویسی به شما تحویل می‌دهد. قوانین؟ بله، قوانین! 🎓

حالا چرا باید این قوانین را رعایت کنیم؟
چون اگر رعایت نکنید، کدتان تبدیل به یک کابوس برای همکارانتان (و آینده‌ی خودتان) خواهد شد! 😱

حالا بیایید کمی طنزآمیز به این قوانین نگاه کنیم و چند مثال بزنیم. آماده‌اید؟ 😊

1. تورفتگی (Indentation): یا ۴ فاصله، یا هیچی!

این یکی از سخت‌گیرانه‌ترین قوانین Python است. شما نمی‌توانید از تب (Tab) استفاده کنید، چون Python آن را «بزرگ‌ترین خیانت» می‌داند. فقط و فقط ۴ فاصله! 😤

❌ اشتباه:

if x > 5:
	print(&quotX is greater than 5&quot)  # اینجا از Tab استفاده شده است

✅ درست:

if x > 5:
    print(&quotX is greater than 5&quot)  # از ۴ فاصله استفاده کنید

Python می‌گوید: یا ۴ فاصله، یا خروج!

2. طول خطوط: لطفاً رمان ننویسید! 📜

PEP 8 می‌گوید: خط‌های کدتان باید حداکثر ۷۹ کاراکتر باشد.
چرا؟ چون Python به برنامه‌نویسان با مانیتورهای کوچک اهمیت می‌دهد! 😅

❌ اشتباه:

def very_long_function_name_with_too_many_parameters_and_annoying_length(arg1, arg2, arg3, arg4, arg5): pass

✅ درست:

def very_long_function_name(
    arg1, arg2, arg3, arg4, arg5
): 
    pass

3. نام‌گذاری: کد شما شخصیت دارد!

PEP 8 می‌گوید: کلاس‌ها باید CamelCase باشند، توابع و متغیرها باید snake_case باشند.
این یعنی اگر به جای calculateAverage بنویسید CalculateAverage، Python شما را قضاوت می‌کند! 😑

❌ اشتباه:

class my_class:
    def CalculateAverage(self):  # نام تابع غلط است
        pass

✅ درست:

class MyClass:
    def calculate_average(self):
        pass

Python می‌گوید: شخصیت کدت را جدی بگیر!

4. فضای اضافی ممنوع! 🚫

Python طرفدار مینیمالیسم است.
این یعنی هرجا فاصله‌ی اضافی گذاشتید، Python می‌گوید: «بس است دیگر!»

❌ اشتباه:

x  =  5   # فاصله‌های اضافی در دو طرف مساوی
y =  10   # فاصله اضافی بعد از مساوی

✅ درست:

x = 5
y = 10

5. مستندسازی: با کدت حرف بزن!

PEP 8 می‌گوید: همیشه به کدت توضیح بده که چه کاری انجام می‌دهد، وگرنه ممکن است سال‌ها بعد، خودت هم نفهمی!

❌ اشتباه:

def calc(a, b):
    return a + b  # این تابع بدون توضیح است

✅ درست:

def calculate_sum(a, b):
    &quot&quot&quotCalculate the sum of two numbers.&quot&quot&quot
    return a + b

6. وارد کردن ماژول‌ها: مستقیم و شیک!

وقتی می‌خواهید ماژول‌ها را وارد کنید، قوانین زیر را رعایت کنید:

• هر ماژول در یک خط.
• ترتیب وارد کردن: اول ماژول‌های استاندارد، بعد ماژول‌های خارجی، و در نهایت ماژول‌های خودتان.

❌ اشتباه:

import sys, os  # وارد کردن دو ماژول در یک خط
from mymodule import my_function, my_class, another_function

✅ درست:

import os
import sys

from mymodule import another_function, my_class, my_function

چند ابزار برای فرار از اشتباهات:

اگر با خودتان می‌گویید: «من نمی‌توانم این همه قانون را حفظ کنم!» خبر خوب این است که ابزارهایی وجود دارند که شما را از رعایت نکردن قوانین نجات می‌دهند:

🔧 Pylint: ایرادهایتان را با دقت گوشزد می‌کند.
🔧 Black: کدتان را به زیبایی و تمیزی یک لباس نو درمی‌آورد.
🔧 Flake8: مثل یک مربی سخت‌گیر، تمام خطاهایتان را نشان می‌دهد.

نتیجه‌گیری: PEP 8، راهنمایی برای آرامش در دنیای کدنویسی

PEP 8 ممکن است در نگاه اول شبیه به قوانین مدرسه‌ای سخت‌گیرانه باشد، ولی در حقیقت هدفش کمک به شماست:

• کدی خواناتر، زیباتر و حرفه‌ای‌تر.
• آرامش بیشتر برای همکارانتان (و خودتان!).

پس بیایید به این قوانین احترام بگذاریم، چون کدنویسی بدون PEP 8 مثل زندگی بدون اینترنت است: آشفته و بی‌نظم! 😄

💬 شما چطور؟ تجربه‌ای از رعایت یا رعایت نکردن PEP 8 دارید که بخواهید به اشتراک بگذارید؟

#Python #PEP8 #برنامه‌نویسی #طنز #کدنویسی