آشنایی با Type Annotation در پایتون

پایتون یک زبان برنامه‌نویسی چندمنظوره است که امکانات مختلفی را برای بهبود قابلیت خوانایی و قابلیت نگهداری کد ارائه می‌دهد. یکی از این امکانات، Type Annotation است که به برنامه‌نویسان اجازه می‌دهد نوع متغیرها و پارامترهای توابع را تعیین کنند. در این مقاله، به عمق دنیای Type Annotation در پایتون خواهیم پرداخت و از مزایا، پیاده‌سازی و روش‌های مناسب استفاده از آن صحبت خواهیم کرد.

اگر به زبان برنامه نویسی پایتون کد نویسی می کنید تا آخر این مقاله با ما همراه باشید.

انواع داده ها در پایتون

قبل از اینکه سراغ Type Hint برویم بیاید باهم انواع داده ها را در پاتون مرور کنیم.در زبان برنامه‌نویسی پایتون، تعداد زیادی نوع داده وجود دارد که هر کدام ویژگی‌ها و کاربردهای خاص خود را دارند. در ادامه به معرفی بعض از پر کاربرد ترین نوع‌های داده موجود در پایتون می‌پردازیم:

• اعداد صحیح (int): این نوع داده برای نمایش اعداد صحیح استفاده می‌شود. به عنوان مثال، اعدادی مانند 1، 20، 9- و غیره را می‌توان با استفاده از این نوع داده نمایش داد.

• اعداد اعشاری (float): این نوع داده برای نمایش اعداد اعشاری به کار می‌رود. به عنوان مثال، اعدادی مانند 3.14، 63.5 و غیره را می‌توان با استفاده از این نوع داده نمایش داد.

• رشته‌ها (str): رشته‌ها نوعی از داده هستند که برای نمایش متن و کاراکترها به کار می‌روند. به عنوان مثال، کلمات "Hello World" و 'Hello' را می‌توان با استفاده از این نوع داده نمایش داد.

• لیست‌ها (list): لیست‌ها مجموعه‌ای از عناصر هستند که به صورت مرتب و قابل تغییر(immutable) هستند. به عنوان مثال، می‌توانیم لیستی مانند [1، 2، 3] یا ['Ali'، 'Anophel'، 'Mohammad'] را تعریف کنیم.

• تاپل‌ها (tuple): تاپل‌ها مانند لیست‌ها هستند، با این تفاوت که غیرقابل تغییرند. به عنوان مثال، می‌توانیم تاپلی مانند (1، 2، 3) یا ('reza'، 'mohammad'، 'ali') را تعریف کنیم.

• دیکشنری‌ها (dictionary): نوع دادهٔ dictionary مجموعه‌ای از جفت‌های کلید و مقدار است. هر کلید یک مقدار متناظر دارد. دیکشنری‌ها به صورت مرتب نیستند و می‌توانید با استفاده از کلید به مقدار متناظر آن دسترسی پیدا کنید. به عنوان مثال: {'name': 'mohammad', 'age': 21}.

• مجموعه‌ها (set): نوع دادهٔ set مجموعه‌ای از عناصر منحصر به فرد است که ترتیب آنها مهم نیست. این نوع داده تکراری ندارد و می‌توانید عملیات‌های مجموعه‌ای را روی آن انجام دهید. به عنوان مثال: {1, 2, 3} و {'anophel', 'google', 'bing'}.

• بولی (bool): نوع دادهٔ bool تنها دو مقدار True و False را می‌پذیرد. برای نمایش وضعیت‌های منطقی و بررسی شرایط در برنامه‌نویسی استفاده می‌شود.

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

Type Annotation چیست؟

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

چرا باید از Type Annotation در پایتون استفاده کنیم؟

Type Annotation چندین مزیت را برای برنامه‌نویسان پایتون به ارمغان می‌آورد. در ادامه چند دلیلی که برای در نظر گرفتن اضافه کردن Type Hint به کد خود باید در نظر بگیرید را بررسی می‌کنیم:

• بهبود قابلیت خوانایی کد: Type Annotation به برنامه‌نویسان کمک می‌کند تا منظور استفاده از متغیرها و توابع را بهتر درک کنند. با خواندن کد همراه با Type Annotation، آشکار می‌شود که نوع داده‌های مورد انتظار چیست و این امر باعث کاهش ابهام و افزایش درک کد می‌شود.

• پشتیبانی بهتر از محیط‌های توسعه: بسیاری از محیط‌های توسعه یکپارچه مدرن (IDE) امکاناتی مانند تکمیل خودکار، ناوبری کد و بررسی خطاها بر اساس Type Annotation را ارائه می‌دهند. با استفاده از Type Hint، می‌توانید از این قابلیت‌های قدرتمند محیط‌های توسعه بهره‌برداری کنید که به شما کمک فراوانی در افزایش بهره‌وری خواهد کرد.

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

• بهبود همکاری: Type Annotation به عنوان یک نوع داکیومنت، اطلاعات مربوط به نوع داده‌های مورد انتظار را به سایر برنامه‌نویسانی که در همان کد کار می‌کنند ارائه می‌دهد. این امر باعث می‌شود همکاری آسان‌تر شود زیرا اعضای تیم می‌توانند نوع داده‌ها را درک کنند و خطاهای نوع مرتبط را به راحتی شناسایی کنند.

