TDDE44 Programmering, grundkurs¶

Föreläsning 5.2¶

Johan Falkenjack, johan.falkenjack@liu.se¶

Föreläsningsöversikt, FÖ 5.1-5.2¶

  • Period 1 & Period 2
  • Abstrakta datatyper
  • Inkapsling
  • Objekt
  • Klasser
  • Funktioner som objekt
    • Exempel på OOP: grafiska gränssnitt
    • Exempel på OOP: undantagshantering
    • UML-diagram
  • Kodstandarder för Python: PEP8 & PEP257
  • Programmeringsmetod
    • Implementation, testning, felsökning

En mer konkret klass¶

  • Scenario: Vi vill skriva ett program som kan testa huruvida två personer har gemensamma intessen.
  • Vilka klasser kan vi tänka oss här?
  • Person?
  • Interest?

Klassen Person¶

In [1]:
class Person:
    
    def __init__(self):
        self._interest = None 
In [2]:
class Person:
    
    ...

p = Person()
print(type(p))
<class '__main__.Person'>
  • Notera att vi döpte klassen till Person, inte person. Bara Pythons inbyggda klasser inleds med liten bokstav.

Klassen Person: Initiering av attribut¶

  • Vilka egenskaper behöver Person ha?
In [3]:
class Person:
    
    def __init__(self):
        self._interest = None 
        
    def set_interest(self, interest):
        if isinstance(interest, str):
            self._interest = interest
            
    def get_interest(self):
        return self._interest
In [4]:
class Person:
    
    def __init__(self):
        self._interest = None

Klassen Person: Beteenden och metoder¶

  • Vilka beteenden behöver Person ha?
In [5]:
class Person:
    
    def __init__(self):
        self._interest = None
        
    def set_interest(self, interest):
        self._interest = interest
        
    def get_interest(self):
        return self._interest
    
    def shared_interest(self, person):
        return self._interest == person.get_interest()
        
ada = Person()
ada.set_interest('programming')
print(ada.get_interest())
programming
  • Lägg till intresse till person ada
    • ada.set_interest('Bernoulli numbers')
  • Ta reda på om en person ada och en person charles matchar
    • ada.share_interest(charles)
    def set_interest(self, interest):
        self._interest = interest
        
    def get_interest(self):
        return self._interest
        
    def share_interest(self, other):
        return self._interest == other.get_interest()

Klassen Person: Testkörning¶

In [6]:
# Tester
annie = Person()
annie.set_interest('rocketry')
grace = Person()
grace.set_interest('compilers')
margaret = Person()
margaret.set_interest('rocketry')

print(f"{annie.shared_interest(grace)=}")
print(f"{annie.shared_interest(margaret)=}")
annie.shared_interest(grace)=False
annie.shared_interest(margaret)=True
annie = Person()
annie.set_interest('rocketry')
grace = Person()
grace.set_interest('compilers')
margaret = Person()
margaret.set_interest('rocketry')
margaret.share_interest(annie)
  • Annie Easley, en av NASAs första svarta anställda, utbildade sig till matematiker och programmerare innan "programmerare" ens var ett etablerat begrepp. Genomförde många av de grundläggande beräkningarna för NASAs raketer.

  • Grace Hopper, vice-amiral och pådrivande för att program skulle skrivas i något som liknade mänskligt språk, tidig pionjär inom kompilatorteknik.

  • Margaret Hamilton, programmeringschef för Apollo-landaren på NASA.

  • ~Adele Goldberg, objektorienteringspionjär och var en av drivkrafterna bakom Smalltalk-80, ett av de första objektorienterade programmeringsspråken och hennes arbete ligger till grund för de fönstersystem som används i de flesta moderna operativsystemen.~

Namngivning¶

  • Namn ska hjälpa läsaren förstå koden. Undvik intetsägande namn.

  • Namngivning av klasser: substantiv i singular, använd CamelCase
  • Namngivning av metoder: verb, använd snake_case
  • Namngivning av instansvariabler: substantiv, använd snake_case

  • Om klassen representerar en samling objekt, dvs fungerar som en behållare använd fortfarande singular, men lägg till ett suffix, t.ex. Collection, Set eller List

