"Off By One"-Defekte

Arbeitsschritte

Eine Heranführung an Off-By-One-Error

Off-By-One-Error, manchmal OBOE abgekürzt, gehören zu den ikonischsten Defekten in Programmen. Er tritt beim Umgang mit Integern auf: Eine Berechnung oder Abfrage ist um 1 zu groß oder zu klein.

Zu den bekanntesten Defekten dieser Art gehört der Zaunpfahlfehler. Überlegen Sie kurz: Wie lang ist ein Zaun mit 11 Zaunpfählen, bei dem alle 10 Meter ein Pfahl steckt? Wenn Sie jetzt "110 Meter" geantwortet haben, sind Sie genau in die Falle getappt. Dieser Defekt entsteht (meist und auch in diesem Beispiel) dadurch, dass die Anzahl der Elemente falsch gezählt werden, indem Anfangs- oder Endelement nicht oder zuviel mitgezählt werden. Ein Beispiel liefert auch der folgende mangelhafte Code-Schnipsel:

1
2
3
4
5

# count how many pages will be printed
firstpagenumber: int 
lastpagenumber: int

pagecount = lastpagenumber - firstpagenumber

Warum und um wie viel ist der Wert von pagecount falsch?

Die zweite wichtige Art von OBOE entsteht, wenn man den falschen Vergleichsoperator benutzt, also > mit >= oder < mit <= verwechselt. Der folgende Code prüft, ob jemand alt genug ist, um in Deutschland bei der Bundestagswahl mitzumachen (Stand 2023 ist man ab 18 wahlberechtigt). Darf jemand nach diesem Code-Schnipsel wählen, wenn die Person genau 18 Jahre alt ist?

1
2
3
4

age: int

if age > 18:
   print("Du darfst wählen!")

In Sprachen, die Arrays von 0 an indizieren, kann der Code fälschlicherweise bei dem Element mit dem Index 1 (also dem zweiten Element) beginnen. Solche Defekte werden oft als OBOE bezeichnet, aber wir klassifizieren sie separat als Indexdefekt siehe Aufgabe Indexdefekte.

Ihre Aufgabe

Im Folgenden sollen Sie eine Funktion debuggen, in der ein Off-By-One-Defekt vorliegt. Diese Funktion bekommt einen Tag im Jahr (1. Januar ist 1, 1. Februar ist 32, usw.) und gibt zurück, in welchem Monat dieser Tag liegt und welcher Tag im Monat es ist. Die Funktion bekommt als zusätzlichen Parameter noch die Information mit, ob es sich um ein Schaltjahr handelt, also ob der Februar 29 Tage hat. Wenn die Zahl außerhalb des gültigen Bereichs liegt, soll die Funktion einen ValueError auswerfen. Ihre Aufgabe liegt jetzt darin herauszufinden, wo der Defekt liegt und wie man ihn beheben kann.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

import dataclasses


@dataclasses.dataclass
class Month:
    name: str
    days: int

    def __repr__(self):
        return f"{self.name}({self.days})"


def showday(daynumber: int, isleapyear: bool) -> (str, int):
    """
    Returns the month and day for a given day number.
    daynumber: a day number within the year.
    isleapyear: True if the year is a leap year.
    Returns the month name and day,
    raises ValueError if daynumber is invalid.
    """
    monthnames = (
        "January",
        "February",
        "March",
        "April",
        "May",
        "June",
        "July",
        "August",
        "September",
        "October",
        "November",
        "December",
    )
    days = [31 for month in monthnames]  # assume all months have 31 days
    thirtylist = ("April", "June", "September", "November")
    for idx in [monthnames.index(thismonth) for thismonth in thirtylist]: # fix 30-day months
        days[idx] = 30
    days[monthnames.index("February")] = 28 + isleapyear  # fix February
    months = [Month(name=monthnames[i], days=days[i]) for i in range(len(monthnames))]  # our target data structure
    # now do the computation:
    if daynumber > 0:
        for month in months:
            if daynumber < month.days:  # the right month
                return month.name, daynumber
            daynumber = daynumber - month.days  # not the right month, subtract it and continue
    raise ValueError("invalid daynumber")

print(showday(1, False))

• Legen Sie den obigen Python-Code unter dem Namen Off-by-1-Defekte.py in Ihrem Arbeitsverzeichnis ab.
• Machen sie einen Commit Off-by-1-Defekte.py, der nur genau diese neue Datei enthält.

• Suchen Sie nun den Defekt. Hier sind einige Vorschläge für das Vorgehen:

  1. Bestimmen Sie den Zweck des Codes bis Zeile 47.
     Wie viele und welche der genutzten Variablen sind nach Zeile 47 wichtig?
     Was ist das Ziel der Nutzung dieser Variablen?
     Werden die Variablen richtig initialisiert, um dieses Ziel zu erreichen?
  2. Stellen Sie sicher, dass die Zeile 41 richtig funktioniert.
     Wie viele Eingaben benötigt diese Code-Zeile?
     Wie viele verschiedene Werte sind nötig, um diese Code-Zeile zu testen?
  3. Die Liste months überliest man leicht, weil jeder die Monate kennt.
     Aber ist sie korrekt?
  4. Eine Möglichkeit diesen Code zu prüfen ist es anzunehmen, dass daymap richtig initialisiert ist und erst ab Zeile 54 zu prüfen.
     Angenommen, Sie entscheiden sich für dieses Vorgehen und prüfen die Tage im Januar (also mit daynumber zwischen 1 und 31): Welche Werte lohnen sich besonders zum Prüfen?

• Defekt gefunden? Prima. Dann jetzt bitte in Off-by-1-Defekte.py korrigieren.
• Machen sie einen Commit Off-by-1-Defekte.py corrected, der nur genau diese Defektkorrektur enthält.
• 1 git -P show HEAD