استفاده از خط فرمان¶

می‌توان ماژول trace را از خط فرمان فراخوانی کرد. این کار می‌تواند به سادگی زیر باشد

python -m trace --count -C . somefile.py ...

مورد بالا somefile.py را اجرا خواهد کرد و فهرست‌های حاشیه‌نویسی‌شده‌ای از همه‌ی ماژول‌های پایتونی که در حین اجرا ایمپورت می‌شوند را در پوشه‌ی جاری تولید خواهد کرد.

--help¶

نمایش کاربرد و خروج.

--version¶

نمایش نسخه‌ی ماژول و خروج.

رابط برنامه‌ای¶

class trace.Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)¶

یک شیء برای ردگیری اجرای یک دستور یا عبارت ایجاد کنید. تمام پارامترها اختیاری هستند. count شمارش شماره‌های خط را فعال می‌کند. trace ردگیری اجرای سطرها را فعال می‌کند. countfuncs فهرست‌گیری از توابعی که در طول اجرا فراخوانی می‌شوند را فعال می‌کند. countcallers پیگیری روابط فراخوانی را فعال می‌کند. ignoremods فهرستی از ماژول‌ها یا بسته‌هایی است که باید نادیده گرفته شوند. ignoredirs فهرستی از پوشه‌هایی است که ماژول‌ها یا بسته‌های آن‌ها باید نادیده گرفته شوند. infile نام پرونده‌ای است که اطلاعات شمارش ذخیره‌شده از آن خوانده می‌شود. outfile نام پرونده‌ای است که اطلاعات شمارش به‌روز شده در آن نوشته می‌شود. timing نمایش یک مهر زمانی نسبت به زمان آغاز ردگیری را فعال می‌کند.

run(cmd)¶

دستور را اجرا کنید و آمار را از اجرا با پارامترهای ردگیری فعلی جمع‌آوری کنید. cmd باید یک رشته یا شیء کد باشد، مناسب برای ارسال به exec().

runctx(cmd, globals=None, locals=None)¶

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

runfunc(func, /, *args, **kwds)¶

func را با آرگومان‌های داده‌شده، تحت کنترل شیء Trace با پارامترهای ردگیری کنونی فراخوانی کنید.

results()¶

یک شیء CoverageResults را برمی‌گرداند که شامل نتایج تجمعی تمام فراخوانی‌های پیشین run، runctx و runfunc برای نمونه‌ی Trace داده‌شده است. نتایج ردگیری انباشته‌شده را بازنشانی نمی‌کند.

class trace.CoverageResults¶

ظرفی برای نتایج پوشش، که توسط Trace.results() ایجاد می‌شود. نباید به‌صورت مستقیم توسط کاربر ایجاد شود.

update(other)¶

داده‌ها را از یک شیء CoverageResults دیگر ادغام کنید.

write_results(show_missing=True, summary=False, coverdir=None, *, ignore_missing_files=False)¶

نتایج پوشش را می‌نویسد. برای نمایش سطرهایی که هیچ برخوردی نداشتند، show_missing را تنظیم کنید. برای گنجاندن خلاصه پوشش به تفکیک ماژول در خروجی، summary را تنظیم کنید. coverdir پوشه‌ای را مشخص می‌کند که پرونده‌های نتایج پوشش در آن خروجی داده می‌شوند. اگر None باشد، نتایج هر پرونده منبع در پوشه خودش قرار می‌گیرند.

اگر ignore_missing_files برابر True باشد، شمارش‌های پوشش برای پرونده‌هایی که دیگر وجود ندارند، به‌صورت بی‌صدا نادیده گرفته می‌شوند. در غیر این صورت، یک پرونده ناموجود باعث پرتاب FileNotFoundError می‌شود.

تغییر یافته در نسخه‌ی 3.13: پارامتر ignore_missing_files افزوده شد.

یک مثال ساده برای نشان دادن استفاده از رابط برنامه‌نویسی:

import sys
import trace

# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# run the new command using the given tracer
tracer.run('main()')

# make a report, placing output in the current directory
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")