Exempel på klassnamn¶

  • DataPoint
  • DataPointCollection
  • Word
  • Sentence
  • Paragraph
  • Document
  • Person
  • ContactList
  • Book
  • Library
  • BookCollection

Vanliga prefix till metodnamn¶

  • Använd samma prefix för metoder som gör liknande saker.
  • get_*: använd för metoder som returnerar ett värde från ett objekt (antingen beräknat eller direkt från ett attribut). T.ex. .get_max(), .get_friendlist()
  • set_*: använd för metoder som tar emot argument och lagrar dessa i objektet.
    • T.ex. .set_filename(filename)
  • add_: använd för metoder som tar emot argument och lägger till dessa till
    • objektet. T.ex. .add_friend(name)
  • remove_: använd för metoder som tar bort data från ett objekt.
    • T.ex. .remove_last_task()
  • load_: använd för metoder som laddar data från fil. T.ex. .load_data(filename)
  • save_: använd för metoder som sparar data till fil. T.ex. .save_data()

* Generellt sett bör man undvika "getters" och "setters" då de bryter inkapslingen och abstraktionen som är själva poängen med OOP, men ibland är de oundvikliga.

Magic methods i Python


No description has been provided for this image via GIPHY
  • Python-klasser kan implementera vissa specialmetoder som inte anropas direkt utan med hjälp av andra språkliga konstruktioner, dessa kallas för magic methods.
  • Eftersom Python använder double underscore (t.ex. __init__) för att indikera dessa kallas de ibland också för dundermetoder.

__str__¶

  • Efter __init__ är __str__ antagligen den vanligast förekommande dundermetoden.
  • Metoden __str__ beskriver strängrepresentationen av ett objekt.
  • __str__ anropas automatiskt av funktionen print eller "halvmanuellt" genom att skapa en ny sträng-instans med str och skicka med objektet som argument.
  • Exempel:
In [7]:
class Queue:
    
    def __init__(self):
        self._storage = []
        
    def enqueue(self, value):
        self._storage.append(value)
        
    def dequeue(self):
        if self._storage:
            return self._storage.pop(0)
    
    def __str__(self):
        return f"(Queue: {str(self._storage)})"


q = Queue()
print(q)
(Queue: [])

Andra dundermetoder¶

  • För att definiera hur objekt översätts till sanningsvärden:
    • obj and True → obj.__bool__() and True
  • För att möjliggöra uppslagning med subskript:
    • obj['name'] → obj.__getitem__('name')
  • För att göra det möjligt att iterera över innehållet i ett objekt:
    • for element in obj: → for element in obj.__iter__():
  • För att definiera beteendet hos operatorer, t.ex.
    • obj / 2 → obj.__div__(2)
    • obj == 2 → obj.__eq__(42)
    • obj += 1 → obj.__iadd__(1)

Implementera operatorer för Queue¶

  • Säg att vi vill kunna lägga till nya element i kön genom att använda +=-operatorn:
In [8]:
class Queue:
    
    def __init__(self):
        self._front = None
        self._back = None
        
    def __iadd__(self, value):
        self.enqueue(value)
        return self

    def enqueue(self, value):
        element = {'value': value, 'next': None}
        if self._back is None:
            self._front = element
            self._back = element
        else:
            self._back['next'] = element
            self._back = element
        
    def dequeue(self):
        if self._front is not None:
            value = self._front['value']
            if self._front['next'] is None:
                self._front = None
                self._back = None
            else:
                self._front = self._front['next']
            return value

q = Queue()
q += 'Ada'
q = q.__iadd__('Ada')
string = "Mitt namn är "
string += "Johan"
print(string)
q += 'Bertil'
q += 'Cecilia'
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
q += 'David'
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
Mitt namn är Johan
q.dequeue()='Ada'
q.dequeue()='Ada'
q.dequeue()='Bertil'
q.dequeue()='Cecilia'
q.dequeue()='David'

Men vänta lite...¶

  • Vår ursprungliga implementation av Queue:
