Боби 11. Санҷиши код

Ҳангоми навиштани функсия ё класс, метавонед барои он санҷишҳо низ нависед. Санҷиш нишон медиҳад, ки коди шумо дар посух ба навъҳои маълумоти воридшавандае, ки барои қабули онҳо пешбинӣ шудааст, мувофиқи интизорӣ кор мекунад.

Вақте санҷишҳо менависед, боварии бештар пайдо мекунед, ки ҳатто бо зиёд шудани шумораи истифодабарандагон барномаатон дуруст кор мекунад. Ҳамчунин ҳангоми илова кардани коди нав метавонед онро санҷед, то боварӣ ҳосил намоед, ки тағйирот кори қисмҳои мавҷудаи барномаро вайрон накардааст.

Ҳар барномасоз хато мекунад. Аз ин рӯ, ҳар барномасоз бояд коди худро пайваста санҷад, то мушкилотро пеш аз он ки корбарон ба онҳо дучор шаванд, пайдо кунад.

Дар ин боб санҷидани кодро бо истифода аз pytest меомӯзед. Китобхонаи pytest маҷмуаи абзорҳоест, ки навиштани санҷишҳои аввалинро зуду осон мекунад. Ҳамзамон он барои санҷишҳои мураккабтаре низ мувофиқ аст, ки бо васеъ шудани лоиҳаҳоятон лозим мешаванд.

Python ба таври пешфарз pytest-ро дар бар намегирад, бинобар ин насб кардани китобхонаҳои берунаро низ меомӯзед. Донистани тарзи насби чунин китобхонаҳо ба шумо имкон медиҳад аз кодҳои зиёди хуб таҳияшуда истифода баред. Ин китобхонаҳо доираи лоиҳаҳоеро, ки метавонед иҷро кунед, хеле васеъ мекунанд.

Шумо сохтани маҷмуаи санҷишҳо ва тафтиш кардани онро меомӯзед, ки оё ҳар маҷмуаи маълумоти воридшаванда натиҷаи дилхоҳ медиҳад ё не. Мебинед, ки санҷиши муваффақ ва санҷиши номуваффақ чӣ гунаанд ва чӣ гуна санҷиши номуваффақ ба беҳтар кардани код ёрӣ медиҳад.

Ҳамчунин санҷидани функсияҳо ва классҳоро меомӯзед ва дарк мекунед, ки барои лоиҳа чӣ қадар санҷиш навиштан лозим аст.

Насб кардани pytest бо pip

Гарчанде китобхонаи стандартии Python имкониятҳои зиёд дорад, таҳиягарони Python аз бастаҳои тарафи сеюм низ бисёр истифода мебаранд.

Бастаи тарафи сеюм китобхонаест, ки берун аз қисми асосии забони Python таҳия шудааст. Баъзе китобхонаҳои маъмули тарафи сеюм баъдтар ба китобхонаи стандартӣ дохил карда мешаванд ва аз ҳамон вақт дар аксари насбҳои Python дастрас мегарданд.

Ин бештар бо китобхонаҳое рӯй медиҳад, ки пас аз ислоҳи хатоҳои аввалияашон эҳтимоли тағйироти зиёдашон кам аст. Чунин китобхонаҳо метавонанд бо суръати рушди худи забон такмил ёбанд.

Аммо бисёр бастаҳо берун аз китобхонаи стандартӣ нигоҳ дошта мешаванд, то рушди онҳо аз ҷадвали рушди худи забон мустақил бошад. Одатан чунин бастаҳо нисбат ба ҳолате, ки ба ҷадвали рушди Python вобаста мебуданд, бештар навсозӣ мешаванд.

Ин ба pytest ва аксари китобхонаҳое, ки барои бозиҳо, тасвирсозии додаҳо ва веббарномаҳо истифода мешаванд, дахл дорад.

Ба ҳар бастаи тарафи сеюм кӯр-кӯрона бовар кардан дуруст нест. Вале он ки бисёр имкониятҳои муҳим тавассути чунин бастаҳо амалӣ мешаванд, набояд шуморо аз истифодаи онҳо боздорад.

Муҳити виртуалӣ

Python абзоре бо номи pip дорад, ки барои насб кардани бастаҳои тарафи сеюм истифода мешавад. Аммо бастаҳоро беҳтар аст на ба худи Python-и система, балки ба муҳити виртуалӣ (virtual environment) насб кунед.

Муҳити виртуалӣ ҷузвдонест, ки нусхаи алоҳидаи Python ва бастаҳои насбшудаи як лоиҳаро нигоҳ медорад. Бастаҳое, ки дар он насб мекунед, ба Python-и система ва ба лоиҳаҳои дигар таъсир намерасонанд. Ин барои ду сабаб муҳим аст:

• Дар баъзе тақсимотҳои Linux ва дар Python-и Homebrew дар macOS Python-и система аз ҷониби мудири бастаҳо идора мешавад. Дар чунин системаҳо фармони pip install берун аз муҳити виртуалӣ бо хатои externally-managed-environment рад карда мешавад.
• Лоиҳаҳои гуногун метавонанд ба версияҳои гуногуни як баста ниёз дошта бошанд. Ҳар лоиҳа бо муҳити худ бо дигарон бархӯрд намекунад.

Сохтани муҳити виртуалӣ

Дар терминал ба ҷузвдони python_work гузаред ва фармони зеринро иҷро кунед (дар macOS ва Linux python3 нависед):

$ python3 -m venv .venv  

Модули venv ҷузвдони .venv-ро месозад, ки дар он муҳити виртуалӣ ҷойгир мешавад. Нуқта дар аввали ном ин ҷузвдонро дар macOS ва Linux пинҳон мекунад; номи .venv барои муҳити виртуалӣ маъмултарин аст.

Фаъол кардани муҳити виртуалӣ

Пеш аз насб ва истифодаи бастаҳо муҳитро фаъол кунед. Дар Windows:

C:\python_work> .venv\Scripts\activate  
(.venv) C:\python_work>  

Агар PowerShell истифода баред ва паём гиред, ки иҷрои скриптҳо манъ аст, ба ҷойи он фармони cmd-ро истифода баред ё як бор фармони Set-ExecutionPolicy -Scope CurrentUser RemoteSigned-ро иҷро кунед.

Дар macOS ва Linux:

