Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- modul:m323:learningunits:lu02:byreferenceinclasses [2024/08/28 09:05] – [Beispiel: Mutable Attribute in Dataclasses] kmaurizi
+++ modul:m323:learningunits:lu02:byreferenceinclasses [2024/08/28 09:42] (aktuell) – kmaurizi
@@ Zeile 20: / Zeile 20: @@
 </code>
-Diese Dataclass Person hat zwei Attribute: ''name'' und ''age''.
+Diese Dataclass ''Person'' hat zwei Attribute: ''name'' und ''age''.
 ===== By Reference bei Dataclasses =====
@@ Zeile 42: / Zeile 42: @@
     person.age += 1
-if name == 'main':
+if __name__ == '__main__':
     p = Person(name='Alice', age=30)
-    print(f'Vor der Änderung: {p}') # Output: Vor der Änderung: Person(name='Alice', age=30)
+    print(f'Vor der Änderung: {p}')  # Output: Vor der Änderung: Person(name='Alice', age=30)
     birthday(p)
-    print(f'Nach der Änderung: {p}') # Output: Nach der Änderung: Person(name='Alice', age=31)
+    print(f'Nach der Änderung: {p}')  # Output: Nach der Änderung: Person(name='Alice', age=31)
 </code>
-In diesem Beispiel wird die Instanz der Dataclass Person an die Funktion ''birthday()'' übergeben. Da Objekte ''By Reference'' übergeben werden, wird das Attribut age der Originalinstanz ''p'' direkt in der Funktion verändert.
+In diesem Beispiel wird die Instanz der Dataclass ''Person'' an die Funktion ''birthday()'' übergeben. Da Objekte ''By Reference'' übergeben werden, wird das Attribut ''age'' der Originalinstanz ''p'' direkt in der Funktion verändert.
 ===== Mutable und Immutable Attribute in Dataclasses =====
@@ Zeile 55: / Zeile 55: @@
 Python-Dataclasses können sowohl mutable als auch immutable Attribute enthalten. Unabhängig davon, ob die Attribute mutable oder immutable sind, wird die Dataclass selbst immer ''By Reference'' übergeben.
-==== Beispiel: Mutable Attribute in Dataclasses ====
+==== Problem: Mutable Default Values ====
+Ein häufiges Problem bei der Verwendung von mutable Objekten (wie Listen) in Dataclasses ist, dass alle Instanzen der Dataclass denselben Standardwert teilen können, wenn dieser direkt als Default-Wert gesetzt wird. Dies kann zu unerwartetem Verhalten führen.
+<code python>
+from dataclasses import dataclass
+@dataclass
+class Student:
+    name: str
+    grades: list = []
+# Problem: Alle Instanzen teilen sich dieselbe Liste.
+if __name__ == '__main__':
+    student1 = Student(name='Alice')
+    student2 = Student(name='Bob')
+    student1.grades.append(90)
+    print(student2.grades)  # Output: [90] - Dies ist wahrscheinlich nicht das gewünschte Verhalten
+</code>
+In diesem Beispiel teilen sich alle Instanzen der Dataclass ''Student'' die gleiche Liste ''grades'', da der Standardwert direkt gesetzt wurde. Wenn eine Note zu einer Instanz hinzugefügt wird, beeinflusst dies auch alle anderen Instanzen.
+==== Lösung: Verwendung von `field(default_factory=list)` ====
+Um dieses Problem zu lösen, verwendet man in Dataclasses für mutable Standardwerte wie Listen die Funktion `field` mit dem Parameter `default_factory`. Dadurch wird sichergestellt, dass jede Instanz ihre eigene Liste erhält.
 <code python>
 from dataclasses import dataclass, field
-from typing import List
 @dataclass
 class Student:
     name: str
-    grades: List[int] = field(default_factory=list)
+    grades: list = field(default_factory=list)
-def add_grade(student: Student, grade: int):
+if __name__ == '__main__':
-    """
+    student1 = Student(name='Alice')
-    Adds a grade to the student's grade list.
+    student2 = Student(name='Bob')
-    """
-    student.grades.append(grade)
-if name == 'main':
+    student1.grades.append(90)
-    s = Student(name='Bob')
+    print(student2.grades)  # Output: [] - Jede Instanz hat ihre eigene, unabhängige Liste
-    print(f'Vor der Änderung: {s.grades}') # Output: Vor der Änderung: []
-    add_grade(s, 90)
-    print(f'Nach der Änderung: {s.grades}') # Output: Nach der Änderung: [90]
 </code>
-In diesem Beispiel wird die Liste grades (ein mutable Attribut) innerhalb der Funktion ''add_grade'' verändert. Da das Objekt Student by reference übergeben wird, wird die Original-Liste grades modifiziert.
+Durch die Verwendung von `field(default_factory=list)` wird sichergestellt, dass jede Instanz von ''Student'' eine eigene Liste erhält, und Änderungen an einer Instanz wirken sich nicht auf andere Instanzen aus.
 ===== Immutable Dataclasses =====
