Błędy (bug)

Without requirements or design, programming is the art of adding bugs to an empty text file.

• błędy leksykalne i składniowe
• błędy typowania
• błędy semantyczne i logiczne
• błędy działania
• nieskończone obliczenia

Błędy leksykalne

• pojedyncza jednostka leksykalna, której nie przewiduje definicja języka

x = 1
x++  # operator ++ nie istnieje

SyntaxError: invalid syntax

Błędy składniowe (syntax error)

• niepoprawnie zestawione poprawne jednostki leksykalne

if True                    # brakuje :
    print("Hello World"))  # dodatkowy )

SyntaxError: invalid syntax

Błędy typowania

• wyrażenie nieadekwatne do typu

x = 1

x[0] = 2  # x nie jest sekwencyjnym typem danych

TypeError: 'int' object does not support item assignment

Błędy działania (runtime error)

• pojawiają się w trakcie działania programu (np. odczyt z pliku, który nie istnieje)

def iloraz(a, b):
    """Zwraca a / b"""
    return a / b

iloraz(10, 0)  # dzielenie przez 0

ZeroDivisionError: division by zero

Błędy semantyczne (semantic error)

• niezgodność oczekiwań ze stanem faktycznym

def dzialanie(a, b, c):
    """Zwraca iloraz a przez sumę b i c."""
    return a / b + c  # zamiast a / (b + c)

Błędy logiczne

• program liczy nie to co trzeba (w tym też błędy semantyczne)
• najtrudniejsze do znalezienia

def delta(a, b, c):
    """Liczy wyróżnik trójmianu kwadratowego."""
    return b - 4*a*c  # zamiast b*b - 4*a*c

Nieskończone pętle

def loop(i = 0):
    while i < 10:
        i -= 1  # i zawsze będzie mniejsze od 10

Najdroższy myślnik w historii

• NASA (1962); Mariner 1: Floryda -> Wenus

Review Board determined that the omission of a hyphen in coded computer instructions in the data-editing program allowed transmission of incorrect guidance signals to the spacecraft.

źródło

Therac-25

• maszyna do radioterapii nowotworów
• na skutek błędów programistycznych kilka osób zmarło na skutek napromieniowania
• błąd typu race condition - przy zbyt szybkim wprowadzaniu danych (przez operatora) parametry zabiegu nie były prawidłowo inicjowane

Zapobieganie błędom

• pisanie czytelnego kodu
• code review
• debugowanie

Czytelność kodu

• zrozumiałe nazwy zmiennych (nawet kosztem długości)
• komentowanie kodu źródłowego, który nie jest zrozumiały od razu
• tworzenie dokumentacji w trakcie pisania programu
• opisywanie przyjętych założeń (w komentarzach i/lub dokumentacji)

Code review

• sprawdzenie kodu przez inną osobę

Debugowanie

If debugging is the process of removing software bugs, then programming must be the process of putting them in.

• systematyczne redukowanie błędów w kodzie
• kontrolowane wykonanie programu
• debugger

__debug__

debug.py

# __debug__ - wbudowana stała
# równa True - jeśli uruchomione bez -O (optimize)

if __debug__:
    print("Jestem w trybie debugowania.")
else:
    print("Jestem w trybie normalnym.")

python debug.py

Jestem w trybie debugowania.

python -O debug.py

Jestem w trybie normalnym.

Przykład

fib.py

"""Wyznacza pierwsze wyrazy ciągu Fibonacciego."""

fib = [0, 1]

for i in range(10):
    if not __debug__:
        print("i =", i)
        print("fib =", fib)
        print("fib[i-2] =", fib[i-2])
        print("fib[i-1] =", fib[i-1])
        print()
    
    fib.append(fib[i-2] + fib[i-1])

print(fib)  # [0, 1, 1, 2, 3, 5, 8, 13, ...]

python fib.py

[0, 1, 1, 1, 1, 2, 2, 2, 3, 4, 4, 5]

Przykład - debug mode

python -O fib.py

i = 0
fib = [0, 1]
fib[i-2] = 0
fib[i-1] = 1

i = 1
fib = [0, 1, 1]
fib[i-2] = 1
fib[i-1] = 0

i = 2
fib = [0, 1, 1, 1]
fib[i-2] = 0
fib[i-1] = 1

i = 3
fib = [0, 1, 1, 1, 1]
fib[i-2] = 1
fib[i-1] = 1

i = 4
fib = [0, 1, 1, 1, 1, 2]
fib[i-2] = 1
fib[i-1] = 1

i = 5
fib = [0, 1, 1, 1, 1, 2, 2]
fib[i-2] = 1
fib[i-1] = 1

i = 6
fib = [0, 1, 1, 1, 1, 2, 2, 2]
fib[i-2] = 1
fib[i-1] = 2