In [9]:
class Queue:
    
    def __init__(self):
        self._storage = []
        
    def enqueue(self, value):
        self._storage.append(value)
        
    def dequeue(self):
        if self._storage:
            return self._storage.pop(0)
        else:
            return None

q = Queue()
print(q)
<__main__.Queue object at 0x7ff844db3c40>

Varför får vi inte AttributeError?¶

  • Vi sa att print automatiskt anropar __str__, men Queue har ju ingen __str__-metod.
In [11]:
q = Queue()
print(q.__str__())
<__main__.Queue object at 0x7ff844db3ca0>
In [12]:
q = Queue()
print(q.__str__)
print(q.__tjohej__)
<method-wrapper '__str__' of Queue object at 0x7ff844db1690>
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
Cell In[12], line 3
      1 q = Queue()
      2 print(q.__str__)
----> 3 print(q.__tjohej__)

AttributeError: 'Queue' object has no attribute '__tjohej__'

Varifrån kommer __str__-metoden Queue?¶

Klassen Queue ärver metoden __str__ från sin basklass, object¶

Arv - ett sätt att återanvända kod¶

Översikt (vi kommer inte arbeta mycket med arv i denna kurs, men det är viktigt att känna till)

Arv¶

  • Arv är inte en absolut nödvändig del av objektorientering* men har historiskt betraktats som en central komponent av OOP i t.ex. Python, C++, Java, C#, Swift, JavaScript och Objective-C
    • * kritiken har funnits länge och moderna uppstickare som Rust och Go har valt bort arv helt
  • Arv låter oss skapa härledda klasser (även kallade för subklasser).
  • En härledd klass ärver alla attribut från en eller flera basklasser (även kallad superklasser), men kan utöka eller ersätta dessa.

Definiera en subklass¶

  • Python för bok över vilka klasser som finns. Varje klass lagras i en hierarki av klasser.
  • Klasshierarkin finns för att vi ska kunna återanvända kod som besläktade datatyper har gemensamt
  • För att definiera en klass använder vi nyckelordet class följt av ett namn, samt ett parentespar med den nya klassens basklass.
  • Anges ingen basklass kommer klassen object användas som basklass.
class Queue:
    pass
  • Samma som:
class Queue(object):
    pass

Klassen object¶

  • Pythons mest fundamentala basklass. Alla andra klasser ärver, i något ändligt antal steg, från object.
  • Vi har sett kod ärvd från object köras.
    • Innan vi skapade Queue.__str__ användes object.__str__ när vi skrev ut Queue-objekt.
    • Det var object.__str__ som returnerade '<__main__.Queue object at 0x0000021A9813B250>'
  • När vi skapade Queue.__str__ så överskuggade vi den ärvda __str__-metoden från object

Vad ärver man av object?¶

In [13]:
class Queue:
    
    def __init__(self):
        self._storage = []
        
    def enqueue(self, value):
        self._storage.append(value)
        
    def dequeue(self):
        if self._storage:
            return self._storage.pop(0)
    
    def __str__(self):
        return f"(Queue: {str(self._storage)})"

q = Queue()
print(dir(q))
['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_storage', 'dequeue', 'enqueue']

Exempel: Queue med list som basklass¶

class QueueList(list):
    
    def enqueue(self, value):
        self.append(value)
        
    def dequeue(self):
        if self:
            value = self[0]
            del self[0]
            return value
  • Bara för att man kan göra något så betyder det inte att man ska.
In [14]:
class Queue(list):
    
    def enqueue(self, value):
        self.append(value)
        
    def dequeue(self):
        if self:
            value = self[0]
            del self[0]
            return value
        
# Tests
q = Queue()
q.enqueue('Ada')
q.enqueue('Bertil')
q.enqueue('Cecilia')
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
q.enqueue('David')
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
print(f"{q.dequeue()=}")
q.dequeue()='Ada'
q.dequeue()='Bertil'
q.dequeue()='Cecilia'
q.dequeue()='David'
q.dequeue()=None

Mellanspel: Funktionsobjekt och högre ordningens funktioner¶