$ source .venv/bin/activate  
(.venv) $  

Пешванди (.venv) дар сатри терминал нишон медиҳад, ки муҳити виртуалӣ фаъол аст. Дар дохили он фармони python ба Python-и муҳит ишора мекунад — ҳатто дар macOS ва Linux, ки берун аз муҳит python3 навиштан лозим буд. Барои ғайрифаъол кардани муҳит deactivate-ро ворид кунед. Ҳар бор, ки терминали навро мекушоед, муҳитро бояд аз нав фаъол кунед.

Эзоҳ: VS Code одатан ҷузвдони .venv-ро худ пайдо мекунад ва терминали дохилии худро дар он фаъол менамояд. Агар ин тавр нашавад, фармони Python: Select Interpreter-ро аз менюи View ▸ Command Palette иҷро карда, Python-и дохили .venv-ро интихоб кунед.

Эзоҳ: Агар дар Linux фармони python3 -m venv .venv бо хато анҷом ёбад, бастаи python3-venv-ро насб кунед (ба бахши «Насби Python» дар боби 1 нигаред).

Насб кардани pytest

Дар муҳити фаъол аввал pip-ро нав мекунем. Азбаски pip бастаҳоро аз манбаъҳои беруна насб мекунад, онро барои бартараф кардани мушкилоти амниятӣ зуд-зуд нав мекунанд:

(.venv) $ python -m pip install --upgrade pip  
Requirement already satisfied: pip in ./.venv/lib/python3.12/site-packages (24.0)  
...  
Successfully installed pip-24.2  

Қисми аввали фармон — python -m pip — ба Python мегӯяд, ки модули pip-ро иҷро кунад. Қисми дуюм — install --upgrade — ба pip мегӯяд, ки бастаи аллакай насбшударо навсозӣ кунад. Қисми охир — pip — муайян мекунад, ки кадом баста бояд навсозӣ шавад.

Акнун pytest-ро насб мекунем:

(.venv) $ python -m pip install pytest  
Collecting pytest  
  ...  
Successfully installed iniconfig-2.0.0 packaging-24.1 pluggy-1.5.0 pytest-8.3.2  

Ин дафъа парчами --upgrade лозим нест. Натиҷа нишон медиҳад, ки pytest ҳамроҳи чанд бастаи дигаре, ки ба онҳо вобаста аст, насб шудааст. Рақамҳои версия дар компютери шумо метавонанд дигар бошанд.

Бо ҳамин фармон ҳар бастаи тарафи сеюмро насб ё навсозӣ кардан мумкин аст:

python -m pip install package_name  
python -m pip install --upgrade package_name  

Эзоҳ: Шумо метавонед дар баъзе манбаъҳо фармони pip install --user-ро бинед. Дар системаҳое, ки Python-ро мудири бастаҳо идора мекунад, ин фармон низ рад карда мешавад. Муҳити виртуалӣ дар ҳама системаҳо якхела кор мекунад, бинобар ин дар ин китоб танҳо онро истифода мебарем.

Санҷидани функсия

Барои омӯхтани санҷиш ба мо коде лозим аст, ки онро санҷем.

Ин функсияи одӣ ном ва насабро қабул карда, номи пурраи дуруст қолаббандишударо бармегардонад:

name_function.py

def get_formatted_name(first, last):  
    """Номи пурраро бо шакли дуруст месозад."""  
    full_name = f"{first} {last}"  
    return full_name.title()  

Функсияи get_formatted_name() ном ва насабро бо як фосила байни онҳо пайваст мекунад. Сипас бо title() ҳарфи аввали ҳар калимаро калон карда, натиҷаро бармегардонад.

Барои санҷидани кори get_formatted_name(), барномае месозем, ки ин функсияро истифода мебарад.

Барномаи names.py ба корбарон имкон медиҳад ном ва насаб ворид карда, номи пурраи дуруст қолаббандишударо бинанд:

names.py

from name_function import get_formatted_name

print("Барои баромадан ҳар вақт 'q'-ро ворид кунед.")  
while True:  
    first = input("\nЛутфан номро ворид кунед: ")  
    if first == 'q':  
        break  
    last = input("Лутфан насабро ворид кунед: ")  
    if last == 'q':  
        break

    formatted_name = get_formatted_name(first, last)  
    print(f"\tНоми дуруст қолаббандишуда: {formatted_name}.")  

Ин барнома get_formatted_name()-ро аз name_function.py ворид мекунад. Корбар метавонад пайдарпай ном ва насаб ворид карда, натиҷаҳоро бинад:

Барои баромадан ҳар вақт 'q'-ро ворид кунед.

Лутфан номро ворид кунед: janis  
Лутфан насабро ворид кунед: joplin  
        Номи дуруст қолаббандишуда: Janis Joplin.

Лутфан номро ворид кунед: bob  
Лутфан насабро ворид кунед: dylan  
        Номи дуруст қолаббандишуда: Bob Dylan.

Лутфан номро ворид кунед: q  

Мебинем, ки номҳои ҳосилшуда дурустанд.

Аммо фарз мекунем мехоҳем get_formatted_name()-ро тағйир диҳем, то номи миёнаро низ қабул кунад. Ҳангоми ин тағйирот бояд боварӣ ҳосил кунем, ки функсия барои одамоне, ки танҳо ном ва насаб доранд, ҳанӯз дуруст кор мекунад.

Метавонистем баъд аз ҳар тағйир додани get_formatted_name() барномаи names.py-ро иҷро карда, номеро мисли Janis Joplin ворид кунем. Вале ин кор бо мурури вақт дилгиркунанда мешавад.

Хушбахтона, pytest роҳи самараноки худкор кардани санҷиши натиҷаи функсияро пешниҳод мекунад.

Агар санҷиши get_formatted_name()-ро худкор кунем, ҳамеша боварии бештар хоҳем дошт, ки функсия барои навъҳои номҳое, ки барои онҳо санҷиш навиштаем, дуруст кор мекунад.

Санҷишҳои воҳидӣ ва ҳолатҳои санҷишӣ

Барои санҷидани нармафзор равишҳои гуногун вуҷуд доранд.

Яке аз содатарин навъҳо санҷиши воҳидӣ — unit test — аст. Санҷиши воҳидӣ дурустии як ҷанбаи мушаххаси рафтори функсияро месанҷад.

