جلسهی 44: اشکالزدایی و لاگگیری Debugging and Logging
یاد میگیریم traceback را درست بخوانیم، به جای print پراکنده از ماژول logging استفاده کنیم و با برنامهنویسی تدافعی خطا را زود و واضح گزارش دهیم.
در این جلسه یاد میگیری
- یک
tracebackرا از پایین به بالا بخوانم و نوع، پیام و محل خطا را تشخیص دهم. loggingرا با سطح (level)، قالب (format) وhandlerمناسب پیکربندی کنم.- با
loggerنامدار،FilterوHandlerسفارشی لاگها را کنترل کنم. - ورودیها را تدافعی (
defensive programming) بررسی کنم و خطای دقیق پرتاب کنم.
درس
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مثالهای این جلسه
- مثال پایتون در پایتون: Traceback (most recent call last):
- مثال متغیر در پایتون: format="%(levelname)s:%(message)s")
- مثال عملگرها در پایتون: logger.info("charged %s for %d", "nima", 12…
- مثال کلاس و شیء در پایتون: class NoSecrets(logging.Filter):
- مثال تابع در پایتون: def set_discount(percent):
چالشها
- Name the Exception (آسان)
- Configure basicConfig (آسان)
- Choose the Level (آسان)
- Named Logger and Handler (متوسط)
- Log the Failure (متوسط)
- Defensive Validation (متوسط)
- Fix the Off-by-one (متوسط)
- Walk the Traceback (سخت)
- Keep Secrets Out of Logs (سخت)
- Collecting Handler (سخت)
- Raise, Don't Assert (متوسط)
- Exception Chaining (سخت)
بیشتر بخوان
- پایتون چیست؟ تاریخچه، کاربردها و راه شروع
- متغیر در پایتون: تعریف، نامگذاری و تغییر مقدار با مثال
- عملگرها در پایتون: حسابی، مقایسهای، منطقی و اولویت آنها
- برنامهنویسی شیگرا در پایتون (کلاس و شیء) با مثال ساده
← جلسهی 43: تستنویسی جلسهی 45: ماژولها و سازماندهی کد →