Funktionsobjekt¶

  • Alla värden (data) är objekt i Python.
  • Definierade funktioner är också en typ av värden, alltså också en typ av objekt.
  • Objekt av klassen function.
In [15]:
def hejsan():
    print("Hejsan")

print(type(hejsan)) 
<class 'function'>

Funktionsobjekt¶

  • Klasser kan instansieras och producera objekt
  • I Python är även funktioner objekt.
  • En funktion:
def hejsan():
    print("Hejsan")
  • Ett funktionanrop: hejsan()
  • Funktionsobjektet: det som namnet hejsan refererar till

Exempel på funktionsobjekt¶

In [16]:
def print_hello():
    print("Hello World!")
    
bacon = print_hello
bacon()
Hello World!
  • I koden ovan refererar både print_hello och bacon till samma funktionsobjekt.

Högre ordningens funktioner¶

  • Funktioner som antingen tar emot en funktion som argument eller returnerar en funktion kallas högre ordningens funktioner.
    • Mer generellt, högre ordningens funktioner är funktioner som opererar på funktioner.
  • Exempel på användning
    • Pythons inbyggda funktioner sum(), max(), min() m.fl. kan ta emot ett nyckelordsargument med en funktion som plockar fram det värde som ska användas.

Exempel¶

In [29]:
def second(values):
    return values[1]

value_pairs = [ ["Ada", 3], ["Bertil", 2], ["Cissi", 7] ]

print("Högst poäng:", max(value_pairs, key=second))
print("Lägst poäng:", min(value_pairs, key=second))
print("Sorterat baserat på poäng:", sorted(value_pairs, key=second))
Högst poäng: ['Cissi', 7]
Lägst poäng: ['Bertil', 2]
Sorterat baserat på poäng: [['Bertil', 2], ['Ada', 3], ['Cissi', 7]]

Introduktion till klassdiagram i UML¶

UML - Unified Modelling Language¶

  • Ett sätt att grafiskt representera system, t.ex. datorprogram, hur de är uppbyggda och fungerar
  • UML definierar en uppsjö av olika diagram i tre grova kategorier för att beskriva olika aspekter
    • Strukturdiagram, beskriver hur ett system är uppbyggt.
    • Beteendediagram, beskriver hur olika processer sker i systemet.
    • Interaktionsdiagram, beskriver hur en användare interagerar med systemet.
  • I sin striktaste form, nästintill ett eget programmeringsspråk.
    • Används dock ofta mer informellt för att illustrera specifika saker, och då utelämnas detaljer som inte behövs i det fallet

Klassdiagram¶

  • Klassdiagram beskriver klasser och deras relationer till varandra.
  • En typ av strukturdiagram på relativt låg abstraktionsnivå.
  • En av de vanligaste typerna av UML-diagram att stöta på.
  • En enskild klass i ett klassdiagram ritas som till höger.

Klassdiagram¶

  • Ofta anger vi datatyper där det är praktiskt.

Book — en klass för böcker¶

In [19]:
class Book:
    
    def __init__(self, title):
        self.title = title
        self.author = "Unknown"
        self.year = None

    def print_citation(self):
        if not self.year:
            year = "N/A"
        else:
            year = self.year
        print(f"{self.author}. ({year}). {self.title}")
        
b = Book("Sagan om ringen")
b.author = "J. R. R. Tolkien"
b.year = 1954
b.print_citation()
J. R. R. Tolkien. (1954). Sagan om ringen

Book-klassen, UML-diagram¶

  • Här anger vi datatyp även i konstruktorns parameterlista

Klassdiagram, Laboration 5, Del 1


No description has been provided for this image
No description has been provided for this image
  • Ofta utelämnar vi konstruktorn helt men här har vi tagit med den.

Grafiska gränssnitt med tkinter¶

Programflöde: GUI¶

  • GUI = Graphical User Interface
  • Icke-linjär interaktion, händelsestyrt
  • Reaktivt gränssnitt - tät återkoppling
  • Interaktion t.ex. via mus och tangentbord
  • Interaktion med en begränsad och standardiserad uppsättning widgets (oftast)