Ҳолати санҷишӣ — test case — як вазъияти мушаххасест, ки санҷида мешавад: маълумоти воридшаванда ва натиҷае, ки барои он интизорем. Масалан, «барои 'janis' ва 'joplin' функсия 'Janis Joplin'-ро бармегардонад» як ҳолати санҷишӣ аст. Ҳар санҷиши воҳидӣ одатан як ё якчанд ҳолати санҷиширо месанҷад.

Маҷмуаи санҷишҳо — test suite — ҳамаи санҷишҳои як функсия, класс ё лоиҳа дар якҷоягӣ аст. Маҷмуаи хуби санҷишҳо навъҳои асосии маълумоти воридшавандаро, аз ҷумла ҳолатҳои марзӣ (масалан, сатри холӣ ё адади 0), ба назар мегирад ва барои ҳар кадом санҷиши мувофиқ дорад.

Фарогирии код бо санҷишҳо — code coverage — нишон медиҳад, ки ҳангоми иҷрои санҷишҳо кадом қисми код (масалан, чанд фоизи сатрҳо) воқеан иҷро шудааст. Фарогирии баланд нишонаи хуб аст, аммо кафолати дурустии барнома нест: ҳатто агар санҷишҳо 100%-и сатрҳоро иҷро кунанд, онҳо ҳамаи маълумоти воридшавандаи имконпазирро намесанҷанд. Санҷишҳо танҳо ҳолатҳоеро месанҷанд, ки шумо пешбинӣ кардаед.

Дар лоиҳаи калон ба фарогирии баланд расидан метавонад кори душвор бошад. Аксар вақт кофист, ки аввал рафторҳои асосию муҳими кодро санҷед ва бо васеъ шудани истифодаи лоиҳа санҷишҳои навро илова кунед.

Санҷиши муваффақ

Бо pytest навиштани аввалин санҷиши воҳидӣ хеле осон аст.

Мо як функсияи санҷишӣ менависем. Он функсияи санҷидашавандаро даъват мекунад ва нисбат ба қимати баргардондашуда як тасдиқ мегузорад.

Агар тасдиқ дуруст бошад, санҷиш мегузарад. Агар нодуруст бошад, санҷиш номуваффақ мешавад.

Ин аввалин санҷиши get_formatted_name() аст:

test_name_function.py

from name_function import get_formatted_name

def test_first_last_name():  # ❶  
    """Оё номҳое мисли 'Janis Joplin' дуруст кор мекунанд?"""  
    formatted_name = get_formatted_name('janis', 'joplin')  # ❷  
    assert formatted_name == 'Janis Joplin'  # ❸  

Пеш аз иҷрои санҷиш, функсияро муфассалтар баррасӣ мекунем.

Номи файли санҷишӣ муҳим аст: дар ин мисол онро бо test_ оғоз мекунем. Ҳангоми иҷро, pytest файлҳои санҷиширо пайдо карда, санҷишҳои дохили онҳоро иҷро мекунад.

Дар файли санҷишӣ аввал функсияи санҷидашаванда — get_formatted_name()-ро ворид мекунем.

Баъд функсияи санҷиширо муайян мекунем: дар ин ҳолат test_first_last_name() ❶.

Номи он аз номҳои функсияҳое, ки то ҳол истифода мекардем, дарозтар аст ва ин сабаб дорад.

Аввалан, номи функсияҳои санҷишӣ бояд бо test_ оғоз шавад. pytest чунин функсияҳоро пайдо карда, ҳамчун қисми раванди санҷиш иҷро мекунад.

Дуюм, номи санҷиш бояд аз номи функсияи одӣ тавсифитар бошад. Шумо ин функсияро мустақилона даъват намекунед: pytest онро ёфта, иҷро мекунад.

Номи функсияи санҷишӣ бояд ба қадри кофӣ равшан бошад, то ҳангоми дидани он дар гузориш фаҳмед, ки кадом рафтор санҷида шудааст.

Сипас функсияи санҷидашавандаро даъват мекунем ❷. Дар ин ҷо ба get_formatted_name() аргументҳои 'janis' ва 'joplin'-ро медиҳем — ҳамон қиматҳое, ки ҳангоми иҷрои names.py истифода кардем.

Қимати баргардондаро ба formatted_name нисбат медиҳем.

Дар охир тасдиқе бо assert менависем ❸. Тасдиқ изҳоротест, ки бояд дуруст бошад. Дар ин ҷо мегӯем, ки қимати formatted_name бояд ба 'Janis Joplin' баробар бошад.

Иҷрои санҷиш

Агар test_name_function.py-ро бевосита иҷро кунед, натиҷае намебинед, зеро функсияи санҷиширо даъват накардаем.

Ба ҷойи ин, иҷрои файли санҷиширо ба pytest месупорем.

Барои ин терминалро кушода, ба ҷузвдони дорои файли санҷишӣ гузаред.

Агар VS Code истифода баред, метавонед ҷузвдони дорои файли санҷиширо кушода, аз терминали дохилии муҳаррир истифода кунед.

Дар терминал фармони pytest-ро ворид кунед. Натиҷа бояд тақрибан чунин бошад:

$ pytest  
========================= test session starts =========================  
platform darwin -- Python 3.x.x, pytest-7.x.x, pluggy-1.x.x  
rootdir: /.../python_work/chapter_11  
collected 1 item

test_name_function.py .                                          [100%]  
========================== 1 passed in 0.00s ==========================  

Биёед натиҷаро фаҳмем.

Аввал маълумоти системаеро мебинем, ки санҷиш дар он иҷро мешавад. Ман ин санҷишро дар macOS иҷро мекунам, бинобар ин дар системаи шумо ин қисм метавонад фарқ кунад.

Аз ҳама муҳим он аст, ки версияҳои Python, pytest ва бастаҳои дигари истифодашавандаро мебинем.

Баъд ҷузвдони иҷрои санҷиш нишон дода мешавад: дар мисоли ман python_work/chapter_11.

Сатри collected 1 item мегӯяд, ки pytest як санҷиш пайдо кардааст. Баъд номи файли санҷишии иҷрошавандаро мебинем.

Нуқтаи ягонаи пас аз номи файл нишон медиҳад, ки як санҷиш бомуваффақият гузаштааст. Нишонаи 100% мегӯяд, ки ҳамаи санҷишҳо иҷро шудаанд.

