جلسهی 46: کد تمیز Clean Code
کدی مینویسیم که دیگران (و خود آیندهمان) راحت بخوانند: نامگذاری درست، توابع کوتاه، type hint، docstring، ثابتها و رعایت PEP 8.
در این جلسه یاد میگیری
- نامهای گویا و قراردادهای
PEP 8را برای متغیر، تابع، کلاس و ثابت رعایت کنم. - تابع بلند را به توابع کوچک تکمسئولیتی بازسازی (
refactor) کنم و ازguard clauseاستفاده کنم. - با
typingامضای توابع را دقیق کنم:list[int]،dict[str, int]،OptionalوCallable. - برای توابع
docstringاستاندارد بنویسم و توابع خالص (pure function) را به توابع با اثر جانبی ترجیح دهم.
درس
PEP 8 راهنمای سبک رسمی پایتون است: snake_case برای متغیر و تابع، PascalCase برای کلاس، UPPER_CASE برای ثابت، چهار فاصله برای تورفتگی. نام باید هدف را بگوید: calculate_discount(price, percent) به جای f(a, b). اعداد جادویی (magic number) را به ثابت نامدار تبدیل کنید.
TAX_RATE = 0.09
def price_with_tax(price):
return price * (1 + TAX_RATE)type hint نوع پارامترها و مقدار برگشتی را مستند میکند. پایتون در زمان اجرا آنها را اجبار نمیکند، اما ابزارهایی مثل mypy و ویرایشگر خطاها را پیش از اجرا پیدا میکنند. از پایتون ۳.۹ میتوان مستقیم list[int] و dict[str, int] نوشت.
def total(prices: list[float]) -> float:
return sum(prices)
stock: dict[str, int] = {"pen": 12}Optional[int] یعنی «int یا None» (معادل int | None). Callable[[float], float] یعنی تابعی که یک float میگیرد و float برمیگرداند. این نوعها را از ماژول typing وارد میکنید.
from typing import Callable, Optional
def find_id(users: dict[str, int], name: str) -> Optional[int]:
return users.get(name)
def apply(rule: Callable[[float], float], x: float) -> float:
return rule(x)docstring اولین رشتهی داخل تابع است و با help() و __doc__ در دسترس است. خط اول خلاصهای در یک جمله است؛ در ادامه پارامترها و مقدار برگشتی توضیح داده میشوند.
def area(width: float, height: float) -> float:
"""Return the area of a rectangle.
Both sides must be non-negative.
"""
return width * heightguard clause حالتهای نامعتبر را در ابتدای تابع با return یا raise زود رد میکند تا ifهای تودرتو از بین بروند. تابع خالص (pure function) فقط به ورودیاش وابسته است و چیزی بیرون از خودش را تغییر نمیدهد؛ تست و استفادهی مجدد آن ساده است.
def shipping_cost(weight: float, express: bool) -> float:
if weight <= 0:
raise ValueError("weight must be positive")
if express:
return 50 + weight * 10
return 20 + weight * 5مثالهای این جلسه
- مثال تابع در پایتون: def price_with_tax(price):
- مثال تابع در پایتون: def total(prices: list[float]) -> float:
- مثال تابع در پایتون: def find_id(users: dict[str, int], name: st…
- مثال تابع در پایتون: def area(width: float, height: float) -> fl…
- مثال تابع در پایتون: def shipping_cost(weight: float, express: b…
چالشها
- Typed Total (آسان)
- Write a Docstring (آسان)
- Rename for Clarity (آسان)
- Optional Return (متوسط)
- Pluggable Pricing Rule (متوسط)
- Guard Clauses (متوسط)
- Constants over Magic Numbers (متوسط)
- Refactor a Long Function (سخت)
- Type Alias for a Matrix (سخت)
- Pure Instead of Global (سخت)
- Inspect Annotations (متوسط)
- Validator Factory (سخت)
بیشتر بخوان
← جلسهی 45: ماژولها و سازماندهی کد جلسهی 47: کار با داده و متن در مقیاس واقعی →