Om modulen tkinter¶

  • Lastgammal, men...
  • Det enda biblioteket för att bygga GUI-applikationer i Pythons standardbibliotek (dvs. det är inbyggt).
    • Långt ifrån det enda biblioteket/ramverket för att bygga GUI-applikationer i Python.
  • Python-wrapper för Tcl/Tk, ett GUI-bibliotek som sträcker sig tillbaka till början av 90-talet och som kan användas från massor olika programmeringsspråk.
    • Tcl, uttalat "tickle", är ett programmeringsspråk som främst lever kvar genom Tk.
  • Widgets är definierade som klasser: faktiska gränssnittskomponenter är instanser av klasserna.
  • Olika inställningar kan ges när man skapar en widget.
  • Widgets kan placeras i ett GUI på tre sätt - det finns tre "geometry managers" (i andra ramverk också kallade för "layout managers").

Widgets¶

Litet exempel¶

In [20]:
import tkinter as tk
import random

def clicked():
    colors = [("red", "white"), ("green", "black"), ("blue", "white")]
    bg_color, fg_color = random.choice(colors)
    label.config(bg=bg_color, fg=fg_color, text="button clicked")

def mouse_enter(event):
    label.config(text="mouse over")

def mouse_leave(event):
    label.config(text="mouse exit")

# skapa ett Tk-fönster
root = tk.Tk()

# skapa label-widget
label = tk.Label(root, text="Hello!")
label.pack(fill=tk.X)

# koppla ihop händelser med funktioner. OBS! Funktionsobjekt som argument.
label.bind("<Enter>", mouse_enter)
label.bind("<Leave>", mouse_leave)

# skapa knappen. OBS! Funktionsobjekt som argument
button = tk.Button(root, text="Press Me!", command=clicked)
button.pack(fill=tk.X)

# starta GUI-loopen
root.mainloop()

Laboration 5¶

  • Del 1: syntax för att skapa och använda klasser
  • Del 2: använda objekt + öva på att skriva kommentarer, följa kodstandarder

Del 2¶

No description has been provided for this image
  • Kodskelett: random-layout.py
  • Gränssnitt: lab5.py

  • Syftet är inte att ge en introduktion till hur moderna GUI-ramverk fungerar.

random-layout.py¶

In [21]:
%%python
#!/usr/bin/env python3
"""Laboration 5 -- TDDE44

Exempel på slumpmässig layout-funktion. Layout-funktionen skickas som
argument när en instans av lab5.LayoutTester skapas.
"""

# Läs denna fil för att se hur gränssnittet skapats.
import lab5
import random

def random_layout(squares, frame_height, frame_width):
    """Placera ut fyrkanterna i listan squares slumpmässigt.
    Argument:
    squares -- Lista som innehåller tkinter.Label-objekt
    frame_height -- Höjden (int) på den Fram som fyrkanterna ligger i
    frame_width -- Bredden (int) på den Frame som fyrkanterna ligger i
    """
    # Slumpa ut positioner för alla fyrkanter utan att de hamnar utanför framen
    for square in squares:
        square_size = square.winfo_width()
        xpos = random.randint(0, frame_width - square_size)
        ypos = random.randint(0, frame_height - square_size)
        square.place(x=xpos, y=ypos)
        
if __name__ == "__main__":
    layout_tester = lab5.LayoutTester(random_layout)
    

Undantag (Exceptions)¶

Exempel på kod som utlöser undantag¶

In [22]:
# Exempel 1
number = 5
name = "Ada"
print(number + name)
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
Cell In[22], line 4
      2 number = 5
      3 name = "Ada"
----> 4 print(number + name)

TypeError: unsupported operand type(s) for +: 'int' and 'str'
In [23]:
# Exempel 2
ans = 5 / (42 * 0)
---------------------------------------------------------------------------
ZeroDivisionError                         Traceback (most recent call last)
Cell In[23], line 2
      1 # Exempel 2
----> 2 ans = 5 / (42 * 0)

ZeroDivisionError: division by zero
In [24]:
# Exempel 3
printt("Hello world")
    
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
Cell In[24], line 2
      1 # Exempel 3
----> 2 printt("Hello world")

NameError: name 'printt' is not defined