Лоиҳаи калон метавонад садҳо ё ҳазорҳо санҷиш дошта бошад. Нуқтаҳо ва нишондиҳандаи фоиз барои назорат кардани пешрафти умумии санҷиш муфиданд.

Сатри охир мегӯяд, ки як санҷиш гузаштааст ва иҷрои он камтар аз 0.01 сония вақт гирифтааст.

Ин натиҷа нишон медиҳад, ки get_formatted_name() барои мисоли санҷидашуда дуруст кор мекунад. Ҳангоми тағйир додани функсия метавонем санҷишро дубора иҷро кунем.

Агар он гузарад, медонем, ки функсия барои номҳое мисли Janis Joplin ҳанӯз дуруст кор мекунад.

Эзоҳ: Агар надонед дар терминал чӣ гуна ба ҷузвдони лозимӣ гузаред, ба бахши «Иҷрои барномаҳои Python аз терминал» дар боби 1 муроҷиат кунед. Агар паёме бинед, ки фармони pytest ёфт нашуд, аввал санҷед, ки муҳити виртуалӣ фаъол аст — дар сатри терминал бояд (.venv) намоён бошад. Агар фаъол бошад ва мушкил боқӣ монад, ба ҷойи pytest фармони python -m pytest-ро истифода баред.

Санҷиши номуваффақ

Санҷиши номуваффақ чӣ гуна менамояд?

Биёед get_formatted_name()-ро барои қабули номи миёна тағйир диҳем, вале ин корро тавре анҷом диҳем, ки функсия барои номҳои танҳо аз ном ва насаб иборатбуда, мисли Janis Joplin, дигар дуруст кор накунад.

Ин версияи нави функсия аргументи номи миёнаро ҳатмӣ мекунад:

name_function.py

def get_formatted_name(first, middle, last):  
    """Номи пурраро бо шакли дуруст месозад."""  
    full_name = f"{first} {middle} {last}"  
    return full_name.title()  

Ин версия бояд барои одамони дорои номи миёна кор кунад. Вале ҳангоми санҷиш мебинем, ки кори функсияро барои одамоне, ки танҳо ном ва насаб доранд, вайрон кардаем.

Ин дафъа иҷрои pytest чунин натиҷа медиҳад:

$ pytest  
========================= test session starts =========================  
...  
test_name_function.py F                                          [100%]  
============================== FAILURES ===============================  
________________________ test_first_last_name _________________________

    def test_first_last_name():  
        """Оё номҳое мисли 'Janis Joplin' дуруст кор мекунанд?"""  
>       formatted_name = get_formatted_name('janis', 'joplin')  
E       TypeError: get_formatted_name() missing 1 required positional  
            argument: 'last'

test_name_function.py:5: TypeError  
======================= short test summary info =======================  
FAILED test_name_function.py::test_first_last_name - TypeError:  
    get_formatted_name() missing 1 required positional argument: 'last'  
========================== 1 failed in 0.04s ==========================  

Дар ин ҷо маълумоти зиёд ҳаст, зеро ҳангоми номуваффақ шудани санҷиш метавонад ҷузъиёти гуногун лозим шавад.

Аввал ҳарфи F-ро мебинем, ки номуваффақ шудани як санҷишро нишон медиҳад.

Сипас бахши FAILURES меояд. Ҳангоми иҷрои санҷишҳо одатан диққати асосӣ бояд ба санҷишҳои номуваффақ равона шавад.

Баъд мебинем, ки функсияи санҷишии test_first_last_name() номуваффақ шудааст.

Аломати > сатри коди сабабгори нокомиро нишон медиҳад.

Ҳарфи E дар сатри баъдӣ хатои воқеиро нишон медиҳад: TypeError, ки аз набудани аргументи ҳатмии мавқеии last ба вуҷуд омадааст.

Дар охир маълумоти муҳим дар шакли кӯтоҳ такрор мешавад. Ҳамин тавр, ҳангоми иҷрои санҷишҳои зиёд метавонед зуд фаҳмед, ки кадом санҷишҳо ва бо чӣ сабаб номуваффақ шудаанд.

Вокуниш ба санҷиши номуваффақ

Вақте санҷиш номуваффақ мешавад, чӣ бояд кард?

Агар шартҳои дурустро санҷида истода бошед, гузаштани санҷиш нишон медиҳад, ки рафтори санҷидашуда дуруст аст. Номуваффақ шудани он метавонад нишон диҳад, ки дар коди нави шумо мушкил пайдо шудааст.

Пас, вақте санҷиш номуваффақ мешавад, худи санҷишро танҳо барои гузаштани он тағйир надиҳед. Дар акси ҳол санҷишҳоятон метавонанд гузаранд, вале ҳар коде, ки функсияро мисли санҷиш даъват мекунад, дигар кор нахоҳад кард.

Ба ҷойи ин, коди сабабгори нокомиро ислоҳ кунед. Тағйироти охирини функсияро баррасӣ карда, муайян намоед, ки чӣ гуна онҳо рафтори пешбинишударо вайрон карданд.

Дар ин мисол get_formatted_name() пештар танҳо ду параметр талаб мекард: ном ва насаб. Акнун ном, номи миёна ва насабро талаб мекунад.

Илова шудани параметри ҳатмии номи миёна рафтори пешинаи функсияро вайрон кард.

Беҳтарин роҳ ин аст, ки номи миёнаро ихтиёрӣ кунем. Баъд санҷиши номҳое мисли Janis Joplin бояд дубора гузарад ва функсия ҳамзамон номи миёнаро низ қабул кунад.

Биёед функсияро ҳамин тавр тағйир дода, санҷишро дубора иҷро кунем. Агар он гузарад, баъд дуруст кор кардани номи миёнаро низ месанҷем.

Барои ихтиёрӣ кардани номи миёна, параметри middle-ро ба охири рӯйхати параметрҳо мегузаронем ва қимати пешфарзи холӣ медиҳем.

Ҳамчунин шарти if илова мекунем, то номи пурра вобаста ба дода шудан ё нашудани номи миёна дуруст сохта шавад:

name_function.py

def get_formatted_name(first, last, middle=''):  
    """Номи пурраро бо шакли дуруст месозад."""  
    if middle:  
        full_name = f"{first} {middle} {last}"  
    else:  
        full_name = f"{first} {last}"  
    return full_name.title()  

