آشنایی با پروفایل‌گیری¶

یک profile مجموعه‌ای از آماره‌ها است که توصیف می‌کند بخش‌های مختلف یک برنامه با چه تناوبی و برای چه مدت‌زمانی اجرا می‌شوند. این آماره‌ها به شناسایی گلوگاه‌های عملکردی کمک کرده و تلاش‌های بهینه‌سازی را هدایت می‌کنند. پایتون دو رویکرد اساساً متفاوت برای جمع‌آوری این اطلاعات ارائه می‌دهد: نمونه‌برداری آماری و ردیابی قطعی (deterministic).

بسته‌ی profiling ابزارهای پروفایل‌گیری توکار پایتون را تحت یک فضای نام واحد سازمان‌دهی می‌کند. این بسته شامل دو زیرماژول است که هر کدام متدولوژی پروفایل‌گیری متفاوتی را پیاده‌سازی می‌کنند:

profiling.sampling

یک پروفایل‌گیر آماری که به‌طور دوره‌ای از پشته‌ی فراخوانی نمونه‌برداری می‌کند. اسکریپت‌ها را مستقیماً اجرا کنید یا از طریق PID به فرایندهای در حال اجرا متصل شوید. این ماژول چندین فرمت خروجی (نمودارهای شعله‌ای، نقشه‌های حرارتی، Firefox Profiler)، تحلیل GIL، پیگیری GC و چندین حالت پروفایل‌گیری (زمان واقعی، CPU، GIL) را با عملاً هیچ سرباری فراهم می‌کند.

profiling.tracing

یک پروفایل‌گیر قطعی که هر فراخوانی تابع، بازگشت و رویداد استثنا را ردیابی می‌کند. این ماژول تعداد دقیق فراخوانی‌ها و اطلاعات زمانی دقیق را فراهم می‌کند و تمام فراخوانی‌ها، از جمله توابع بسیار سریع را ثبت می‌کند.

انتخاب یک پروفایل‌گیر¶

برای بیشتر تحلیل‌های عملکردی، از پروفایل‌گیر آماری (profiling.sampling) استفاده کنید. این پروفایل‌گیر حداقل سربار را دارد، هم برای توسعه و هم برای محیط تولید کار می‌کند و گزینه‌های بصری‌سازی غنی از جمله نمودارهای شعله‌ای، نقشه‌های حرارتی، تحلیل GIL و موارد دیگر را فراهم می‌کند.

هنگامی که به تعداد دقیق فراخوانی‌ها نیاز دارید و نمی‌خواهید هیچ فراخوانی تابعی از دست برود، از پروفایل‌گیر قطعی (profiling.tracing) استفاده کنید. از آنجا که این ماژول هر فراخوانی تابع و بازگشتی را ابزاربندی می‌کند، حتی توابع بسیار سریعی را که بین بازه‌های نمونه‌برداری کامل می‌شوند نیز ثبت خواهد کرد. نکته‌ی منفی، سربار بالاتر است.

جدول زیر تفاوت‌های کلیدی را خلاصه می‌کند:

python -m profiling.sampling run script.py

شروع سریع¶

این بخش حداقل گام‌های لازم برای شروع پروفایل‌گیری را ارائه می‌دهد. برای مستندات کامل، صفحات اختصاصی هر پروفایل‌گیر را ببینید.

python -m profiling.sampling run script.py
python -m profiling.sampling run -m mypackage.module

python -m profiling.sampling run --flamegraph script.py

python -m profiling.sampling attach 1234

python -m profiling.sampling run -i 50 -d 30 script.py

python -m profiling.tracing script.py

import profiling.tracing
profiling.tracing.run('my_function()')

درک خروجی پروفایل‌گیری¶

هر دو پروفایل‌گیر آمار در سطح تابع را جمع‌آوری می‌کنند، البته آن‌ها را در قالب‌های متفاوتی نمایش می‌دهند. پروفایل‌گیر نمونه‌برداری تجسم‌های متعددی (نمودارهای شعله‌ای، نقشه‌های حرارتی، پروفایل‌گیر فایرفاکس، جدول‌های pstats) را ارائه می‌دهد، در حالی که پروفایل‌گیر قطعی (deterministic) خروجی سازگار با pstats تولید می‌کند. صرف‌نظر از قالب، مفاهیم زیربنایی یکسان هستند.

مفاهیم کلیدی پروفایل‌گیری:

زمان مستقیم (که زمان خود یا self time یا tottime نیز نامیده می‌شود)

زمانی که صرف اجرای کد در خودِ تابع می‌شود، به استثنای زمانی که در توابع فراخوانی‌شده توسط آن صرف شده است. زمان مستقیم بالا نشان می‌دهد که تابع شامل عملیات پرهزینه‌ای است.

زمان تجمعی (که زمان کل یا total time یا cumtime نیز نامیده می‌شود)

زمانی که در تابع و تمام توابع فراخوانی‌شده توسط آن صرف شده است. این معیار هزینه کل فراخوانی یک تابع، از جمله کل زیردرخت فراخوانی آن را اندازه‌گیری می‌کند.

تعداد فراخوانی (که ncalls یا نمونه‌ها samples نیز نامیده می‌شود)

تعداد دفعاتی که تابع فراخوانی (قطعی) یا نمونه‌برداری (آماری) شده است. در پروفایل‌گیری قطعی، این مقدار دقیق است. در پروفایل‌گیری آماری، نشان‌دهنده‌ی تعداد دفعاتی است که تابع در یک نمونه‌ی پشته ظاهر شده است.

فراخوانی‌های اولیه

فراخوانی‌هایی که توسط بازگشت (recursion) القا نشده‌اند. هنگامی که یک تابع به صورت بازگشتی اجرا می‌شود، تعداد کل فراخوانی شامل فراخوانی‌های بازگشتی است، اما فراخوانی‌های اولیه فقط ورود اولیه را می‌شمارد. به صورت total/primitive نمایش داده می‌شود (برای مثال، 3/1 به معنای سه فراخوانی کل و یک فراخوانی اولیه است).

روابط فراخواننده/فراخوانی‌شونده (Caller/Callee)

اینکه چه توابعی یک تابع مشخص را فراخوانی کرده‌اند (فراخواننده‌ها) و آن تابع چه توابعی را فراخوانی کرده است (فراخوانی‌شوندگان). نمودارهای شعله‌ای این را به صورت مستطیل‌های تودرتو تجسم می‌کنند؛ pstats می‌تواند آن را از طریق متدهای print_callers() و print_callees() نمایش دهد.

سازگاری با نسخه‌های قبلی¶

برای سازگاری عقبگرد، ماژول cProfile به عنوان یک نام مستعار برای profiling.tracing در دسترس باقی می‌ماند. کدهای موجودی که از import cProfile استفاده می‌کنند، بدون هیچ تغییری در تمام نسخه‌های آینده‌ی پایتون به کار خود ادامه خواهند داد.

زیرماژول‌ها