• all kod följer PEP8-standarden
• all kod följer PEP257

Funktionskommentarer (PEP257) ska inte beskriva hur ni implementerat funktionerna, utan vad funktionerna gör och hur man använder dem (förklara argumenten).

Se Tips: Kontrollera PEP 8 och PEP 257 för tips om hur du kontrollerar för PEP8 och PEP257 automatiskt.

1. Inga variabelnamn får bestå av endast en enskild bokstav.
2. Alla satser som består av två eller fler rader ska ha en tillhörande kommentar. T.ex. if-satser och loopar. Kommentaren ska inte vara en “innantilläsning” av koden den hör till. Använd rätt kommentarsmarkering (t.ex. """ för funktions- metodkommentarer, # för kommentarer i löpande kod, se PEP8 och PEP257).

Undantag till 2. ovan är satsen som är längre än 2 rader är den enda satsen i en funktion. Där räcker funktionskommentaren.

Anmärkning: Krav 2 reflekterar inte nödvändigtvis kommentarskrav “i verkligheten” utan finns som krav i kursen för att ni ska öva er på att skriva kommentarer som förklarar kod.

Här är exempel på icke-godkänd kod:

y = 0
g = 0

# för alla element i listan, lägg till x till y
for x in [19, 21, 24, 20]:
    y += x
g = y/4

Här är en godkänd variant:

age_tot = 0
age_avg = 0
ages = [19, 21, 24, 20]

# räkna ut summan av alla åldrar
for age in ages:
    age_tot += age
age_avg = age_tot/len(ages)

Ett undantag är där x och y används för x- och y-koordinater. Om ni har olika separata objekt med egna x- och y-koordinater bör ni dock markera detta (dvs återanvänd inte samma variabelnamn för olika ändamål):

Ej godkänd kod

x = 100
y = 0
hero.set_position(x, y)
x = 500
y = 0
monster.set_position(x, y)

Godkänd kod

x = 100
y = 0
hero.set_position(x, y)

monsterx = 500
monstery = 0
monster.set_position(monsterx, monstery)

Minimera användningen av hårdkodade siffror, använd istället variabler med förklarande namn.

Variabler istället för hårdkodade värden

Som tumregel kan tänka att om ni använder samma siffra på fler än ett ställe i samma syfte, så ska ni ersätta den med en variabel.

En annan anledning att byta ut en hårdkodad siffra mot en variabel är för att enklare kunna experimentera med olika värden genom att ändra variabelvärden som samlats på ett smidigt ställe i koden.

Om ni tänker “Men det är så svårt att komma på vad vi ska döpa den till”; då borde ni även inse att det är ännu svårare för en utomstående att ens förstå vad syftet med siffran är.

Användning av hårdkodade siffervärden (även kallade för “magic numbers”) ses generellt sett som ett anti-mönster, dvs ett mönster man ska undvika. Läs mer om detta på t.ex. Wikipedia.

Exempel på kod som ej får godkänt

kontosaldo = 2000
att_betala = 500 - (500 * 0.1)
att_betala += 240 - (240 * 0.1)
kontosaldo -= att_betala

Kod som får godkänt

kontosaldo = 2000
pris_godis = 500
pris_godispåse = 240
rabatt = 0.1
att_betala = pris_godis - (pris_godis * rabatt)
att_betala -= pris_godispåse - (pris_godispåse * rabatt)
kontosaldo -= att_betala

• Dela upp er kod i delfunktioner vid behov:
  • när ni stöter på kod som ni upprepar, bryt ut koden (lägg koden i en funktion)
  • skicka nödvändig information som argument till funktionen och låt den returnera eventuellt resultat, använd inte globala variabler
  • dela även upp er kod i fler funktioner när den blir för lång

Som tumregler, försöka se till att era funktioner

• endast gör en sak
• inte är längre än 15 rader (gärna kortare) exklusive kommentarer

I den första uppgiften ska ni skapa ett fönster som innehåller en knapp. När man klickar på den knappen ska texten "Knappen funkar!" skrivas ut i terminalen.

I denna uppgift ska ni göra följande:

• Skapa ett fönster och placera ut TkInter-widgets enligt nedanstående layoutskiss. Den behöver inte vara exakt likadan med avseende på exakta storlekar, men elementens placering relativt varandra ska vara som på bilden.
• Ta fram en lösning som använder antingen geometri-hanteraren grid eller pack.
• Knapparna ska inte göra något när man klickar på dem.

Tips! Kom ihåg att ni kan gruppera widgets genom att lägga dem i en frame och sedan lägga till det Frame-objektet till huvudfönstret.

Geometri-hanterare (Geometry managers)

Det finns tre geometri-hanterare att välja mellan i TkInter. Syftet med geometri-hanterare (kallas ibland för layout-hanterare/layout managers i andra språk) är att hjälpa till och till viss mån automatisera hur och var GUI-komponenter placeras. Läs om dessa i mer detalj här:

• The Grid Geometry Manager
• The Pack Geometry Manager
• The Place Geometry Manager

Principen som används när man skapar ett GUI med TkInter är att man först skapar en widget och då kopplar ihop den med den komponent som är dess behållare. Sedan anropar den geometri-hanterar metod i widgeten som man vill använda och skickar då med de parametrar som ska tas hänsyn till när widgeten placeras ut.

I denna uppgift ska ni skapa ett fönster som har samma layout som bilden nedan. När man klickar på knappen ska ett nytt fönster skapas som innehåller ett text-fönster. Text-fönstret ska innehålla alla valda alternativ från huvudfönstret, dvs

• texten från text-fältet,
• alla markerade checkboxar,
• den valda radioknappen (endast en radio-knapp ska kunna vara vald åt gången)

Se checkbox.py, radio.py och text.py för exempelkod.

square.place(x=100, y=50)

I ovanstående exempel refererar variabeln square till en tkinter.Label-instans. I exemplet används metoden .place() med de namngivna argumenten x och y för att placera ut instansen 100 enheter från den vänstra kanten och 50 enheter från den övre kanten. Placeringen av en Label mäts från dess övre vänstra hörn. Origo i koordinatsystemet som används ligger alltså högst upp till vänster, med en y-axel som pekar nedåt, och en x-axel som pekar åt höger.

Ni ska inte använda funktionalitet från geometri-hanteraren Place (som t.ex. anchor), utan kvadraterna ska placeras ut endast med .place(x=xpos, y=ypos).

För att ta reda på hur hög en tkinter-widget är, kan man använda sig av metoden .winfo_height(). För bredden använder man .winfo_width.

# spara kvadratens höjd och bredd
square_height = square.winfo_height()
square_width = square.winfo_width()

I ovanstående kod är square ett tkinter.Label-objekt.

Er algoritm implementerar ni genom att skriva en funktion som tar in nedanstående parametrar:

• squares: Lista som innehåller tkinter.Label-objekt
• frame_height: Höjden (int) på den Frame som kvadraterna ligger i.
• frame_width: Bredden (int) på den Frame som kvadraterna ligger i.
• start_left: Värdet True betyder att kvadraterna ska placeras ut från vänster sida. Värdet False betyder att kvadraterna ska placeras ut från höger.
• start_top: Värdet True betyder att kvadraterna ska börja placeras ut uppifrån. Värdet False betyder att kvadraterna ska placeras ut från botten.

Funktionen skickar ni sedan till den gränssnittsinstans som skapas (se koden i random_layout.py som ni kan utgå ifrån).

När man klickar på knappen i gränssnittet skapas kvadraterna som ska layoutas enligt inställningarna i gränssnittet, därefter anropas den layoutfunktion som angavs när gränssnittet när det skapades. I funktionsanropet till layoutfunktionen skickar gränssnittet med listan med kvadrater, höjd, bredd, samt information från checkboxarna i gränssnittet som berättar i vilket hörn er layout-algoritm ska börja.

Döp er layout-funktion till row_layout. row_layout-algoritmen ska placera ut kvadraterna radvis. Det ska finnas mellanrum mellan de utplacerade kvadraterna. Bilden nedan visar placering som börjar från vänster och uppifrån.

• Algoritmen ska placera ut kvadraterna radvis.
• När en rad är full påbörjas en ny rad.
• Första kvadraten på varje rad placeras alltid ut i samma kolumn som den allra första kvadraten som placerades ut.
• Algoritmen ska anpassa antalet kvadrater som placeras ut på en rad till storleken på fönstret, dvs det ska inte vara ett fast antal kvadrater som placeras ut på en rad.
• Algoritmen ska endast placera ut kvadrater om de får plats i fönstret.
• Argumentet start_top bestämmer om raderna läggs ut uppifrån och ner (start_top == True) eller nerifrån och upp (start_top == False).
• Argumentet start_left bestämmer om kvadrater i en rad placeras ut från vänster till höger (start_left == True) eller från höger till vänster (start_left == False).

För en komplett lista på vilka argument som funktionen tar emot, läs avsnittet argument till layout-funktionen ovan.

Döp er layout-funktion till column_layout. column_layout-algoritmen ska placera ut kvadraterna kolumnvis. Det ska finnas mellanrum mellan de utplacerade kvadraterna. Bilden nedan visar placering som börjar från vänster och uppifrån.

• Algoritmen ska placera ut kvadraterna kolumnvis.
• När en kolumn är full påbörjas en ny kolumn.
• Första kvadraten i varje kolumn placeras alltid ut på samma rad som den allra första kvadraten som placerades ut.
• Algoritmen ska anpassa antalet kvadrater som placeras ut en en kolumn till storleken på fönstret, dvs det ska inte vara ett fast antal kvadrater som placeras ut i en kolumn.
• Algoritmen ska endast placera ut kvadrater om de får plats i fönstret.
• Argumentet start_left bestämmer om kolumner placeras ut från vänster till höger (start_left == True) eller från höger till vänster (start_left == False).
• Argumentet start_top bestämmer om kvadraterna i en kolumn läggs ut uppifrån och ner (start_top == True) eller nerifrån och upp (start_top == False).

För en komplett lista på vilka argument som funktionen tar emot, läs avsnittet argument till layout-funktionen ovan.

Döp er layout-funktion till zigzag_layout. zigzag_layout-algoritmen ska placera ut kvadrater radvis, men när den kommer till slutet av en rad ändras riktningen som kvadraterna i nästa rad läggs ut i. Det ska finnas mellanrum mellan de utplacerade kvadraterna. Bilden nedan visar placering som börjar från vänster och uppifrån.

• Algoritmen ska placera ut kvadraterna radvis.
• När en rad är full påbörjas en ny rad.
• När en ny rad påbörjas växlar utplaceringsordningen. Om föregående rad av kvadrater placerades ut från vänster till höger, placeras nästa rad av kvadrater ut från höger till vänster och vice versa.
• Första kvadraten på varje rad placeras ut i samma kolumn som den sista kvadraten på föregående rad.
• Algoritmen ska anpassa antalet kvadrater som placeras ut på en rad till storleken på fönstret, dvs det ska inte vara ett fast antal kvadrater som placeras ut i en rad.
• Algoritmen ska endast placera ut kvadrater om de får plats i fönstret.
• zigzag_layout-algoritmen lägger alltid ut rader uppifrån och ner, oavsett värde på start_top.
• Argumentet start_left bestämmer om kvadraterna i första raden placeras ut från vänster till höger (start_left == True), eller om kvadraterna i första raden placeras ut från höger till vänster (start_left == False)

För en komplett lista på vilka argument som funktionen tar emot, läs avsnittet argument till layout-funktionen ovan.

Skapa ett fönster med en liten textruta där man kan skriva in text. Nedanför textrutan ska de 5 mest frekventa orden som börjar på användarens text visas. Använd data från Temauppgift 2.

Förslagen ska uppdateras för varje förändring som sker i användarens textruta.

Tips: Använd en tkinter.Entry som användarens textruta och en tkinter.Label för att visa förslagen.

Tips: Innehållet i ett tkinter.Entry-objekt är ett StringVar-objekt. Med hjälp av metoden .trace() hos StringVar-objekt kan vi säga att en viss funktion ska köras när förändringar sker i objektet. Se The Variable Classes