Дар ин версия номи миёна ихтиёрӣ аст.

Агар номи миёна ба функсия дода шавад, номи пурра аз ном, номи миёна ва насаб иборат мешавад. Дар акси ҳол танҳо ном ва насабро дар бар мегирад.

Акнун функсия бояд барои ҳар ду навъи ном кор кунад.

Барои фаҳмидани он ки функсия барои номҳое мисли Janis Joplin ҳанӯз дуруст кор мекунад ё не, санҷишро дубора иҷро мекунем:

$ pytest  
========================= test session starts =========================  
...  
test_name_function.py .                                          [100%]  
========================== 1 passed in 0.00s ==========================  

Акнун санҷиш мегузарад. Ин натиҷаи дилхоҳ аст: функсия дубора барои номҳое мисли Janis Joplin кор мекунад ва лозим нашуд онро дастӣ санҷем.

Ислоҳи функсия осонтар шуд, зеро санҷиши номуваффақ нишон дод, ки коди нав чӣ гуна рафтори мавҷударо вайрон кардааст.

Илова кардани санҷишҳои нав

Акнун медонем, ки get_formatted_name() барои номҳои одӣ дубора кор мекунад. Биёед барои одамони дорои номи миёна санҷиши дуюм нависем.

Барои ин ба test_name_function.py боз як функсияи санҷишӣ илова мекунем:

test_name_function.py

from name_function import get_formatted_name

def test_first_last_name():  
    """Оё номҳое мисли 'Janis Joplin' дуруст кор мекунанд?"""  
    formatted_name = get_formatted_name('janis', 'joplin')  
    assert formatted_name == 'Janis Joplin'

def test_first_last_middle_name():  
    """Оё номҳое мисли 'Wolfgang Amadeus Mozart' дуруст кор мекунанд?"""  
    formatted_name = get_formatted_name(  # ❶  
        'wolfgang', 'mozart', 'amadeus'  
    )  
    assert formatted_name == 'Wolfgang Amadeus Mozart'  # ❷  

Функсияи навро test_first_last_middle_name() ном мегузорем.

Номи он бояд бо test_ оғоз шавад, то ҳангоми иҷрои pytest худкор иҷро гардад.

Номро тавре интихоб мекунем, ки кадом рафтори get_formatted_name()-ро санҷиданамон равшан бошад. Дар натиҷа, агар санҷиш номуваффақ шавад, фавран мефаҳмем, ки мушкил ба кадом навъи номҳо дахл дорад.

Барои санҷиш, get_formatted_name()-ро бо ном, насаб ва номи миёна даъват мекунем ❶.

Баъд бо assert месанҷем ❷, ки номи пурраи баргардондашуда ба натиҷаи интизорӣ — ном, номи миёна ва насаб — мувофиқат мекунад.

Ҳангоми иҷрои дубораи pytest ҳар ду санҷиш мегузаранд:

$ pytest  
========================= test session starts =========================  
...  
collected 2 items

test_name_function.py ..                                         [100%]  
========================== 2 passed in 0.01s ==========================  

Ду нуқта нишон медиҳад, ки ду санҷиш гузаштаанд. Ин дар сатри охири натиҷа низ равшан гуфта шудааст.

Акнун медонем, ки функсия барои номҳое мисли Janis Joplin ҳанӯз кор мекунад ва барои номҳое мисли Wolfgang Amadeus Mozart низ натиҷаи дуруст медиҳад.

Худатон бисанҷед

11-1. Шаҳр, кишвар. Функсияе нависед, ки ду параметр қабул мекунад: номи шаҳр ва номи кишвар.

Функсия бояд як сатри ягона дар шакли City, Country, масалан Santiago, Chile, баргардонад.

Функсияро дар модуле бо номи city_functions.py нигоҳ доред. Ин файлро дар ҷузвдони нав ҷойгир кунед, то pytest санҷишҳои қаблан навиштаамонро иҷро накунад.

Файле бо номи test_cities.py созед, ки функсияи навиштаатонро месанҷад.

Функсияи test_city_country()-ро нависед, то тафтиш кунад, ки даъвати функсия бо қиматҳое мисли 'santiago' ва 'chile' сатри дурустро медиҳад.

Санҷишро иҷро карда, боварӣ ҳосил кунед, ки test_city_country() мегузарад.

11-2. Аҳолӣ. Функсияатонро тағйир диҳед, то параметри сеюми ҳатмӣ — population — талаб кунад.

Акнун он бояд сатреро дар чунин шакл баргардонад:

City, Country – population xxx  

Масалан:

Santiago, Chile – population 5000000  

Санҷишро дубора иҷро карда, боварӣ ҳосил кунед, ки ин дафъа test_city_country() номуваффақ мешавад.

Функсияро тағйир диҳед, то параметри population ихтиёрӣ бошад. Санҷишро иҷро кунед ва боварӣ ҳосил намоед, ки test_city_country() дубора мегузарад.

Санҷиши дуюме бо номи test_city_country_population() нависед. Он бояд тафтиш кунад, ки функсияро бо қиматҳои 'santiago', 'chile' ва аргументи population=5000000 даъват кардан мумкин аст.

Санҷишҳоро боз як бор иҷро карда, боварӣ ҳосил кунед, ки санҷиши нав низ мегузарад.

Санҷидани класс

Дар қисми аввали боб барои як функсия санҷишҳо навиштед. Акнун барои класс санҷиш менависед.

Дар бисёр барномаҳои худ классҳоро истифода хоҳед бурд. Аз ин рӯ, тавони санҷидани дурустии кори онҳо муфид аст.

Агар барои класси таҳияшаванда санҷишҳои муваффақ дошта бошед, боварии бештар пайдо мекунед, ки беҳбудиҳои нав рафтори ҷории онро тасодуфан вайрон намекунанд.

Навъҳои гуногуни тасдиқҳо

То ҳол танҳо як навъи тасдиқро дидед: санҷидани он ки сатр қимати муайян дорад.

Ҳангоми навиштани санҷиш метавонед ҳар иддаоеро бисанҷед, ки ҳамчун ифодаи шартӣ навиштан мумкин аст.

Агар шарт мувофиқи интизорӣ True бошад, фарзияи шумо дар бораи кори ҳамон қисми барнома тасдиқ мешавад.