-Wenn Sie möchten, dass eine Dataclass unveränderlich ist, können Sie sie durch Setzen des frozen-Parameters in @dataclass unveränderlich machen. In einer gefrorenen (frozen) Dataclass sind alle Attribute unveränderlich, und jede versuchte Änderung führt zu einem Fehler. Dies ähnelt dem Verhalten von ''By Value'', da die ursprüngliche Instanz nicht verändert werden kann.
+Wenn Sie möchten, dass eine Dataclass unveränderlich ist, können Sie sie durch Setzen des ''frozen''-Parameters in ''@dataclass'' unveränderlich machen. In einer gefrorenen (frozen) Dataclass sind alle Attribute unveränderlich, und jede versuchte Änderung führt zu einem Fehler. Dies ähnelt dem Verhalten von ''By Value'', da die ursprüngliche Instanz nicht verändert werden kann.
 ==== Beispiel: Immutable Dataclass ====
@@ Zeile 89: / Zeile 108: @@
 <code python>
 from dataclasses import dataclass
 @dataclass(frozen=True)
 class ImmutablePerson:
-name: str
+    name: str
-age: int
+    age: int
 </code>
-In diesem Fall ist die Dataclass ImmutablePerson unveränderlich, was bedeutet, dass jedes Attribut, sobald es gesetzt ist, nicht mehr geändert werden kann. Jeder Versuch, das Attribut age oder name zu ändern, führt zu einem Fehler.
+In diesem Fall ist die Dataclass ''ImmutablePerson'' unveränderlich, was bedeutet, dass jedes Attribut, sobald es gesetzt ist, nicht mehr geändert werden kann. Jeder Versuch, das Attribut ''age'' oder ''name'' zu ändern, führt zu einem Fehler.
+==== Beispiel: Anwendung einer frozen Dataclass ====
+<code python>
+from dataclasses import dataclass
+@dataclass(frozen=True)
+class Person:
+    name: str
+    age: int
+def birthday(person: Person) -> Person:
+    """
+    Returns a new Person instance with the age incremented by 1.
+    """
+    return Person(name=person.name, age=person.age + 1)
+if __name__ == '__main__':
+    p = Person(name='Alice', age=30)
+    print(f'Vor der Änderung: {p}')  # Output: Vor der Änderung: Person(name='Alice', age=30)
+    new_p = birthday(p)
+    print(f'Nach der Änderung: {p}')  # Output: Nach der Änderung: Person(name='Alice', age=30)
+    print(f'Neue Instanz: {new_p}')  # Output: Neue Instanz: Person(name='Alice', age=31)
+</code>
+=== Erläuterung: ===
+Die Dataclass ''Person'' ist als ''frozen'' markiert, was sie unveränderlich macht.
+Die Funktion ''birthday'' ist eine pure function. Sie nimmt eine Instanz der Dataclass ''Person'' als Eingabe und gibt eine neue Instanz zurück, wobei das ''age''-Attribut um eins erhöht wird.
+Das Originalobjekt ''p'' bleibt unverändert. Stattdessen wird eine neue Instanz ''new_p'' mit dem geänderten Alter erstellt.
+=== Vorteile: ===
+  * **Keine Seiteneffekte:** Da das Originalobjekt nicht verändert wird, gibt es keine ungewollten Änderungen am Zustand.
+  * **Vorhersehbarkeit:** Pure functions sind leichter zu verstehen und zu testen, da das Ergebnis nur von den Eingabewerten abhängt.
+  * **Immutable Data:** Die Verwendung von immutable Datenstrukturen verhindert unbeabsichtigte Modifikationen und erleichtert die Parallelisierung von Programmen.
+Dieses Vorgehen ist besonders nützlich in Szenarien, in denen Datenintegrität und Vorhersagbarkeit des Programmverhaltens von hoher Bedeutung sind.
 ===== Zusammenfassung =====
-In Python werden Objekte, einschließlich Dataclasses, immer ''By Reference'' übergeben. Änderungen an den Attributen eines Objekts innerhalb einer Funktion wirken sich direkt auf das Originalobjekt aus. Um ungewollte Änderungen zu vermeiden, kann eine Dataclass als ''frozen'' deklariert werden, was sie unveränderlich macht und vor unbeabsichtigten Modifikationen schützt.
+In Python werden Objekte, einschließlich Dataclasses, immer ''By Reference'' übergeben. Änderungen an den Attributen eines Objekts innerhalb einer Funktion wirken sich direkt auf das Originalobjekt aus. Um ungewollte Änderungen zu vermeiden, kann eine Dataclass als ''frozen'' deklariert werden, was sie unveränderlich macht und vor unbeabsichtigten Modifikationen schützt. Zusätzlich ist es wichtig, bei der Verwendung von mutable Default-Werten, wie Listen, darauf zu achten, dass jede Instanz ihre eigene unabhängige Kopie erhält, indem `field(default_factory=list)` verwendet wird.
 <WRAP center round tip 60%>
-Tipp: Wenn Sie mutable Attribute in einer Dataclass verwenden, sollten Sie sorgfältig überlegen, ob die direkte Veränderung dieser Attribute innerhalb von Funktionen in Ihrem Programmdesign erwünscht ist. Verwenden Sie ''frozen'' Dataclasses, um unbeabsichtigte Änderungen zu verhindern.
+Tipp: Wenn Sie mutable Attribute in einer Dataclass verwenden, sollten Sie sorgfältig überlegen, ob die direkte Veränderung dieser Attribute innerhalb von Funktionen in Ihrem Programmdesign erwünscht ist. Verwenden Sie ''frozen'' Dataclasses oder `field(default_factory=list)`, um unbeabsichtigte Änderungen zu verhindern.
 </WRAP>