8 قوانین ضروری نامگذاری پایتون برای کد تمیز

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

1.اصل مهم: وضوح و خوانایی

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

# اشتباه
tp = 15000  # نام مبهم، مشخص نیست منظور چیست

# درست
total_price = 15000  # نام واضح و توصیفی

2.سبک‌های نامگذاری توصیفی: سازگاری کلید اصلی است

پایتون سبک‌های نامگذاری مختلفی مانندحروف کوچک، حروف کوچک با آندرلاین (snake_case)، حروف بزرگ ترکیبی (CamelCase)، و حروف کاملاً بزرگ (ALL_CAPS). برای متغیرها و توابع از snake_case و برای کلاس‌ها از CamelCase را ارائه می‌دهد. انتخاب سبک نامگذاری که با قراردادهای پروژه شما همسو باشد و به طور مداوم به آن پایبند باشید، بسیار مهم است.

# اشتباه
def SendEmail():  # استفاده از CamelCase برای تابع، ناهماهنگ با PEP 8
    pass
# درست
def send_email():  # استفاده از snake_case برای تابع
    pass

# اشتباه
class email_sender:  # استفاده از حروف کوچک برای کلاس، ناهماهنگ با PEP 8
    pass
# درست
class EmailSender:  # استفاده از CamelCase برای کلاس
    pass

3.قراردادهای نامگذاری : PEP 8 به عنوان راهنمای شما

برای حفظ یکپارچگی بین توسعه‌دهندگان پایتون، توصیه می‌شود از راهنمای سبک‌نویسی Python Enhancement Proposal (PEP) پیروی کنی. این راهنما استانداردهای نام‌گذاری، ساختار کد و بهترین شیوه‌ها را ارائه می‌دهد.

# اشتباه
def GetUserProfile(UserId):  # استفاده از CamelCase برای تابع و پارامتر
    pass

# درست
def get_user_profile(user_id):  # استفاده از snake_case طبق PEP 8
    pass

📎 لینک راهنما: PEP 8 — Style Guide for Python Code

4.نام‌های ممنوعه: از ابهام دوری کنید

برای جلوگیری از تداخل و سردرگمی، باید از نام‌های خاصی در پایتون اجتناب شود. به عنوان مثال، از استفاده از توابع داخلی یا نام ماژول‌ها به عنوان نام متغیر خودداری کنید. علاوه بر این، به طور کلی باید از نام‌های متغیر تک کاراکتری اجتناب شود، به جز شمارنده‌های ساده یا تکرارکننده‌ها. نام‌های معنادار و توصیفی، درک کد را افزایش داده و ابهام را کاهش می‌دهند.

# اشتباه
list = [1, 2, 3]  # استفاده از نام تابع داخلی پایتون
# درست
user_list = [1, 2, 3]  # نام توصیفی و بدون تداخل با توابع داخلی

# اشتباه
x = 5  # نام تک‌حرفی و مبهم
# درست
retry_count = 5  # نام واضح و قابل فهم

# اشتباه
ç = 42  # استفاده از کاراکتر غیر ASCII ممکنه باعث ناسازگاری در محیط‌های مختلف بشه

# درست
count = 42  # استفاده از کاراکترهای ASCII باعث سازگاری و قابل حمل بودن کد می‌شه

# اشتباه
my_package_name_with_underscores = ...  # استفاده از زیرخط در نام بسته، ناسازگار با استانداردهای پایتون

# درست
mypackage = ...  # نام کوتاه، واضح و بدون زیرخط، سازگار با کتابخانه‌های استاندارد

# اشتباه
class user:  # نام عمومی و با حروف کوچک

# درست
class RegisteredUser:  # نام توصیفی با CamelCase
    pass

# اشتباه
pi = 3.14  # متغیر معمولی، نه به عنوان ثابت

# درست
PI = 3.14  # ثابت با حروف بزرگ طبق قرارداد