Агар шарте, ки онро дуруст мепиндоштед, дар асл False бошад, санҷиш номуваффақ мешавад ва мефаҳмед, ки масъалае барои ҳал кардан вуҷуд дорад.

Ҷадвали 11-1 баъзе аз тасдиқҳои муфидтарини санҷишҳои аввалинро нишон медиҳад.

Ҷадвали 11-1. Дастурҳои маъмули тасдиқ дар санҷишҳо

Инҳо танҳо чанд мисоланд. Ҳар чизеро, ки ҳамчун ифодаи шартӣ навиштан мумкин аст, дар санҷиш истифода бурдан мумкин аст.

Классе барои санҷидан

Санҷидани класс ба санҷидани функсия монанд аст, зеро қисми зиёди кор аз санҷидани рафтори методҳои класс иборат мешавад.

Аммо чанд фарқ ҳам вуҷуд дорад. Биёед классе нависем, ки онро санҷидан мумкин бошад.

Класси зерин барои гузаронидани пурсишҳои беном ёрӣ медиҳад:

survey.py

class AnonymousSurvey:  
    """Ҷавобҳои беномро ба саволи пурсиш ҷамъ мекунад."""

    def __init__(self, question):  # ❶  
        """Саволро нигоҳ дошта, барои нигоҳдории ҷавобҳо омода мешавад."""  
        self.question = question  
        self.responses = []

    def show_question(self):  # ❷  
        """Саволи пурсишро нишон медиҳад."""  
        print(self.question)

    def store_response(self, new_response):  # ❸  
        """Як ҷавоби пурсишро нигоҳ медорад."""  
        self.responses.append(new_response)

    def show_results(self):  # ❹  
        """Ҳамаи ҷавобҳои гирифташударо нишон медиҳад."""  
        print("Натиҷаҳои пурсиш:")  
        for response in self.responses:  
            print(f"- {response}")  

Ин класс аз саволи пешниҳодкардаи шумо оғоз мешавад ❶ ва рӯйхати холие барои нигоҳдории ҷавобҳо дорад.

Дар класс методҳое мавҷуданд, ки саволро чоп мекунанд ❷, ҷавоби навро ба рӯйхат илова мекунанд ❸ ва ҳамаи ҷавобҳои нигоҳдошташударо нишон медиҳанд ❹.

Барои сохтани намунаи ин класс танҳо як савол додан кифоя аст.

Пас аз сохтани намунае, ки пурсиши муайянро ифода мекунад, метавонед:

• бо show_question() саволро нишон диҳед;
• бо store_response() ҷавобро нигоҳ доред;
• бо show_results() натиҷаҳоро намоиш диҳед.

Барои нишон додани кори AnonymousSurvey, барномае менависем, ки ин классро истифода мебарад:

language_survey.py

from survey import AnonymousSurvey

# Саволро муайян карда, пурсиш месозем.  
question = "Аввал бо кадом забон сухан гуфтанро омӯхтед?"  
language_survey = AnonymousSurvey(question)

# Саволро нишон дода, ҷавобҳоро нигоҳ медорем.  
language_survey.show_question()  
print("Барои баромадан ҳар вақт 'q'-ро ворид кунед.\n")  
while True:  
    response = input("Забон: ")  
    if response == 'q':  
        break  
    language_survey.store_response(response)

# Натиҷаҳои пурсишро нишон медиҳем.  
print("\nБа ҳамаи иштирокчиёни пурсиш ташаккур!")  
language_survey.show_results()  

Барнома саволи «Аввал бо кадом забон сухан гуфтанро омӯхтед?»-ро муайян мекунад ва бо ҳамин савол объекти AnonymousSurvey месозад.

Барои нишон додани савол show_question()-ро даъват мекунад ва баъд ҷавобҳоро мепурсад. Ҳар ҷавоб баробари гирифта шуданаш нигоҳ дошта мешавад.

Пас аз ворид шудани ҳамаи ҷавобҳо — вақте корбар барои баромадан q менависад — show_results() натиҷаҳоро чоп мекунад:

Аввал бо кадом забон сухан гуфтанро омӯхтед?  
Барои баромадан ҳар вақт 'q'-ро ворид кунед.

Забон: English  
Забон: Spanish  
Забон: English  
Забон: Mandarin  
Забон: q

Ба ҳамаи иштирокчиёни пурсиш ташаккур!  
Натиҷаҳои пурсиш:  
- English  
- Spanish  
- English  
- Mandarin  

Ин класс барои пурсиши одии беном кор мекунад. Вале фарз мекунем мехоҳем AnonymousSurvey ва модули дорои он — survey-ро беҳтар кунем.

Метавонем ба ҳар корбар иҷозат диҳем зиёда аз як ҷавоб ворид кунад. Ё методе нависем, ки танҳо ҷавобҳои такрорнашавандаро нишон диҳад ва шумораи такрори ҳар ҷавобро ҳисоб кунад. Ҳатто метавонем барои пурсишҳои ғайрибеном класси дигаре созем.

Амалӣ кардани чунин тағйирот метавонад ба рафтори ҷории AnonymousSurvey таъсир расонад.

Масалан, ҳангоми илова кардани имконияти ворид кардани чанд ҷавоб аз тарафи як корбар, мумкин аст тасодуфан тарзи коркарди як ҷавобро тағйир диҳем.

Барои боварӣ ҳосил кардан, ки ҳангоми рушди модул рафтори мавҷударо вайрон намекунем, метавонем барои класс санҷишҳо нависем.

Санҷидани класси AnonymousSurvey

Биёед санҷише нависем, ки як ҷанбаи рафтори AnonymousSurvey-ро месанҷад.

Месанҷем, ки як ҷавоб ба саволи пурсиш дуруст нигоҳ дошта мешавад:

test_survey.py

from survey import AnonymousSurvey

def test_store_single_response():  # ❶  
    """Дуруст нигоҳ дошта шудани як ҷавобро месанҷад."""  
    question = "Аввал бо кадом забон сухан гуфтанро омӯхтед?"  
    language_survey = AnonymousSurvey(question)  # ❷  
    language_survey.store_response('English')  
    assert 'English' in language_survey.responses  # ❸  

Аввал класси санҷидашаванда — AnonymousSurvey-ро ворид мекунем.