i = 7
fib = [0, 1, 1, 1, 1, 2, 2, 2, 3]
fib[i-2] = 2
fib[i-1] = 2

i = 8
fib = [0, 1, 1, 1, 1, 2, 2, 2, 3, 4]
fib[i-2] = 2
fib[i-1] = 2

i = 9
fib = [0, 1, 1, 1, 1, 2, 2, 2, 3, 4, 4]
fib[i-2] = 2
fib[i-1] = 3

[0, 1, 1, 1, 1, 2, 2, 2, 3, 4, 4, 5]

Wbudowany debugger

fib.py

import pdb  # wbudowany debugger

pdb.set_trace()  # zacznij debugować

fib = [0, 1]

for i in range(10):
    fib.append(fib[i-2] + fib[i-1])

print(fib)  # [0, 1, 1, 2, 3, 5, 8, 13, ...]

pdb

• n - następna instrukcja
• s - wejdź w funkcję
• r - wyjdź z funkcji
• p - wydrukuj zmienną
• q - przerwij
• enter - powtórz ostatnią komendę
• …

Wyjątki (exceptions)

• błędy działania (runtime error)
• wykryte podczas wykonywania są nazywane wyjątkami
• programista może decydować co robić z wyjątkami

Przykład - iloraz

def iloraz(a, b):
    """Zwraca a / b"""
    return a / b

iloraz(10, 2)

5.0

iloraz(10, 0)

ZeroDivisionError: division by zero

Iloraz - zabezpiecznie if

def iloraz(a, b):
    """Zwraca a / b lub zero, jeśli b = 0."""
    if b == 0:  # można tak, ale lepiej korzystać z wyjątków
        return 0
    return a / b

iloraz(10, 2)

5.0

iloraz(10, 0)

0

Iloraz - wyjątek

def iloraz(a, b):
    """Zwraca a / b lub zero, jeśli b = 0."""
    try:     # spróbuj
        return a / b
    except:  # jeśli error to
        return 0

iloraz(10, 2)

5.0

iloraz(10, 0)

0

Przykład - pobierz liczbę całkowitą

while True:
    try:     # spróbuj rzutować na int
        x = int(input("Podaj liczbę: "))
        break
    except:  # jeśli się nie uda to
        print("Spróbuj jeszcze raz.")

Podaj liczbę: a
Spróbuj jeszcze raz.
Podaj liczbę: 1

Typy wyjątków

• pełna lista wbudowanych wyjątków link

while True:
    try:
        x = int(input("Podaj liczbę: "))
        break
    except ValueError:  # jeśli błąd wartości
        print("Spróbuj jeszcze raz.")

Podaj liczbę: a
Spróbuj jeszcze raz.
Podaj liczbę: 1

Komunikat wyjątku

while True:
    try:
        x = int(input("Podaj liczbę: "))
        break
    except ValueError as err:  # err = komunikat błędu
        print("Spróbuj jeszcze raz, bo", err)

Podaj liczbę: a
Spróbuj jeszcze raz, bo invalid literal for int() with base 10: 'a'
Podaj liczbę: 1

Przykład

# więcej o plikach za chwilę

import sys

def read_data():
    try:
        plik = open('data.txt')  # otwórz plik
        linia = plik.readline()  # wczytaj linię
        dane = int(linia)        # rzutuj linię na int
    except IOError as err:       # IOError
        print("Błąd I/O:", err)
    except ValueError as err:    # ValueError
        print("Złe dane:", err)
    except:                      # InnyError
        print("Coś poszło nie tak...")
        sys.exit(0)

try…finally

def iloraz(a, b):
    """Zwraca a / b."""
    try:
        return a / b
    finally:  # wykonaj mimo zgłoszonego wyjątku
        print("Posprzątam bez względu na wyjątki.")

iloraz(10, 5)

Posprzątam bez względu na wyjątki.

iloraz(10, 0)

Posprzątam bez względu na wyjątki.
...
ZeroDivisionError: division by zero

try…except…finally

def iloraz(a, b):
    """Zwraca a / b lub zero, jeśli b = 0."""
    try:
        return a / b
    except:
        print("Użytkownik nie zna matematyki.")
    finally:  # wykona zawsze bez względu na wyni try
        print("Posprzątam bez względu na wyjątki.")

iloraz(10, 5)

Posprzątam bez względu na wyjątki.

iloraz(10, 0)

Użytkownik nie zna matematyki.
Posprzątam bez względu na wyjątki.

Zgłaszanie wyjątków

def iloraz(a, b):
    """Zwraca a / b."""
    if b == 0:
        raise NameError("Dzielenie przez zero.")
    return a / b

iloraz(10, 0)

NameError: Dzielenie przez zero.

