بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 44: اشکال‌زدایی و لاگ‌گیری Debugging and Logging

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

در این جلسه یاد می‌گیری

درس

traceback را از پایین بخوانید: خط آخر نوع خطا و پیام را می‌گوید (مثلاً KeyError: 'email') و قاب‌های بالایش مسیر فراخوانی تا محل خطا هستند. پایین‌ترین قابی که در کد خودتان است معمولاً محل باگ است.

Traceback (most recent call last):
  File "app.py", line 9, in <module>
    load(user)
  File "app.py", line 4, in load
    return user["email"]
KeyError: 'email'

logging نسبت به print سطح دارد (DEBUG < INFO < WARNING < ERROR < CRITICAL)، می‌توان آن را بدون تغییر کد خاموش یا روشن کرد و زمان، ماژول و سطح را خودکار ثبت می‌کند. basicConfig سریع‌ترین راه پیکربندی است؛ پیش‌فرض آن فقط WARNING به بالا را نشان می‌دهد.

import logging
import sys

logging.basicConfig(level=logging.INFO, stream=sys.stdout,
                    format="%(levelname)s:%(message)s")
logging.debug("hidden")
logging.info("service started")

در پروژه‌ی واقعی هر ماژول logger خودش را با logging.getLogger(__name__) می‌گیرد. Handler مقصد را تعیین می‌کند (کنسول، فایل) و Formatter قالب را. آرگومان‌ها را به شکل %s بدهید نه f-string، تا اگر پیام نمایش داده نشود قالب‌بندی هم انجام نشود.

logger = logging.getLogger("payments")
handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(logging.Formatter("%(name)s | %(levelname)s | %(message)s"))
logger.addHandler(handler)
logger.setLevel(logging.INFO)
logger.info("charged %s for %d", "nima", 120)

Filter رکوردها را قبل از خروج بررسی می‌کند و با برگرداندن False حذفشان می‌کند؛ مثلاً برای جلوگیری از لو رفتن اطلاعات حساس. ماژول traceback هم اجازه می‌دهد قاب‌های یک خطا را برنامه‌ای بررسی کنید.

class NoSecrets(logging.Filter):
    def filter(self, record):
        return "password" not in record.getMessage()

برنامه‌نویسی تدافعی یعنی ورودی را در مرز سیستم بررسی کنید و زود و با پیام دقیق شکست بخورید (fail fast): نوع اشتباه → TypeError، مقدار خارج از بازه → ValueError. هرگز except: خالی ننویسید؛ خطا را پنهان می‌کند و اشکال‌زدایی را کابوس می‌کند.

def set_discount(percent):
    if not isinstance(percent, (int, float)):
        raise TypeError("percent must be a number")
    if not 0 <= percent <= 100:
        raise ValueError("percent must be between 0 and 100")
    return percent / 100

مثال‌های این جلسه

چالش‌ها

  1. Name the Exception (آسان)
  2. Configure basicConfig (آسان)
  3. Choose the Level (آسان)
  4. Named Logger and Handler (متوسط)
  5. Log the Failure (متوسط)
  6. Defensive Validation (متوسط)
  7. Fix the Off-by-one (متوسط)
  8. Walk the Traceback (سخت)
  9. Keep Secrets Out of Logs (سخت)
  10. Collecting Handler (سخت)
  11. Raise, Don't Assert (متوسط)
  12. Exception Chaining (سخت)

بیشتر بخوان

← جلسه‌ی 43: تست‌نویسی جلسه‌ی 45: ماژول‌ها و سازمان‌دهی کد →