سرفصل‌ها درس 25 از 250 · تابع‌ها
تابع‌ها

Docstringها و type hintها

دو تغییر کوچک یک تابعِ کارکننده را به یک تابع حرفه‌ای تبدیل می‌کنند: یک docstring و type hintها.

یک docstring رشته‌ای است که درست به‌عنوان نخستین خط بدنهٔ تابع قرار می‌گیرد. توضیح می‌دهد تابع چه می‌کند. ابزارها و help() آن را می‌خوانند، و Python آن را روی function.__doc__ نگه می‌دارد:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

سه نقل‌قول اجازه می‌دهند یک docstring چند خط را بپوشاند، که برای توضیح‌های طولانی‌تر کاربردی است.

Type hintها نشان می‌دهند پارامترها و مقدار برگشتی انتظار می‌رود از چه نوعی باشند. برای هر پارامتر name: type و برای مقدار برگشتی -> type می‌نویسید:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

Hintها هنگام اجرا چیزی را تحمیل نمی‌کنند. Python جلوی فرستادن یک رشته را نمی‌گیرد. آن‌ها مستنداتی‌اند که ویرایشگرها و بررسی‌کننده‌ها برای گرفتن زودهنگام اشتباه‌ها به کار می‌برند، و امضاهای شما را خودگویا می‌کنند. نوع‌های رایج hint شامل int، float، str و bool هستند.

از اینجا به بعد، تابع‌ها را با هر دو بنویسید: یک docstring روشن و type hintهای صادقانه.

نوبت شما

تابعی به نام multiply با type hintهای def multiply(a: int, b: int) -> int: و یک docstring (نخستین خط آن) که دقیقاً Return the product of a and b. باشد تعریف کنید. بدنه باید return a * b باشد.

مشکلی در این درس دیدید؟ گزارشش کنید · دربارهٔ این درس بپرسید

این تمرین به‌زودی باز می‌شود

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