خلاصه دستور (SYNOPSIS)

توضیحات (DESCRIPTION)

ابزار nose آزمون‌ها را به‌طور خودکار از فایل‌های منبع پایتون، پوشه‌ها و بسته‌های موجود در پوشهٔ کاری خود (که به‌طور پیش‌فرض همان پوشهٔ کاری فعلی است) جمع‌آوری می‌کند. هر فایل منبع پایتون، پوشه یا بسته‌ای که با عبارت باقاعدهٔ testMatch (به‌طور پیش‌فرض: (?:^|[b_.-])[Tt]est)) مطابقت داشته باشد، به‌عنوان یک آزمون (یا منبعی برای جمع‌آوری آزمون‌ها) گردآوری خواهد شد. علاوه بر این، تمامی بسته‌های دیگر موجود در پوشهٔ کاری برای یافتن فایل‌های منبع پایتون یا پوشه‌هایی که با testMatch مطابقت دارند بررسی می‌شوند. فرآیند شناسایی بسته‌ها در سرتاسر درخت سلسله‌مراتبی به سمت پایین ادامه می‌یابد، بنابراین تمام موارد package.tests و package.sub.tests و package.sub.sub2.tests جمع‌آوری خواهند شد.

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

توجه به این نکته مهم است که رفتار پیش‌فرض nose، نادیده گرفتن آزمون‌های درون فایل‌های قابل‌اجرا است. برای گنجاندن آزمون‌ها از چنین فایل‌هایی، بیت قابل‌اجرای آن‌ها را حذف کنید یا از پرچم --exe استفاده نمایید (بخش 'گزینه‌ها' در ادامه را ببینید).

انتخاب آزمون‌ها (Selecting Tests)

برای تعیین این‌که کدام آزمون‌ها اجرا شوند، نام آزمون‌ها را در خط فرمان وارد کنید:

nosetests only_test_this.py

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

nosetests test.module
nosetests another.test:TestCase.test_method
nosetests a.test:TestCase
nosetests /path/to/test/file.py:test_function

شما همچنین می‌توانید با استفاده از سوییچ -w، پوشهٔ کاری را که nose در آن به دنبال آزمون‌ها می‌گردد تغییر دهید:

nosetests -w /path/to/tests

با این حال توجه داشته باشید که پشتیبانی از چندین آرگومان -w اکنون منسوخ شده است و در نگارش‌های آینده حذف خواهد شد. از نگارش nose 0.10 به بعد، می‌توانید همان رفتار را با مشخص کردن پوشه‌های مقصد بدون سوییچ -w به دست آورید:

nosetests /path/to/tests /another/path/to/tests

سفارشی‌سازی بیشتر در انتخاب و بارگذاری آزمون‌ها از طریق استفاده از پلاگین‌ها امکان‌پذیر است.

خروجی نتایج آزمون همسان با خروجی unittest است، به جز قابلیت‌های اضافی (کلاس‌های خطا، و ویژگی‌های ارائه‌شده توسط پلاگین‌ها مانند دریافت خروجی و درون‌نگری assert) که در گزینه‌های زیر شرح داده شده‌اند..SS "پیکربندی (Configuration)"

علاوه بر ارسال گزینه‌های خط فرمان، می‌توانید گزینه‌های پیکربندی را در فایل setup.cfg پروژه خود، یا یک فایل .noserc یا nose.cfg در دایرکتوری خانگی خود قرار دهید. در هر یک از این فایل‌های پیکربندی استاندارد به سبک ini، پیکربندی nosetests را در یک بخش [nosetests] قرار می‌دهید. گزینه‌ها همانند گزینه‌های خط فرمان هستند، با این تفاوت که پیشوند -- حذف می‌شود. برای گزینه‌هایی که سوییچ‌های ساده هستند، باید یک مقدار مشخص کنید:

[nosetests]
verbosity=3
with-doctest=1

تمام فایل‌های پیکربندی یافت‌شده بارگذاری شده و گزینه‌های آن‌ها با یکدیگر ادغام می‌شوند. می‌توانید بارگذاری استاندارد فایل‌های پیکربندی را با گزینه -c لغو کرده و تغییر دهید.

استفاده از افزونه‌ها (Using Plugins)

افزونه‌های متعددی برای nose از طریق easy_install و دیگر منابع در دسترس هستند. برای استفاده از یک افزونه، کافی است آن را نصب کنید. افزونه، گزینه‌های خط فرمان جدیدی به nosetests اضافه خواهد کرد. برای بررسی نصب بودن افزونه، دستور زیر را اجرا کنید:

nosetests --plugins

می‌توانید -v یا -vv را به آن دستور اضافه کنید تا اطلاعات بیشتری درباره هر افزونه نمایش داده شود.

اگر nose.main() یا nose.run() را از داخل یک اسکریپت اجرا می‌کنید، می‌توانید با ارسال فهرستی از افزونه‌ها از طریق آرگومان کلیدواژه‌ای plugins، افزونه‌های مورد استفاده را مشخص کنید.

افزونه‌های نسخه 0.9 (0.9 plugins)

نسخه 1.0 ابزار nose می‌تواند از «برخی» افزونه‌هایی که برای nose 0.9 نوشته شده‌اند استفاده کند. مدیر افزونه پیش‌فرض، یک لایه سازگاری (compatibility wrapper) به دور افزونه‌های 0.9 اضافه می‌کند که فراخوانی‌های تغییریافته api افزونه را تطبیق می‌دهد. با این حال، افزونه‌هایی که به ساختارهای داخلی nose دسترسی دارند به احتمال زیاد با خطا مواجه می‌شوند، به‌ویژه اگر تلاش کنند به کلاس‌های test case یا test suite دسترسی پیدا کنند. برای مثال، افزونه‌هایی که سعی می‌کنند مشخص کنند آزمون ارسال‌شده به startTest یک آزمون منفرد است یا یک suite، با شکست مواجه می‌شوند؛ بخشی به این دلیل که suiteها دیگر به startTest ارسال نمی‌شوند و بخشی دیگر به این دلیل که به احتمال قوی افزونه در تلاش است بفهمد آیا آزمون نمونه‌ای از کلاسی است که دیگر وجود ندارد یا خیر.

افزونه‌های نسخه‌های 0.10 و 0.11 (0.10 and 0.11 plugins)

تمامی افزونه‌های نوشته‌شده برای nose 0.10 و 0.11 باید با nose 1.0 به درستی کار کنند.

گزینه‌ها (Options)