Updated docs

tests/custom/database/src/model/city_model.py

@@ -2,46 +2,53 @@ from cpl_core.database import TableABC
 
 
 class CityModel(TableABC):
-
-    def __init__(self, name: str, zip_code: str, id = 0):
+    def __init__(self, name: str, zip_code: str, id=0):
         self.CityId = id
         self.Name = name
         self.ZIP = zip_code
-    
+
     @staticmethod
     def get_create_string() -> str:
-        return str(f"""
+        return str(
+            f"""
             CREATE TABLE IF NOT EXISTS `City` (
                 `CityId` INT(30) NOT NULL AUTO_INCREMENT,
                 `Name` VARCHAR(64) NOT NULL,
                 `ZIP` VARCHAR(5) NOT NULL,
                 PRIMARY KEY(`CityId`)
             );
-        """)
-    
+        """
+        )
+
     @property
     def insert_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             INSERT INTO `City` (
                 `Name`, `ZIP`
             ) VALUES (
                 '{self.Name}',
                 '{self.ZIP}'
             );
-        """)
-    
+        """
+        )
+
     @property
     def udpate_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             UPDATE `City`
             SET `Name` = '{self.Name}', 
             `ZIP` = '{self.ZIP}',
             WHERE `CityId` = {self.Id};
-        """)
-    
+        """
+        )
+
     @property
     def delete_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             DELETE FROM `City`
             WHERE `CityId` = {self.Id};
-        """)
+        """
+        )

tests/custom/database/src/model/db_context.py

@@ -3,6 +3,5 @@ from cpl_core.database.context import DatabaseContext
 
 
 class DBContext(DatabaseContext):
-
     def __init__(self, db_settings: DatabaseSettings):
         DatabaseContext.__init__(self, db_settings)

tests/custom/database/src/model/user_model.py

@@ -4,8 +4,7 @@ from .city_model import CityModel
 
 
 class UserModel(TableABC):
-
-    def __init__(self, name: str, city: CityModel, id = 0):
+    def __init__(self, name: str, city: CityModel, id=0):
         self.UserId = id
         self.Name = name
         self.CityId = city.CityId if city is not None else 0
@@ -13,7 +12,8 @@ class UserModel(TableABC):
 
     @staticmethod
     def get_create_string() -> str:
-        return str(f"""
+        return str(
+            f"""
             CREATE TABLE IF NOT EXISTS `User` (
                 `UserId` INT(30) NOT NULL AUTO_INCREMENT,
                 `Name` VARCHAR(64) NOT NULL,
@@ -21,30 +21,37 @@ class UserModel(TableABC):
                 FOREIGN KEY (`UserId`) REFERENCES City(`CityId`),
                 PRIMARY KEY(`UserId`)
             );
-        """)
+        """
+        )
 
     @property
     def insert_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             INSERT INTO `User` (
                 `Name`
             ) VALUES (
                 '{self.Name}'
             );
-        """)
+        """
+        )
 
     @property
     def udpate_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             UPDATE `User`
             SET `Name` = '{self.Name}', 
             `CityId` = {self.CityId},
             WHERE `UserId` = {self.UserId};
-        """)
+        """
+        )
 
     @property
     def delete_string(self) -> str:
-        return str(f"""
+        return str(
+            f"""
             DELETE FROM `User`
             WHERE `UserId` = {self.UserId};
-        """)
+        """
+        )

tests/custom/database/src/model/user_repo.py

@@ -7,36 +7,35 @@ from .user_repo_abc import UserRepoABC
 
 
 class UserRepo(UserRepoABC):
-
     def __init__(self, db_context: DatabaseContextABC):
         UserRepoABC.__init__(self)
 
         self._db_context: DatabaseContextABC = db_context
 
     def add_test_user(self):
-        city = CityModel('Haren', '49733')
-        city2 = CityModel('Meppen', '49716')
+        city = CityModel("Haren", "49733")
+        city2 = CityModel("Meppen", "49716")
         self._db_context.cursor.execute(city2.insert_string)
-        user = UserModel('TestUser', city)
+        user = UserModel("TestUser", city)
         self._db_context.cursor.execute(user.insert_string)
         self._db_context.save_changes()
 
     def get_users(self) -> list[UserModel]:
-        users =  []
-        results = self._db_context.select('SELECT * FROM `User`')
+        users = []
+        results = self._db_context.select("SELECT * FROM `User`")
         for result in results:
-            users.append(UserModel(result[1], self.get_city_by_id(result[2]), id = result[0]))
+            users.append(UserModel(result[1], self.get_city_by_id(result[2]), id=result[0]))
         return users
 
     def get_cities(self) -> list[CityModel]:
-        cities =  []
-        results = self._db_context.select('SELECT * FROM `City`')
+        cities = []
+        results = self._db_context.select("SELECT * FROM `City`")
         for result in results:
-            cities.append(CityModel(result[1], result[2], id = result[0]))
+            cities.append(CityModel(result[1], result[2], id=result[0]))
         return cities
-    
+
     def get_city_by_id(self, id: int) -> CityModel:
         if id is None:
             return None
-        result = self._db_context.select(f'SELECT * FROM `City` WHERE `Id` = {id}')
-        return CityModel(result[1], result[2], id = result[0])
+        result = self._db_context.select(f"SELECT * FROM `City` WHERE `Id` = {id}")
+        return CityModel(result[1], result[2], id=result[0])

tests/custom/database/src/model/user_repo_abc.py

@@ -5,15 +5,18 @@ from .user_model import UserModel
 
 
 class UserRepoABC(ABC):
+    @abstractmethod
+    def __init__(self):
+        pass
 
     @abstractmethod
-    def __init__(self): pass
+    def get_users(self) -> list[UserModel]:
+        pass
 
     @abstractmethod
-    def get_users(self) -> list[UserModel]: pass
-    
+    def get_cities(self) -> list[CityModel]:
+        pass
+
     @abstractmethod
-    def get_cities(self) -> list[CityModel]: pass
-    
-    @abstractmethod
-    def get_city_by_id(self, id: int) -> CityModel: pass
+    def get_city_by_id(self, id: int) -> CityModel:
+        pass