دیباگ در پایتون با f-string خود-مستند؛ دیگر متغیر را دوبار تایپ نکنید


ترفند دیباگ در پایتون که ای کاش زودتر می‌شناختم: عبارات خود-مستند با = در f-string #

یک چیز کوچک که مقدار قابل توجهی از تایپ کردنم را نجات داده: f-string ها یک مشخص‌کننده = دارند که هم عبارت و هم مقدارش را چاپ می‌کند. یکی از آن قابلیت‌هایی است که تقریباً بیش از حد ساده به نظر می‌رسد که مفید باشد—تا وقتی که واقعاً شروع به استفاده از آن کنید.

روش قدیمی (چیزی که احتمالاً الان انجام می‌دهید) #

در حال دیباگ کردن چیزی هستید و باید ببینید چند متغیر واقعاً چه مقداری دارند. پس چیزی شبیه این می‌نویسید:

python
user_id = 123
items_in_cart = ['apple', 'book']
total = 45.99

print(f"user_id = {user_id}")
print(f"items_in_cart = {items_in_cart}")
print(f"total = {total}")

کار می‌کند. اما به افزونگی دقت کنید: دارید user_id را دو بار تایپ می‌کنید—یک بار به عنوان برچسب و یک بار به عنوان متغیر. برای سه متغیر، این شش بار تکرار user_id-مانند است. خسته‌کننده است، و اگر بعداً نام متغیر را تغییر دهید، ممکن است فراموش کنید برچسب را به‌روزرسانی کنید.

ترفند: فقط = را اضافه کنید #

از پایتون 3.8، می‌توانید برچسب را کاملاً حذف کنید و بگذارید f-string کار را انجام دهد:

python
user_id = 123
items_in_cart = ['apple', 'book']
total = 45.99

print(f"{user_id = }")
print(f"{items_in_cart = }")
print(f"{total = }")

خروجی:

user_id = 123
items_in_cart = ['apple', 'book']
total = 45.99

عبارت به صورت عینی چاپ می‌شود، و بعد از آن =، سپس مقدار ارزیابی‌شده‌اش. بدون تکرار. بدون برچسب‌های کهنه. نام متغیر همان برچسب است.

جایی که واقعاً مفید می‌شود #

برد واقعی با عبارات است، نه فقط متغیرهای ساده. می‌توانید هر عبارت معتبر پایتونی را قبل از = قرار دهید:

python
scores = [85, 92, 78, 95]
print(f"{sum(scores) = }")
print(f"{sum(scores) / len(scores) = }")
print(f"{max(scores) - min(scores) = }")

خروجی:

sum(scores) = 350
sum(scores) / len(scores) = 87.5
max(scores) - min(scores) = 17

حالا نه تنها متغیرها را بررسی می‌کنید—بلکه آنچه را که محاسبه می‌کردید مستند می‌کنید بدون اینکه مجبور باشید نتایج میانی را نام‌گذاری کنید. آن خط sum(scores) / len(scores) به هر کسی که خروجی را می‌خواند دقیقاً می‌گوید چه چیزی محاسبه شده، حتی اگر هرگز آن را به یک متغیر اختصاص نداده باشید.

همچنین می‌توانید آن را با format specifiers ترکیب کنید تا خروجی خوانا بماند:

python
ratio = 0.8765
print(f"{ratio = :.1%}")
ratio = 87.7%

چرا این از print("x:", x) بهتر است #

سه دلیل، به ترتیب میزان اهمیت:

  1. بدون drift. برچسب چاپ‌شده همیشه همان عبارت واقعی است. نمی‌توانید وضعیتی داشته باشید که برچسب بگوید count اما در واقع total را چاپ کنید.
  2. تایپ کمتر، کلیدهای کمتر. مخصوصاً وقتی ساعت ۲ بامداد دارید debug print ها را در یک تابع پخش می‌کنید.
  3. عبارات، نه فقط نام‌ها. می‌توانید نتیجه یک محاسبه را چاپ کنید و ببینید آن محاسبه چه بود، بدون اختراع نام‌های متغیر دورانداختنی.

یک هشدار کوچک #

از این در logging واقعی که به production می‌رود استفاده نکنید. فرمت خروجی کمی شل است (variable = value بدون delimiter ساختاریافته)، و واقعاً برای دیباگ تعاملی و توسعه طراحی شده. برای logging، هنوز الگوهای صریح logger.debug("user_id=%s items=%s", user_id, items) را می‌خواهید.

اما برای آن لحظاتی که به یک تابع خیره شده‌اید و فقط باید ببینید چه خبر است؟ f"{thing = }" سریع‌ترین مسیر از "نمی‌دانم این چیست" به "آه، None است" است.

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

این پست چطور بود؟

پست‌های مرتبط