Exception - exempel på OOP¶

  • Varje typ av undantag är definerad som en klass i Python
  • När ett undantag inträffar skapas en instans av den undantagstypen
  • Undantaget innehåller information om vad som hänt (data)

Undantag - Exceptions¶

  • Undantag (eng. Exception) är ett sätt att hantera fel i kod som kan utlösas (eng. throw/raise) när ett program kör (körfel).
  • Vid fel kan ett undantag utlösas. Programmet avbryter sitt normala flöde för att gå in i "undantagsläge".
  • Om kod för att hantera ett undantag saknas, kraschar programmet.
  • Skillnad mot if/else:
    • Villkor: if/else - kontrollera först, utför sen
    • Undantagshantering: try/except - utför först, hantera ev. fel
  • Undantag ska inte ses som ett alternativ till villkorssatser utan just som ett sätt att hantera undantag.

Exempel på olika undantag i Python¶

  • ZeroDivisionError: inträffar när man försökt dividera ett tal med 0
  • IOError: inträffar t.ex. om man försöker öppna en fil som inte finns
  • IndexError: inträffar när man använder ett ogiltigt index för en specifik lista
  • KeyError: inträffar när man försöker komma åt värdet för en nyckel som inte finns i ett dictionary
  • TypeError: inträffar t.ex. när man försöker använda operatorn + på en sträng och ett heltal

Hantera undantag i Python¶

  • Om man vill hantera undantag i Python lägger man koden som kan utlösa undantag i ett try-block.
  • Undantag hanteras sedan i ett except-block.
  • Vid behov kan ett finally-block kan läggas till sist. Koden i detta block körs sist och alltid; dvs efter felfritt utförande av try-blocket samt efter att något except-block uförts.
  • Minst ett except-block, eller ett finally-block måste defineras för varje try-block.

Mönster för undandagshantering i Python¶

# nyckelordet try används för att påbörja ett try-block
try:
    # här lägger man koden som kan utlösa ett undantag
    # "försök utföra dessa satser"

# nyckelordet except används för att påbörja ett except-block
except [typ av undantag] [as <namn på undantagsinstans>]:
    # här lägger man koden för vad som ska hända vid undantag

except [typ av undantag] [as <namn på undantagsinstans>]:
    # flera olika typer av undandtag kan hanteras
    # genom att lägga till flera except-block

# koden i finally-blocket utförs både efter felfritt try-block
# och efter except-block körts vid fel i try-block
finally:
    # kod för att städa upp, t.ex. stänga fil eller nätverks-
    # anslutning

Hakparenteserna ska inte skrivas ut, de visar att det som står innanför dem är valfritt att skriva. Det som står inom mindre än/större än-tecken måste vara med. Mindre än/större än-tecknena ska inte heller skrivas i din kod.

Hakparenteserna ska inte skrivas ut, de visar att det som står innanför dem är valfritt att skriva. Det som står inom mindre än/större än-tecken måste vara med. Mindre än/större än-tecknena ska inte heller skrivas i din kod.

Exempel: Fånga inte undantag alls¶

In [25]:
# krasch.py
# Exempel på kod som kraschar
letters = ["a", "b", "c", "d", "e", "f"]

index = 0
while True:
    print(f"letters[index]: {letters[index]}")
    index += 1
print("Program done.")
letters[index]: a
letters[index]: b
letters[index]: c
letters[index]: d
letters[index]: e
letters[index]: f
---------------------------------------------------------------------------
IndexError                                Traceback (most recent call last)
Cell In[25], line 7
      5 index = 0
      6 while True:
----> 7     print(f"letters[index]: {letters[index]}")
      8     index += 1
      9 print("Program done.")

IndexError: list index out of range

Exempel: Fånga alla typer av undantag¶

In [ ]:
# undantag1.py
# Undantag hanterat, kraschar inte
letters = ["a", "b", "c", "d", "e", "f"]

try:
    index = 0
    while True:
        print("letters[index]: {}".format(letters[index]))
        index += 1
    print("Loop done.")
except:
    print("An exception was raised.")