Функсияи санҷишии аввал тафтиш мекунад, ки ҷавоби нигоҳдошташуда воқеан ба рӯйхати ҷавобҳои пурсиш ворид шудааст.

Номи хубу тавсифии ин функсия test_store_single_response() аст ❶.

Агар санҷиш номуваффақ шавад, аз номи функсия дар гузориш мефаҳмем, ки дар нигоҳдории як ҷавоб мушкил вуҷуд дорад.

Барои санҷидани рафтори класс бояд намунаи онро созем.

Мо намунае бо номи language_survey месозем ❷ ва ба он саволи «Аввал бо кадом забон сухан гуфтанро омӯхтед?»-ро медиҳем.

Бо методи store_response() як ҷавоб — English-ро нигоҳ медорем. Баъд бо assert месанҷем, ки English дар рӯйхати language_survey.responses ҳаст ❸.

Бо танзимоти пешфарз, иҷрои pytest бе аргумент ҳамаи санҷишҳои дар ҷузвдони ҷорӣ ва зерҷузвдонҳои мувофиқ пайдошударо иҷро мекунад.

Барои иҷрои санҷишҳои танҳо як файл, номи ҳамон файлро диҳед. Дар ин ҷо танҳо санҷиши барои AnonymousSurvey навиштаамонро иҷро мекунем:

$ pytest test_survey.py  
========================= test session starts =========================  
...  
test_survey.py .                                                 [100%]  
========================== 1 passed in 0.01s ==========================  

Ин оғози хуб аст, вале пурсиш танҳо вақте муфид мешавад, ки зиёда аз як ҷавоб ҷамъ кунад.

Биёед тафтиш кунем, ки се ҷавоб дуруст нигоҳ дошта мешаванд. Барои ин ба test_survey.py функсияи дигар илова мекунем:

from survey import AnonymousSurvey

def test_store_single_response():  
    """Дуруст нигоҳ дошта шудани як ҷавобро месанҷад."""  
    question = "Аввал бо кадом забон сухан гуфтанро омӯхтед?"  
    language_survey = AnonymousSurvey(question)  
    language_survey.store_response('English')  
    assert 'English' in language_survey.responses

def test_store_three_responses():  
    """Дуруст нигоҳ дошта шудани се ҷавоби алоҳидаро месанҷад."""  
    question = "Аввал бо кадом забон сухан гуфтанро омӯхтед?"  
    language_survey = AnonymousSurvey(question)

    responses = ['English', 'Spanish', 'Mandarin']  # ❶  
    for response in responses:  
        language_survey.store_response(response)

    for response in responses:  # ❷  
        assert response in language_survey.responses  

Функсияи навро test_store_three_responses() меномем.

Мисли test_store_single_response(), объекти пурсиш месозем. Рӯйхати дорои се ҷавоби гуногунро муайян мекунем ❶ ва барои ҳар ҷавоб store_response()-ро даъват менамоем.

Пас аз нигоҳ доштани ҷавобҳо, даври дигаре менависем ва месанҷем, ки ҳар ҷавоб дар language_survey.responses ҳаст ❷.

Ҳангоми иҷрои дубораи файл ҳар ду санҷиш — барои як ҷавоб ва барои се ҷавоб — мегузаранд:

$ pytest test_survey.py  
========================= test session starts =========================  
...  
test_survey.py ..                                                [100%]  
========================== 2 passed in 0.01s ==========================  

Ҳамааш дуруст кор мекунад. Аммо дар ин санҷишҳо каме такрори код ҳаст. Барои беҳтар кардани онҳо аз имконияти дигари pytest истифода мебарем.

Истифодаи фикстураҳо

Дар test_survey.py барои ҳар функсияи санҷишӣ намунаи нави AnonymousSurvey сохтем.

Дар ин мисоли кӯтоҳ ин мушкил нест. Вале дар лоиҳаи воқеӣ бо даҳҳо ё садҳо санҷиш чунин такрор метавонад нороҳаткунанда шавад.

Дар санҷиш фикстура — fixture — барои омода кардани муҳити санҷиш ёрӣ медиҳад. Аксар вақт ин маънои сохтани захираеро дорад, ки чанд санҷиш аз он истифода мебаранд.

Дар pytest фикстураро бо навиштани функсия ва илова кардани декоратори @pytest.fixture месозем.

Декоратор нишонаест, ки бевосита пеш аз таърифи функсия гузошта мешавад. Python онро ба функсия татбиқ мекунад, то тарзи кори онро тағйир диҳад ё ба он рафтори иловагӣ диҳад.

Агар ин мураккаб намояд, хавотир нашавед. Пеш аз омӯхтани навиштани декораторҳо метавонед истифодаи декораторҳои китобхонаҳои тайёрро оғоз кунед.

Биёед бо фикстура тарзи сохтани пурсишро дар як ҷо муайян кунем, то ҳар ду функсияи санҷишии test_survey.py аз он истифода баранд:

import pytest  
from survey import AnonymousSurvey

@pytest.fixture  # ❶  
def language_survey():  # ❷  
    """Пурсишеро омода мекунад, ки санҷишҳо истифода бурда метавонанд."""  
    question = "Аввал бо кадом забон сухан гуфтанро омӯхтед?"  
    language_survey = AnonymousSurvey(question)  
    return language_survey

def test_store_single_response(language_survey):  # ❸  
    """Дуруст нигоҳ дошта шудани як ҷавобро месанҷад."""  
    language_survey.store_response('English')  # ❹  
    assert 'English' in language_survey.responses

def test_store_three_responses(language_survey):  # ❺  
    """Дуруст нигоҳ дошта шудани се ҷавоби алоҳидаро месанҷад."""  
    responses = ['English', 'Spanish', 'Mandarin']  
    for response in responses:  
        language_survey.store_response(response)  # ❻

    for response in responses:  
        assert response in language_survey.responses  

Акнун бояд pytest-ро ворид кунем, зеро аз декоратори дар он муайяншуда истифода мебарем.

Декоратори @pytest.fixture-ро ❶ ба функсияи нави language_survey() ❷ татбиқ мекунем.

Ин функсия объекти AnonymousSurvey сохта, онро бармегардонад.

Аҳамият диҳед, ки таърифи ҳар ду функсияи санҷишӣ тағйир ёфтааст ❸ ❺: акнун ҳар кадом параметре бо номи language_survey дорад.