پیاده‌سازی Type Annotation

در پایتون،تایپ Annotation را می توان با استفاده از ماژول تایپ، معرفی شده در پایتون 3.5 پیاده سازی کرد. ماژول تایپ کلاس ها و توابع مختلفی را برای تعریف نکات نوع ارائه می دهد. بیایید برخی از موارد استفاده رایج از Type Annotation در پایتون را بررسی کنیم:

1. متغیر Annotation

برای استفاده از Type Annotation در پایتون، از نماد ":" پس از نام متغیر یا پارامتر استفاده می‌کنیم و سپس نوع مورد نظر را مشخص می‌کنیم. برای مثال:

name: str = "John"
age: int = 25
balance: float = 1000.50

در کد بالا، متغیر name با نوع رشته (str)، متغیر age با نوع عدد صحیح (int) و متغیر balance با نوع عدد اعشاری (float) ارائه شده است.

2.تابع Annotation

می‌توانیم نوع داده‌های بازگشتی توابع را نیز با استفاده از Type Annotation مشخص کنیم. به عنوان مثال:

from typing import List

def get_lengths(names: List[str]) -> List[int]:
    return [len(name) for name in names]

در این کد، عبارت <- برای تعیین نوع برگشتی تابع و نوع پارامترهای ورودی استفاده می‌شود. در این صورت ، <- بیانگر تعیین نوع است.

در اینجا، List[str] بعد از نام پارامتر names نشان می‌دهد که names یک لیست از رشته‌ها است. به این معنی است که تابع get_lengths یک لیست از رشته‌ها را به عنوان ورودی دریافت می‌کند.

و همچنین، List[int]<- بیانگر این است که تابع get_lengths یک لیست از اعداد صحیح را به عنوان خروجی برمی‌گرداند. به عبارت دیگر، برگشت تابع یک لیست از اعداد صحیح است که برابر با طول هر یک از رشته‌های ورودی است.

3.کلاس Annotation

Type Hint همچنین می تواند در تعاریف کلاس استفاده شود. در اینجا یک مثال است:

from typing import Optional

class Person:
    def __init__(self, name: str, age: int, address: Optional[str] = None):
        self.name = name
        self.age = age
        self.address = address

در کلاس Person، ویژگی name را به عنوان یک رشته (str)، ویژگی age را به عنوان یک عدد صحیح (int)، و ویژگی address را به عنوان یک رشته اختیاری (Optional[str]) Annotation می کنیم.

استفاده از Generic Types

در مواردی که نیاز به تعیین نوع داده‌های ژنریک دارید، می‌توانید از Generic Types استفاده کنید. برای این کار، از ماژول typing استفاده کنید و نوع ژنریک را به صورت پارامتری به Generic Type مربوطه بدهید. مثال:

from typing import List

names: List[str] = ["Alice", "Bob", "Charlie"]

در این مثال، متغیر names یک لیست از رشته‌ها (List[str]) است.

بهترین روش‌ها برای Type Annotation

استفاده از Type Annotation به کد پایتون شما فواید متعددی را به ارمغان می‌آورد، اما مهم است که برای تضمین توضیحات مؤثر و معنادار، از چندین روش بهتر استفاده کنید. در ادامه چند راهنمایی را که باید در نظر داشته باشید بررسی می‌کنیم:

• پیوستگی: پیوستگی در استفاده از راهنمایی‌های نوع بسیار مهم است. مطمئن شوید که تمامی متغیرها، پارامترها و نوع‌های بازگشتی مرتبط را به صورت پیوسته در سراسر کد پایتون خود توضیح دهید.

• شروع با ابعاد کوچک: اگر در حال کار روی یک پروژه بزرگ وجود دارید، ممکن است برای توضیح دادن همه چیز به طور یکجا، کار سختی باشد. ابتدا با توضیح بخش‌های جدید یا بخش‌های بحرانی کد شروع کنید و به تدریج توضیحات را به کدهای موجود اضافه کنید هنگامی که تغییراتی اعمال می‌کنید.

• استفاده از نام‌های واضح: نام‌گذاری مناسب برای متغیرها، توابع و انواع، برای افزایش وضوح بسیار حائز اهمیت است. وجود نام‌های خوب، به دیگران (و شما در آینده) کمک می‌کند تا کد را بهتر درک کنند.

• بهره‌برداری از نوع  Union: نوع های Union (مانند Union[int, float]) به شما امکان می‌دهد تا مشخص کنید یک متغیر یا پارامتر می‌تواند انواع متعددی را قبول کند. این مورد در صورتی که یک مقدار در شرایط مختلف ممکن است از انواع متفاوتی باشد، مفید است.

• استفاده از بررسی کننده‌های نوع: بررسی کننده‌های نوع مانند mypy قادرند کد شما را تجزیه و تحلیل کنند و بازخورد اضافی در مورد مشکلات مربوط به نوع ارائه دهند. یک بررسی کننده نوع را به جریان کار توسعه خود ادغام کنید تا اشکالات را شناسایی کرده و ایمنی نوع را اعمال کنید.

با رعایت این روش‌های بهتر، شما می‌توانید از Type Annotation در پروژه‌های پایتون خود بهره‌برداری کنید و کدی را تولید کنید که خوانایی بیشتری داشته باشد و توانایی نگهداری و توسعه آن برای شما و تیمتان راحت‌تر شود.

نتیجه

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