print("Program done.")
  • Notera att detta inte är något man bör göra i verkligheten.
  • Per definition svårt att göra riktiga exempel, då förväntade undantag inte är några verkliga undantag.

Exempel: Fånga alla typer av undantag och skriv ut felmeddelandet¶

In [ ]:
# undantag2.py
letters = ["a", "b", "c", "d", "e", "f"]
try:
    index = 0
    while True:
        print(letters[index])
        index += 1
# Om undantag inträffar kommer variabeln error referera till en
# instans av klassen Exception
except Exception as error:
    print("An exception was raised.")
    print(error)
print("Program done.")

Exempel: Fånga och hantera olika typer av undantag på olika sätt¶

In [ ]:
# undantag3.py
import random

def run_until_exception():
    values = ["a", 2, "c", 4, "e", "f"]
    try:
        while True:
            # slumpa fram två index som ev. kan vara ogiltiga
            index1 = random.randint(0, len(values))
            index2 = random.randint(0, len(values))
            # använd operatorn +. Fel om operanderna inte är samma datatyp.
            print(f"{values[index1]} + {values[index2]} -> {values[index1] + values[index2]}")
    except TypeError as exception:
        print(f"TypeError: {exception}. Tried {values[index1]} + {values[index2]}")
    except IndexError as exception:
        print(f"IndexError: {exception}, {len(values)=}, {index1=}, {index2=}")

run_until_exception()
print("Program done.")

Anledningar till att använda undantag istället för villkorssatser¶

  • Man skriver ett bibliotek som andra programmerare ska använda och man vill lämna vissa beslut till dem.
  • Ibland kan man inte förebygga fel, t.ex.
    • filen fanns först, men sedan tog någon bort den
    • vi har en fungerande internet-anslutning, men den dör medan programmet kör
  • Läsbarhet, i de få fall där en korrekt villkorssats blir oläslig kan det vara enklare att använda ett undantag. Detta är i sig ett undantag! I 99 fall av 100 bör förväntade omständigheter hanteras med villkorssatser.

  • I denna kurs är det inget krav att hantera fel med hjälp av undantag.
  • Överanvändning av undantag kan tvärt om ge komplettering på labbarna.

Kodstandarder¶

PEP 8 & PEP 257¶

Kodstandarder¶

  • Ökad läsbarhet och lättare att orientera sig i koden
  • Lättare att underhålla kod

  • För Python är PEP 8, PEP 257 och PEP 287 de policy-dokument som har med kodstandard och dokumentation av kod.
  • Vi koncentrerar oss på PEP 8 och PEP 257
    • https://www.python.org/dev/peps/pep-0008/
    • https://www.python.org/dev/peps/pep-0257/

Krav på PEP 8 och PEP 257¶

  • Från och med laboration 5 kommer det att vara krav på att den kod ni skriver följer PEP 8 och PEP 257.
  • För att underlätta kontroll av att er kod följer dessa kan ni antingen
    • installera ett plugin till er texteditor som kontrollerar PEP 8 och PEP 257 medan ni skriver er kod, eller
    • installera paket pycodestyle som används för att kontrollera PEP 8 och paketet pydocstyle som används för att kontrollera PEP 257

PEP 8¶

  • Radlängd, indentering och whitespace
    • Indentering: 4 mellanslag
    • Radlängd: 79 tecken
    • Rader bryts på rätt sätt med rekommenderad indentering
    • Två tomma rader mellan funktioner
    • En tom rad mellan metoder
  • Namnkonventioner för variabelnamn, funktionsnamn, klassnamn