try:
    iloraz(10, 0)
except NameError as err:
    print("Błąd:", err)

Błąd: Dzielenie przez zero.

Własne wyjątki

• możliwe jest definiowanie własnych wyjątków
• o tym w przyszłości, jak już poznamy klasy

assert

# assert expression jest równoważne
if __debug__:
    if not expression: raise AssertionError

assert_test.py

import sys

assert sys.argv[1] != "Python"

print("Assert test.")

assert_test

python assert.py 1           # warunek spełniony

Assert test.

python assert.py Python      # warunek spełniony

AssertionError

python -O assert.py Python  # warunek spełniony w trybie -O

Assert test.

Operacje na plikach

• do otwierania plików służy funkcja wbudowana open
• przyjmuje wiele argumentów, przy czym dwa najważniejsze to: file i mode

open(file, mode)

• file - nazwa pliku (lub pełna ścieżka, jeśli nie w katalogu roboczym)
• mode - tryb

• np. open(file, r+b) otwiera plik do odczytu, z możliwością zapisu, w trybie binarnym

Zapis do pliku

# otwórz plik do zapisu
# usuń zawartość jeśli plik istnieje
file = open("test", 'w')

file.write("0123456789")  # zapisz do pliku

file.close()              # zamknij plik

file.write("jeszcze coś") # plik już jest zamknięty

ValueError: I/O operation on closed file.

Dopisywanie do pliku

# otwórz plik do zapisu
# ustaw się na końcu pliku
file = open("test", 'a')

file.write("abcdefghij")  # zapisz do pliku

file.close()              # zamknij plik

Odczyt pliku

file = open("test", "r")  # otwórz tylko do odczytu

zawartosc = file.read()   # wczytaj całą zawartość pliku

file.close()

print(zawartosc)

0123456789abcdefghij

r+ vs a

# a (append) - zaczyna dopisywać na koniec pliku
# r+ - zaczyna zapisywać od początku (nadpisując dane)

file = open("test", "r+")  # odczyt z możliwością zapisu

file.write("." * 5)        # zapisz 5 kropek

file.close()

cat test

.....56789abcdefghij

w+ vs r+

# r+ - zaczyna zapisywać od początku (nadpisując dane)
# w+ - najpierw czyści plik (jeśli istnieje)

file = open("test", "w+")  # zapis z możliwością odczytu

file.write("." * 5)        # zapisz 5 kropek

file.close()

cat test

.....

w vs w+

file = open("test", "w")  # tylko zapis

file.write("." * 5)       # zapisz 5 kropek

zawartosc = file.read()

file.close()

print(zawartosc)

UnsupportedOperation: not readable

w vs w+

file = open("test", "w+")  # zapis z możliwościa odczytu

file.write("." * 5)        # zapisz 5 kropek

zawartosc = file.read()

file.close()

print(zawartosc) # nie wydrukuje bo jesteśmy na końcu pliku

seek

file = open("test", "w+")  # zapis z możliwościa odczytu

file.write("." * 5)        # zapisz 5 kropek

file.seek(0)               # ustaw położenie

zawartosc = file.read()

file.close()

print(zawartosc)

.....

tell

cat test

.....

file = open("test", "a+")  # dodawanie z możliwością odczytu

file.tell()                # pozycja w pliku

5

file.write("12345")  # dopisz 12345

file.tell()

10

cat test

.....12345

seek and read

cat test

.....12345

# seek(offset, punkt_odniesienia)
# po = 0, 1, 2 (początek pliku, bieżąca pozycja, koniec pliku)
# w trybie tekstowym tylko 0 jest dozwolone

file.seek(6, 0)  # o 6 znaków od początku 

file.read(1)

'2'

file.tell()  # read(n) przesuwa o n

7

Uwaga

• wygodnie jest wczytać cały plik do pamięci
  • read() - zawartość jako pojedynczy string
  • readlines() - zawartość jako lista (linia -> element)
• jednak w przypadku dużych plików może to byś katastrofalne, wtedy lepiej
  • read(n) - wczytaj n bajtów
  • readline() - wczytaj linię

Otwieranie plików a wyjątki

try:
    file = open("złe_dane")
    data = file.read() # zgłasza wyjątek
finally:               # porządek nawet w przypadku wyjątku
    print("Czyszczę śmieci.")
    file.close()

with statement

• gwarantuje, że jeśli wywołane zostało __enter__() (np. otwarcie pliku)
• to zostanie wywołane __exit()__ (np. zamknięcie pliku)
• nawet jeśli po drodze wystąpi wyjątek

with open

with open("plik_z_danymi") as file:
    data = file.read()

• gwarantuje, że plik zostanie zawsze poprawnie zamknięty
• wygodniejsze niż try…finally…