I nazariy qism

Markdown fayllar uchun
Hujjat faylini tayyorlash uchun avval quyidagi buyruqni (omborning ildizidan) ishga tushirishingiz kerak bo'ladi (doc-test uchun biz hujjat manba fayllariga kiritilmagan qo'shimcha qatorlarni qo'shish kerak):
python utils/prepare_for_doc_test.py src docs
Keyin ushbu buyruq bilan berilgan faylni mahalliy sifatida sinab ko'rishingiz mumkin (bu erda tezkor turni sinab ko'ring):
pytest --doctest-modules docs/source/quicktour.mdx -sv --doctest-continue-on-failure --doctest-glob="*.mdx"
Tugatganingizdan so'ng, bajarishdan oldin birinchi buyruq tomonidan kiritilgan o'zgarishlarni bekor qilish uchun quyidagi buyruqni (hali ham omborning ildizidan) ishga tushirishingiz mumkin:python utils/prepare_for_doc_test.py src docs --remove_new_line
Doktestlar yozish

Doktestlarni disk raskadrovka qilish va ularni o'tishga yordam beradigan bir nechta maslahatlar:

• Kodning chiqishi kutilgan natijaga to'liq mos kelishi kerak, shuning uchun sizda bir xil chiqishlarga ega ekanligingizga ishonch hosil qiling. Xususan, doctest bitta tirnoq va qo'sh tirnoq o'rtasidagi farqni yoki etishmayotgan qavsni ko'radi. Ushbu qoidadan faqat istisnolar:

o bo'sh joy: bitta bo'sh joy (bo'sh joy, jadval, yangi qator) istalgan miqdordagi bo'shliqqa teng, shuning uchun chiqishingizni yanada o'qilishi uchun bo'sh joy mavjud bo'lgan yangi qatorlarni qo'shishingiz mumkin.
o raqamli qiymatlar: kutilgan natijalarga hech qachon 4 yoki 5 dan ortiq raqam qo'ymasligingiz kerak, chunki turli xil sozlamalar yoki kutubxona versiyalari sizga biroz boshqacha natijalar berishi mumkin. doctest siz yozgan aniqlikdan pastroq bo'lgan har qanday farqni e'tiborsiz qoldirish uchun tuzilgan (shuning uchun 4 ta raqam yozsangiz 1e-4).
• Bajarilishi juda uzoq bo'lgan kod blokini qoldirmang. Agar buni tez bajara olmasangiz, undagi doctest sintaksisidan foydalana olmaysiz (bu e'tiborsiz qolishi uchun) yoki natijalarni ko'rsatish uchun doctest sintaksisidan foydalanmoqchi bo'lsangiz, # doctest sintaksisi bilan izoh qo'shishingiz mumkin: +SKIP kod satrlarining oxirida bajarish uchun juda uzun
• Natija chiqaradigan kodning har bir satrida bu natija quyida yozilishi kerak. Agar siz uni kod misolida ko'rsatishni istamasangiz, uni ishlab chiqaruvchi kod qatorining oxiriga # doctest: +IGNORE_RESULT izohini qo'shish orqali chiqishni e'tiborsiz qoldirishingiz mumkin.