PEP 257¶

  • Konventioner för docstrings
  • Docstrings används för att dokumentera moduler, klasser, metoder och funktioner
  • Skriv det som är viktigt för den som ska använda modulen/klassen/metoden/funktionen.
  • Börjar och slutar med tre citationstecken (""")
  • Skrivs på följande ställen
    • först i en modul
    • raden efter class Klassnamn(object):
    • raden efter def funktionsnamn(): eller def metodnamn():

Utformning av en docstring¶

  • Två varianter:
    • docstring som endast använder en rad
    • docstring som använder flera rader
  • Docstring på en rad
    • en mening som slutar på punkt
    • ska vara formulerad i imperativ (som en "order")
  • Exempel
    • OK: """Returnera alla udda tal i argumentet value_list."""
    • Inte OK: """Funktionen returnerar alla udda tal i argumentet value_list"""

Docstring på flera rader¶

  • Sammanfattande en-radsbeskrivning som första rad.
    • Formuleras på samma sätt som en docstring på en rad.
  • En tom rad, följt av resterande docstring-rader.
  • Avslutande trippel-citationstecknena skrivs på en egen rad.
  • Ingen tom rad mellan avslutande trippel-citationstecken och första raden kod.

Detaljnivå på docstrings¶

  • En docstring är till för användare av modulen/klassen/funktionen/metoden.
  • I den sammanfattande första meningen är syftet att berätta vad som görs, inte hur det görs.
  • Exempel på "vad"-beskrivning (bra):
    • Returnerar en sorterad lista med innehållet från value_list.
  • Exempel på "hur"-beskrivning" (dåligt):
    • Använder en temporär lista för att lagra alla element som tupler som innehåller elementet som en sträng följt av det faktiska elementet innan de sorteras med hjälp av en bubbelsort

Användning av docstrings kontra inlinekommentarer¶

  • Docstrings är till för att läsas av personer som vill veta hur de ska använda modulen/klassen/metoden/funktionen.
  • Inline-kommentarer (som börjar med #) är till för personer som utvecklar/underhåller modulen/klassen/metoden/funktionen.

Automatisk kontroll av PEP8 & PEP257¶

  • Kommandoradsverktyg
    • pycodestyle för att kontrollera PEP8
    • pydocstyle för att kontroller PEP257
  • Tillägg för "linting" i Visual Studio Code

  • Mer information på kurshemsidan
    • https://www.ida.liu.se/~TDDE44/tips-och-resurser/pep/
    • https://www.ida.liu.se/~TDDE44/tips-och-resurser/vscode2/

Testning och felsökning¶

Att testa sin kod¶

  • Testdriven programmering - utanför omfånget för denna kurs
  • Vi använder spårutskrifter och ipythons interaktiva läge.
  • Vad borde funktionen/metoden returnera? Gör den det?

  • Interaktivt läge: ipython3 -i <filnamn>
  • Kommandon:
    • ls, cd, cat etc. fungerar i ipython
    • %run <filnamn> - kör fil
    • %reset - rensa minnet från användarens variabler
  • Ctrl-D för att avsluta (Ctrl-D är även kontrolltecknet för EOF, end-of-file)

Använda python interaktivt¶

  • Anropa funktioner, skapa instanser av klasser från fil(er) som laddats in i minnet.
  • Allt man kan göra från en textfil.
  • Kom dock ihåg att allt ligger kvar i minnet:
    • globala variabler
    • moduler som laddats in
    • funktioner som definierats
    • etc.

Rätta buggar¶

  • syntaxfel
  • runtime-fel (inträffar under körning)
  • logiska fel

Övning¶

  • Reparera flatten_and_sort_without_duplicates
  • Ska platta till, sortera och ta bort dubletter från en nästlad lista med siffror (högst två nivåer)
  • T.ex. [[2], 1, 3, [3, 2]] → [1, 2, 3]

  • https://trinket.io/python3/10b5ddc7a4

Kod. https://trinket.io/python3/10b5ddc7a4¶

In [ ]:
def flatten_and_sort_without_duplicates(list):
    """Return flattened and sorted values of list without duplicates."""
    # flatten contents of list, i.e. [1, [2]] -> [1, 2]
    new = []
    for e in list:
        if type(e) == list:
            for e2 in e:
                new.append(e2)
       else:
            new.append(e)

    # sort values in new, [2, 3, 1, 3] -> [1, 2, 3, 3]
    sorted(new)

    # remove duplicates from sorted values e.g. [1, 2, 2, 3] -> [1, 2, 3]
    i = 0
    while i < len(new):
        # remove new[i] if it is equal to the subsequent value
        if new[i] = new[i+1]:
            new.remove(new[i])
        i += 1

    return new