📝 Add docstrings to blatt10

Docstrings generation was requested by @GalacticCodeGambit.

* #105 (comment)

The following files were modified:

* `project/backend/Datenbank.py`
* `project/backend/LazyCookVerwaltung.py`

Author: coderabbitai[bot]

project/backend/Datenbank.py

@@ -20,6 +20,11 @@ def get_connection(self):
         return con
 
     def __create_tables_if_not_exist(self):
+        """
+        Create the required SQLite tables for the application's schema if they do not already exist.
+        
+        Executes CREATE TABLE IF NOT EXISTS statements for all application tables and commits the transaction on success. On error, prints the exception message and rolls back the transaction.
+        """
         try:
             self.db.execute("""
                 CREATE TABLE IF NOT EXISTS Zutat (
@@ -89,6 +94,17 @@ def __create_tables_if_not_exist(self):
             self.con.rollback()
 
     def addNutzer(self, email, salt, passwort):
+        """
+        Register a new account by inserting a row into the Konto table if the email is not already registered.
+        
+        Parameters:
+            email (str): The account email address to register.
+            salt (str): The salt value associated with the account password.
+            passwort (str): The account password (expected to be already hashed or prepared).
+        
+        Returns:
+            str: "Registrierung erfolgreich" if a new Konto row was inserted, or "Email schon in einem Konto registriert" if the email already exists.
+        """
         con = self.get_connection()
 
         db = con.cursor()
@@ -117,6 +133,15 @@ def addNutzer(self, email, salt, passwort):
         return "Registrierung erfolgreich"
 
     def anmeldenNutzer(self, email):
+        """
+        Retrieve stored password hash and salt for the account with the given email.
+        
+        Parameters:
+            email (str): Account email to look up.
+        
+        Returns:
+            sqlite3.Row | None: A row containing `passwort` and `salt` for the matching account, or `None` if no account with the email exists.
+        """
         con = self.get_connection()
 
         db = con.cursor()
@@ -131,12 +156,38 @@ def anmeldenNutzer(self, email):
         return row
 
     def speichernInDB(self, daten: Dict[str, Any]):
+        """
+        Persist the provided data dictionary into this instance's database.
+        
+        Parameters:
+            daten (Dict[str, Any]): A mapping of column/field names to values representing the record(s) to persist. The exact expected keys and behavior depend on calling context and table targeted by the implementation.
+        """
         pass
 
     def holeDaten(self, tabelle: str) -> list[Dict[str, Any]]:
+        """
+        Retrieve all rows from the specified table as a list of dictionaries.
+        
+        Parameters:
+            tabelle (str): Name of the database table to read from.
+        
+        Returns:
+            list[Dict[str, Any]]: A list where each item is a mapping of column names to their values for a single row; returns an empty list if the table has no rows or does not exist.
+        """
         pass
 
     def entferneTextSyntax(self, text):
+        """
+        Remove common bracket and punctuation characters from a string.
+        
+        This function returns the input string with all parentheses `()`, square brackets `[]`, single quotes `'`, and commas `,` removed.
+        
+        Parameters:
+            text (str): Input string to sanitize.
+        
+        Returns:
+            str: The sanitized string with the specified characters removed.
+        """
         text = (
             text.replace("(", "")
             .replace(")", "")
@@ -148,6 +199,11 @@ def entferneTextSyntax(self, text):
         return text
 
     def close(self):
+        """
+        Close the instance's open SQLite connection.
+        
+        After calling this method the database connection is closed and the instance should not be used for further database operations.
+        """
         self.con.close()
 
         """Alles Nachfolgende sind Testfunktionen
@@ -230,4 +286,3 @@ def test_print_tables(self):
         except Exception as e:
             print(f"Fehler beim Testen der Tabellen: {e}")
 
-

project/backend/LazyCookVerwaltung.py

@@ -37,6 +37,17 @@ def hash_password(password: str) -> tuple[str, str]:
     return base64.b64encode(salt).decode(), base64.b64encode(key).decode()
 
 def verify_password(password: str, salt_b64: str, key_b64: str) -> bool:
+    """
+    Validate a plaintext password against a stored salt and derived key.
+    
+    Parameters:
+        password (str): The plaintext password to verify.
+        salt_b64 (str): Base64-encoded salt used when the stored key was derived.
+        key_b64 (str): Base64-encoded derived key (password hash) to compare against.
+    
+    Returns:
+        bool: `True` if the password, when derived with the provided salt, matches the stored key; `False` otherwise.
+    """
     salt = base64.b64decode(salt_b64)
     key_original = base64.b64decode(key_b64)
 
@@ -53,6 +64,19 @@ def verify_password(password: str, salt_b64: str, key_b64: str) -> bool:
 @app.post("/api/login")
 def anmelden(user: UserSignUpIn):
 
+    """
+    Authenticate a user by email and password.
+    
+    Parameters:
+        user (UserSignUpIn): Object containing `email` and `password` for authentication.
+    
+    Returns:
+        dict: A dictionary with a single `"message"` key describing the outcome:
+            - "Anmeldung erfolgreich" if authentication succeeds.
+            - "Falsches Passwort" if the password is incorrect.
+            - "Für diese Email ist kein Konto hinterlegt" if no account exists for the provided email.
+            - "Anmeldung fehlgeschlagen" if an unexpected error occurs.
+    """
     try:
         row = datenbank.anmeldenNutzer(user.email)
 
@@ -110,4 +134,3 @@ def zeigeRezepteAn(self):
 
 
 
-