Doc-Strings und Type-Hinting

GHA_triaxial/numeric_examples_karney.py

@@ -1,7 +1,13 @@
 import random
 import winkelumrechnungen as wu
+from Typing import List, Tuple
 
-def line2example(line):
+def line2example(line: str) -> List:
+    """
+    Line-String in Liste umwandeln
+    :param line: Line-String
+    :return: Liste mit Zahlenwerten
+    """
     split = line.split()
     example = [float(value) for value in split[:7]]
     for i, value in enumerate(example):
@@ -10,13 +16,16 @@ def line2example(line):
             # example[i] = value
     return example
 
-def get_random_examples(num):
+def get_random_examples(num: int, seed: int = None) -> List:
     """
+    Rückgabe zufälliger Beispiele
     beta0, lamb0, alpha0, beta1, lamb1, alpha1, s12
-    :param num:
-    :return:
+    :param num: Anzahl zufälliger Beispiele
+    :param seed: Random-Seed
+    :return: Liste mit Beispielen
     """
-    # random.seed(42)
+    if seed is not None:
+        random.seed(seed)
     with open("Karney_2024_Testset.txt") as datei:
         lines = datei.readlines()
     examples = []
@@ -25,11 +34,12 @@ def get_random_examples(num):
         examples.append(example)
     return examples
 
-def get_examples(l_i):
+def get_examples(l_i: List) -> List:
     """
+    Rückgabe ausgewählter Beispiele
     beta0, lamb0, alpha0, beta1, lamb1, alpha1, s12
-    :param num:
-    :return:
+    :param l_i: Liste von Indizes
+    :return: Liste mit Beispielen
     """
     with open("Karney_2024_Testset.txt") as datei:
         lines = datei.readlines()
@@ -39,5 +49,6 @@ def get_examples(l_i):
         examples.append(example)
     return examples
 
+
 if __name__ == "__main__":
     get_random_examples(10)