För att göra det lättare att hitta i koden är det bör den följa en genomtänkt koddisposition. Nedan är en vanlig disposition som används i många språk.

1. Alla import-satser placeras högst upp i filen (se också PEP8 - Imports för intern ordning)
2. Eventuella globala konstanter
3. Funktionsdefinitioner
4. Kod utanför funktioner, t.ex. anrop till en main()-funktion och annan kod i if __name__ == "__main__":-block.

• Alla satser som består av fler än en rad ska ha en tillhörande kommentar. Dvs if-satser, loopar, funktioner och metoder. Kommentaren ska inte vara en “innantilläsning” av koden den hör till. Använd rätt kommentarsmarkering (d.v.s. # för kommentarer i löpande kod, se PEP8 - Comments, och """ för dokumentationssträngar, PEP 257).
• Funktioner och variabler ska vara döpta på ett bra sätt, dvs att de är beskrivande och reflekterar innehåll/funktion. Låt funktionsnamn vara verb och variabelnamn vara substantiv. Undvik namn på enbart en bokstav (var beredda att kunna motivera varför ni valt just det namnet). Se PEP8 - Naming Conventions för mer detaljer.

Här är icke-godkänd kod:

1
2
3
4
5
6
7
8

v = 0
q = 0
u = [19, 21, 24, 20]

# för alla element t i u, lägg till t till v
for t in u:
    v += t
q = v/len(u)

Här är en godkänd variant:

1
2
3
4
5
6
7
8

sum_age = 0
avg_age = 0
ages = [19, 21, 24, 20]

# beräkna summan av alla åldrar
for age in ages:
    sum_age += age
avg_age = sum_age/len(ages)

• Minimera användningen av hårdkodade siffror, (s.k. magic numbers). Använd istället variabler med förklarande namn.
• Dela upp er kod i delfunktioner/delmetoder vid behov:
  • när ni stöter på kod som ni upprepar, bryt ut koden (lägg koden i en separat funktion/metod)
  • dela även upp er kod i fler funktioner/metoder när den blir för lång

Ni bestämmer själva vad som skrivs ut när ni kör ert program. Under utvecklingen kan ni också skriva ut mer information som hjälper er felsöka.

Exempel på kontroll av texten kort2.txt och 6cyyy-2019.txt med hjälp av ordfrekvensdata från webbnyheter:

$ ./spellcheck.py data/webbnyheter2013_stats.tsv texter/kort2.txt texter/6cyyy-2019.txt
* Loading word frequency data from 'data/webbnyheter2013_stats.tsv'...
* Frequency data for 472,748 words loaded.
* 2 file(s) to check.
* Reading 'texter/kort2.txt'' and looking for unknown words...
* Found 7 unknown words.
* Saving report to kort2_report.txt
* Reading 'texter/6cyyy-2019.txt' and looking for unknown words...
* Found 9 unknown words.
* Saving report to 6cyyy-2019_report.txt

Utskrift av rapporten för kontrollen av texten kort2.txt:

$ cat kort2_report.txt
Spell check for 'texter/dev/kort2.txt' took 2.08 seconds.

[line 2] högga: höga, högre, hög
[line 2] tråts: trots, från, två
[line 4] totalförstörelse: totalförstördes, totalförsvarets, spelförståelse
[line 6] säjer: säger, det, som
[line 7] gallet: fallet, allt, gäller
[line 9] huvudtornen: huvudrollen, huvudstaden, huvudpersonen
[line 10] redda: rädda, redan, enda
[line 11] klocktornen: koncernen, flickorna, konkursen
[line 14] uppeges: uppges, uppger, precis
[line 16] visadee: visade, visar, vidare
[line 17] himle: himlen, ville, timme

Utskrift av rapporten för kontrollen av texten 6cyyy-2019.txt:

$ cat 6cyyy-2019_report.txt
Spell check for for 'texter/6cyyy-2019.txt' took 1.75 seconds

[line 1] civilingenjörsprogram: civilingenjörsstudent, viktminskningsprogram, privatiseringsprogram
[line 14] matematikgrund: matchavgörande, stigmatisering, hatbrottsgrupp
[line 17] masterprofiler: batteriproblem, ministerposter, rasprofilering
[line 20] ämnesmässig: spelmässigt, skilsmässan, skilsmässor
[line 26] masterprofiler: batteriproblem, ministerposter, rasprofilering
[line 45] teoritung: teoretisk, searching, retoriken
[line 66] biofysiker: analytiker, historiker, biografier
[line 82] kvalitetsingenjör: kvalitetsansvarig, kvalitetsmärkning, kvalitetskontroll
[line 84] sensorfusion: konstruktion, konstitution, pansarfordon

• Upprepa inte tidskrävande operationer i onödan: T.ex. tar det förhållandevis lång tid att läsa in en fil, så se till att ni bara läser in ordfrekvensdata och text att analysera en gång.
• Leta efter okända ord: Ta bort skiljetecken från slutet på ord för att inte de ska uppfattas som en del av ordet. Gör även om det ord ni letar efter så att det bara består av små bokstäver.
• Inläsning av ordfrekvensdata: Strunta i ord i ordfrekvensdatat som inte bara består av bokstäver.
• Kontrollera om alla tecken är bokstäver: Strängmetoden str.isalpha() returnerar True om alla tecken i en sträng är bokstäver.
• Leta efter förslag: Ni kan behöva begränsa antalet förslag ert program letar efter för att hålla körtiden rimlig. Säg att ni letar efter förslag till ordet “exempfl” (7 bokstäver), så finns det i webbnyheter2013_stats.tsv fler än 35000 möjliga ord att välja mellan. Det är därför rimligt att begränsa antalet ord som programmet tittar på. Prova t.ex. att endast räkna ut redigeringsavståndet för de 1000 mest frekventa orden (antalet är godtyckligt och syftet är endast att få ner tiden det tar för ert program att köra)
• Använd dictionary: För att snabba upp uppslag av ordfrekvensen för ett ord, kan ni lagra dem i ett dictionary där ordet är nyckel och frekvensen är värdet.
• Dela upp datat: Ni kan samtidigt lagra ord-data i separata listor för olika ordlängder så slipper ni leta efter dessa vid varje sökning. Eftersom ni inte vet hur många ordlängder ni behöver kan ni skapa dessa vid behov och spara dem i ett dictionary där nyckeln är en ordlängd och värdet är en samling med ord av den längden.
• Utskrift med print() som inte syns på en gång: Om ni i en loop gör en utskrift, t.ex. print(value) som inte syns förrän efter loopen är färdig kan ni lägga till nyckelordsargumentet flush=True, dvs print(value, flush=True) vilket ser till att utskriften inte buffras, utan skrivs ut på en gång.

Det kortaste redigeringsavståndet mellan två ord är det minsta antalet operationer (t.ex. byt ut, lägg till, ta bort) som måste utföras för att förändra ett ord till ett annat.

En algoritm som beräknar detta (Levenshtein avståndet) finns implementerat som funkionen minimum_edit_distance i filen /courses/TDDE44/kursmaterial/laboration7/med.py som ni kan kopiera och importera in i er kod.

Väldigt frivilligt

Det kan vara roligt för den erfarne att implementera om minimum_edit_distance i något annat, snabbare, språk, t.ex. C, C++, Rust, Zig, Fortran, Perl, etc. Vi ger dock ingen support för detta eller hur man sedan kan anropa koden från Python. Tidskravet, resultat på under en minut på universitetets datorer, skall uppfyllas även när Python-implementationen ovan används.

Till denna laboration har ni möjlighet att välja mellan ordfrekvensdata som skapats från olika källor. Datat i dessa filer är tab-separerat (dvs tab-tecknet, \t, används för att separera ord och dess frekvens) och sorterat så att de mest frekventa orden kommer först. Ordfrekvenserna bygger på ordformer och inte orden i grundform, dvs att “stor” och “stora” räknas som två olika ord. Däremot har det inte gjorts någon skillnad på användning av stora eller små bokstäver. Filerna finns i /courses/TDDE44/kursmaterial/laboration7/data.

• attasidor_stats.tsv bygger på nyhetsartiklar från den lättlästa webbplatsen 8 sidor och täcker knappt 56 000 ord
• gp2013_stats.tsv bygger på texter från Göteborgs-Posten från 2013 och täcker ca 386000 ord
• gp2d_stats.tsv bygger på texter från Göteborgs-Postens helgbilaga och täcker drygt 85000 ord
• suc3_stats.tsv bygger på SUC 3.0 (Stockholm-Umeå Corpus) och täcker ca 95000 ord
• webbnyheter2013_stats.tsv bygger på nyhetstexter från olika webbsidor från 2013 och täcker ca 473000 ord

Det spelar ingen större roll vilken datakälla ni använder i denna laboration, men det kommer att påverka hur många ord som är kända/okända och hur många förslag som kan hittas (t.ex. finns det fler än 42000 ord av längden 10 i webbnyheter2013_stats.tsv).

Att det finns så här mycket data betyder att ni kan behöva begränsa t.ex. hur många ord ni slår upp redigeringsavståndet för för att programmet inte ska ta för lång tid på sig.

Ni kan använda vilka texter ni vill för att testa ert skript, men det finns några förberedda i /courses/TDDE44/kursmaterial/laboration7/texter. Filerna kort2.txt, mellan2.txt och lang2.txt innehåller diverse stavfel. Filerna kort1.txt, mellan1.txt och lang1.txt är de ursprungliga texterna.

För denna laboration kan ni använda funktionen time() i modulen time för att ta reda på hur lång tid som gått. Importera time och så kan ni använda time.time() som returnerar tiden just nu uttryckt som antalet sekunder sedan kl. 0.00, 1 januari, 1970. Spara värdet på time.time() när ni börjar er bearbetning och spara värdet på time.time() när ni är klara så är differensen antalet sekunder som gått.

Kuriosa: Unix Tick Tocks to a Billion

Det finns många strategier som kan tillämpas när det kommer till att ta fram förslag på vilket känt ord (ett ord som finns i ordfrekvensdatat) som ett okänt ord (ord i texten som inte finns med i ordfrekvensdatat) kan ersättas med.

Börja med att endast titta på kända ord som är av samma längd som det okända ordet. Dvs att programmet kan föreslå korrigering av ordet "hejsam" till "hejsan".

I mån av tid kan ni uttöka funktionaliteten på programmet så att programmet även kan föreslå korrigeringar som innebär att lägga till/ta bort bokstäver från det okända ordet. T.ex. kan föreslå korrigering av "hejsa" till "hejsan" och "hejsann" till "hejsan".

Python har en inbyggd modul som kan användas för att hantera flaggor och argument som skickas till ett skript. För att lära dig om modulen, leta efter en tutorial på webben, eller se någon av de nedanstående:

• Python HOWTOs: Argparse Tutorial
• Python for Beginners: Argparse Tutorial
• Fullständig dokumentation till argparse

I laboration 7 kan argparse användas för att definiera flaggor för att från kommandoraden bestämma t.ex.

• hur många förslag som ska tas med i rapporten
• maximala antalet förslag att räkna ut minimum edit distance på
• om rapporten ska skrivas ut i terminalen förrutom att sparas till fil
• vilken datafil som ska användas
• osv.

Exempel:

$ ./spellcheck.py --data data/datafil.tsv --num_sug 5 --print-report texter/kort1.txt