قراردادهای نامگذاری پایتون برای متغیرها، توابع و کلاس ها

معرفی

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

در این مقاله، قراردادهای نامگذاری مختلف مورد استفاده در پایتون را بررسی خواهیم کرد و دلیل اهمیت آنها را درک خواهیم کرد.

چرا نامگذاری کنوانسیون مهم است

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

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

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

قراردادهای نامگذاری متغیرها

در پایتون، نام متغیرها چیزی بیش از یک مکان نگهدار برای مقادیر هستند – آنها بخش مهمی از خوانایی کد شما هستند. قرارداد نامگذاری متغیر پایتون بر اساس اصل “شمارش خوانایی” است، یکی از فلسفه های راهنمای پایتون.

نام متغیر در پایتون باید توصیفی و مختصر باشد و برای هر کسی که کد شما را می‌خواند به راحتی بفهمد که متغیر برای چه منظوری استفاده می‌شود. باید با یک حرف کوچک شروع شود و می تواند شامل حروف، اعداد و زیرخط باشد. با این حال، نمی تواند با یک عدد شروع شود.

در اینجا چند نمونه آورده شده است:

name = "John Doe"
age = 30
is_student = False

در پایتون، ما معمولا استفاده می کنیم snake_case برای نام متغیرها، که در آن هر کلمه با یک خط زیر جدا می شود. این نیز به عنوان شناخته شده است lower_case_with_underscores.

student_name = "John Doe"
student_age = 30
is_student = False

قراردادهای نامگذاری توابع

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

در پایتون، ما معمولا استفاده می کنیم snake_case برای نام توابع در اینجا یک مثال است:

def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  

بعلاوه snake_case، پایتون نیز استفاده می کند PascalCase برای نامگذاری کلاس ها و گهگاهی camelCase، اما در بخش دیگری بر روی آنها تمرکز خواهیم کرد. در حال حاضر، به یاد داشته باشید که ثبات در قرارداد نامگذاری شما برای نوشتن کدهای پایتونیک تمیز و تمیز مهم است.

قراردادهای نامگذاری کلاس

برای نام‌گذاری کلاس‌ها در پایتون، مجموعه‌ای از قراردادها در مقایسه با نام‌گذاری متغیرها یا توابع اعمال می‌شود. در پایتون معمولاً از نام کلاس ها استفاده می شود PascalCase، همچنین به عنوان شناخته شده است UpperCamelCase. این به این معنی است که نام با یک حرف بزرگ شروع می شود و هیچ خط زیری بین کلمات وجود ندارد. هر کلمه در نام نیز باید با یک حرف بزرگ شروع شود.

در اینجا یک مثال برای نشان دادن قرارداد نامگذاری برای کلاس ها آورده شده است:

class ShoppingCart:
    def __init__(self, items=()):
        self.items = items
    
    def add_item(self, item):
        self.items.append(item)

my_cart = ShoppingCart()
my_cart.add_item("apple")

در این مثال، ShoppingCart کلاسی است که به آن پایبند است PascalCase کنوانسیون نامگذاری

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

class HTTPResponse:
    def __init__(self, status_code, content):
        self.status_code = status_code
        self.content = content

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

نتیجه

در این مقاله، اهمیت نامگذاری قراردادها در پایتون و چگونگی کمک آنها به خوانایی و نگهداری کد را بررسی کرده ایم. ما انواع مختلف قراردادهای نامگذاری را برای متغیرها، توابع و کلاس‌ها نشان داده‌ایم PascalCasing و snake_casing.

پایتون این قراردادها را اجرا نمی‌کند، اما رعایت آن‌ها عمل خوبی در نظر گرفته می‌شود و واقعاً می‌تواند خوانایی کد شما را بهبود بخشد، مخصوصاً هنگام کار در تیم.