Вақте номи параметри функсияи санҷишӣ ба номи фикстура мувофиқат мекунад, pytest он фикстураро худкор иҷро карда, қимати баргардондаи онро ба функсияи санҷишӣ медиҳад.

Дар ин мисол функсияи фикстуравии language_survey() барои ҳар ду санҷиш объекти лозимиро омода мекунад. Бо танзимоти пешфарз, барои ҳар санҷиш намунаи нави алоҳида сохта мешавад.

Ба худи функсияҳои санҷишӣ коди нав илова нашудааст. Вале аз ҳар кадом ду сатр бардошта шуд ❹ ❻: сатри муайян кардани савол ва сатри сохтани объекти AnonymousSurvey.

Ҳангоми иҷрои дубораи файли санҷишӣ ҳар ду санҷиш ҳанӯз мегузаранд.

Ин санҷишҳо махсусан ҳангоми васеъ кардани AnonymousSurvey барои қабули чанд ҷавоб аз ҳар шахс муфид мешаванд.

Пас аз тағйир додани код метавонед онҳоро иҷро карда, боварӣ ҳосил кунед, ки имконияти нигоҳ доштани як ҷавоб ё пайдарпайии ҷавобҳои алоҳида вайрон нашудааст.

Сохтори боло эҳтимол мураккаб намояд: он баъзе аз мафҳумҳои абстрактитаринеро дар бар мегирад, ки то ҳол дидаед.

Истифодаи фаврии фикстураҳо шарт нест. Навиштани санҷишҳои дорои коди такрорӣ аз умуман нанавиштани санҷиш беҳтар аст.

Танҳо бидонед, ки вақте шумораи санҷишҳо зиёд шуда, такрори код монеъ мешавад, барои ҳалли ин масъала роҳи маъмулу санҷидашуда вуҷуд дорад.

Ҳамчунин дар мисолҳои одие мисли ин фикстураҳо ҳатман кодро кӯтоҳтар ё фаҳмотар намекунанд.

Вале дар лоиҳаҳои дорои санҷишҳои зиёд ё дар ҳолатҳое, ки сохтани захираи муштараки санҷишҳо сатрҳои зиёдеро талаб мекунад, фикстураҳо метавонанд коди санҷиширо хеле беҳтар созанд.

Барои навиштани фикстура:

1. Функсияе нависед, ки захираи барои чанд санҷиш лозимиро месозад.
2. Ба он декоратори @pytest.fixture илова кунед.
3. Номи функсияи фикстураро ҳамчун параметр ба ҳар санҷише диҳед, ки ин захираро истифода мебарад.

Аз ҳамин вақт санҷишҳоятон кӯтоҳтар шуда, навиштан ва нигоҳдории онҳо осонтар мешавад.

Худатон бисанҷед

11-3. Корманд. Классе бо номи Employee нависед.

Методи __init__() бояд ном, насаб ва маоши солонаро қабул карда, ҳар кадомро ҳамчун атрибут нигоҳ дорад.

Методе бо номи give_raise() нависед, ки бо танзими пешфарз ба маоши солона 5000 доллар илова мекунад, вале ҳамзамон миқдори дигари афзоишро низ қабул карда метавонад.

Барои Employee файли санҷишӣ бо ду функсия нависед:

test_give_default_raise()  
test_give_custom_raise()  

Аввал санҷишҳоро бе фикстура нависед ва боварӣ ҳосил кунед, ки ҳар ду мегузаранд.

Баъд фикстурае нависед, то дар ҳар функсияи санҷишӣ аз нав объекти корманд сохтан лозим нашавад.

Санҷишҳоро дубора иҷро карда, боварӣ ҳосил кунед, ки ҳар ду ҳанӯз мегузаранд.

Хулоса

Дар ин боб бо абзорҳои модули pytest навиштани санҷишҳо барои функсияҳо ва классҳоро омӯхтед.

Функсияҳои санҷишие навиштед, ки рафторҳои мушаххаси пешбинишудаи функсияҳо ва классҳоро месанҷанд.

Ҳамчунин дидед, ки фикстураҳо барои самаранок сохтани захираҳое истифода мешаванд, ки чанд функсияи санҷишӣ ба онҳо ниёз доранд.

Санҷиш мавзӯи муҳимест, ки бисёр барномасозони навкор бо он шинос намешаванд.

Барои ҳамаи лоиҳаҳои одие, ки ҳамчун навкор месозед, санҷиш навиштан шарт нест. Аммо вақте ба лоиҳаҳое мегузаред, ки таҳияи онҳо меҳнати назаррас талаб мекунад, бояд рафторҳои муҳими функсияҳо ва классҳоро санҷед.

Ҳамин тавр, боварии бештар пайдо мекунед, ки тағйироти нав қисмҳои дуруст коркунандаи лоиҳаро вайрон намекунанд. Ин ба шумо озодии бештар барои беҳтар кардани код медиҳад.

Агар тасодуфан имконияти мавҷударо вайрон кунед, фавран мефаҳмед ва метавонед мушкилро ҳанӯз ба осонӣ ислоҳ намоед.

Ҳал кардани мушкиле, ки санҷиши худатон ошкор кардааст, аз посух додан ба гузориши хатои корбари норозӣ хеле осонтар аст.

Агар лоиҳаатон якчанд санҷиши аввалия дошта бошад, барномасозони дигар ба он эътимоди бештар мекунанд. Онҳо барои таҷриба кардан бо коди шумо худро роҳаттар ҳис мекунанд ва ба ҳамкорӣ дар лоиҳаҳоятон бештар омода мешаванд.

Агар хоҳед дар лоиҳаи барномасозони дигар саҳм гузоред, аз шумо интизор мешаванд, ки коди пешниҳодкардаатон санҷишҳои мавҷударо мегузарад. Одатан барои ҳар рафтори нави ба лоиҳа илова кардаатон низ навиштани санҷиш талаб мешавад.

Бо санҷишҳо таҷриба кунед, то ба раванди санҷидани код одат намоед. Барои рафторҳои муҳимтарини функсияҳо ва классҳоятон санҷиш нависед. Вале дар лоиҳаҳои аввалин, агар сабаби мушаххас надошта бошед, фарогирии пурраи кодро ҳадаф нагузоред.