3.1 Testfunksjoner og assert

Sjekker at uttrykk er sant. Er det sant, skjer ingenting — programmet går videre til neste linje. Er det usant, avbrytes programmet med en feil som heter AssertionError.

Uttrykket skal være noe som gir sant eller usant: en sammenligning som x > 0, en likhet som len(v) == 4, eller et boolsk uttrykk med and/or. Det er ingen parenteser rundt uttrykket, og ingen kolon etterpå — assert er en setning, ikke en funksjon.

alder = 25
assert alder > 0
print('Alderen er gyldig')

Utskrift:

Alderen er gyldig

Samme sjekk, men med en tekst som blir vist hvis påstanden er usann. Meldingen står etter et komma og er en vanlig streng — gjerne en f-streng, slik at den kan vise tallene som ikke stemte.

Dette er formen boka og de offisielle løsningsforslagene bruker. Grunnen er praktisk: en test som feiler uten melding forteller deg bare at noe er galt, mens en test med melding forteller deg hva som var galt.

antall_maalinger = 3
assert antall_maalinger == 4, 'Vi ventet fire målinger'
print('Denne linja kjøres aldri')

Utskrift: ingen — programmet stopper på assert-linja, og siste linje i feilmeldingen er:

AssertionError: Vi ventet fire målinger

Navnet på feilen assert utløser når påstanden er usann. En exception er en feil som avbryter programmet; AssertionError er én av dem, på linje med ValueError og IndexError fra kap. 2.2.

To ting er verdt å merke seg. For det første kjøres ingenting av det som står etter en assert som feiler — heller ikke resten av linjene i funksjonen. For det andre er teksten du ga etter kommaet det eneste som skiller en nyttig feilmelding fra en ubrukelig: uten melding står det bare AssertionError og ingenting mer.

To flyttall som matematisk er like, er sjelden nøyaktig like i Python. == sammenligner bit for bit og gir False allerede ved et avvik i siste siffer. Derfor er == mellom to utregnede flyttall nesten alltid et feilsvar, og aldri noe du skal skrive i en test.

Det gjelder også uttrykk som matematisk er identiske: kvadratroten av 2, opphøyd i andre, blir ikke nøyaktig 2.

from math import sqrt
print(sqrt(2)**2)
print(sqrt(2)**2 == 2)
print(abs(sqrt(2)**2 - 2) < 1e-10)

Utskrift:

2.0000000000000004
False
True

Merk at == er helt greit mellom heltall: 4 == 4 er True og vil alltid være det. Regelen gjelder flyttall.

Standardformen for å sammenligne to flyttall. expected er verdien du mener er riktig, computed er den funksjonen faktisk gir, og abs gjør differansen positiv uansett hvilken vei avviket går. Er avviket mindre enn toleransen tol, regner vi de to som like.

Navnene expected, computed og tol er de som brukes i de offisielle løsningsforslagene, og boka bruker dem gjennomgående. Bruk dem du også — sensor leser mange besvarelser, og gjenkjennelige navn gjør koden lettere å gi poeng for.

expected = 0.3
computed = 0.1 + 0.2
tol = 1e-10
print(abs(expected - computed) < tol)

Utskrift:

True

Den største forskjellen du godtar mellom fasit og beregnet verdi. Toleransen skrives i eksponentform: 1e-10 betyr $10^{-10}$, og 1e-4 betyr $10^{-4}$.

Valget styres av hvor nøyaktig metoden din er, ikke av hvor nøyaktig du ønsker at den skal være:

En testfunksjon heter test_ pluss navnet på det som testes: test_areal tester areal, test_exp_rekke tester exp_rekke. Den har tomme parenteser — ingen argumenter — fordi alt den trenger står inne i den selv.

Grunnen til navnekonvensjonen er dobbel: den gjør det åpenbart for sensor hva funksjonen tester, og den er den samme konvensjonen profesjonelle testverktøy bruker. I dette emnet trenger du ikke noe testverktøy — en assert inne i en funksjon er alt som kreves, og det er også alt de offisielle løsningsforslagene bruker.

Skal testen sjekke flere verdier, legger du dem inn inne i funksjonen, ikke som argumenter. Gjør du def test_areal(r, expected):, har du skrevet en helt vanlig funksjon, og oppgaven ba om en testfunksjon.

Den vanligste kilden til expected er math-modulens egne funksjoner: exp, log, sin, cos, sinh, atanh og sqrt. Skal du teste din egen tilnærming til $\sinh x$, er sinh(0.5) fra math en uavhengig fasit, siden den er regnet ut på en helt annen måte enn din rekke.

Importen skrives alltid from math import sinh — altså modulen først. Formen import sinh from math finnes ikke i Python og er feil #10 — importsetningen skrevet i feil rekkefølge.

Den andre vanlige kilden er en verdi du kan regne eksakt for hånd: halveringstid, en pytagoreisk trekant, eller et punkt der funksjonen har en kjent verdi som $0$, $1$ eller $\pi/6$.

from math import sinh
print(sinh(0.5))

Utskrift:

0.5210953054937474

En funksjon uten argumenter som sjekker at en annen funksjon gir riktig svar. Den regner ut en fasit på en uavhengig måte, henter det beregnede svaret fra funksjonen, og bruker assert med en toleranse. Den returnerer ingenting og skriver ingenting ut — den enten tier eller stopper programmet.

Tallet abs(expected - computed) — hvor langt det beregnede svaret ligger fra fasiten, uten hensyn til fortegn. Dette er størrelsen testen sammenligner med toleransen. Uten abs slipper ethvert negativt avvik gjennom, uansett hvor stort det er.

Den tar ikke argumenter, den returnerer ikke noe, og den skriver ikke ut noe når alt er i orden. Testverdiene velges inne i funksjonen. En «testfunksjon» med parametere er bare en vanlig funksjon, og oppgaven er ikke besvart.

Teksten etter kommaet i assert. Skrives som f-streng med begge tallene, for eksempel f'ventet {expected}, fikk {computed}'. Uten den står det bare AssertionError når testen feiler, og du vet ikke om det er koden eller fasiten som er gal.

Legg testverdiene i lister og gå gjennom dem med zip, eller skriv assert-linjene rett etter hverandre. Begge deler gir full uttelling. Minst to punkter anbefales, og minst ett av dem skal være et punkt der ingen faktor i uttrykket blir null eller én.

Fordi flyttall er tilnærminger. To matematisk like uttrykk regnet langs ulike veier gir avvik i siste siffer, typisk av størrelsen $10^{-16}$. En toleranse på 0 er det samme som == og vil melde feil på helt riktig kode.

På den avsluttende eksamenen står «skriv en testfunksjon» nesten alltid som andre deloppgave på en oppgave i sjanger F, altså rekke- og sumoppgaven. Den kan besvares selv om du ikke fikk til del-a: skriv testen for funksjonen slik den skulle ha vært, så gir den full uttelling for seg selv.