Updated docs

src/cpl_core/database/context/__init__.py

@@ -1,21 +1,21 @@
 # -*- coding: utf-8 -*-
 
 """
-cpl-core sh-edraft Common Python library
+cpl-core CPL core
 ~~~~~~~~~~~~~~~~~~~
 
-sh-edraft Common Python library
+CPL core package
 
 :copyright: (c) 2020 - 2023 sh-edraft.de
 :license: MIT, see LICENSE for more details.
 
 """
 
-__title__ = 'cpl_core.database.context'
-__author__ = 'Sven Heidemann'
-__license__ = 'MIT'
-__copyright__ = 'Copyright (c) 2020 - 2023 sh-edraft.de'
-__version__ = '2022.12.1'
+__title__ = "cpl_core.database.context"
+__author__ = "Sven Heidemann"
+__license__ = "MIT"
+__copyright__ = "Copyright (c) 2020 - 2023 sh-edraft.de"
+__version__ = "2023.2.0"
 
 from collections import namedtuple
 
@@ -24,5 +24,5 @@ from collections import namedtuple
 from .database_context import DatabaseContext
 from .database_context_abc import DatabaseContextABC
 
-VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major='2022', minor='12', micro='1')
+VersionInfo = namedtuple("VersionInfo", "major minor micro")
+version_info = VersionInfo(major="2023", minor="2", micro="0")

src/cpl_core/database/context/database_context.py

@@ -1,11 +1,9 @@
-
 from typing import Optional
 
 import mysql
 
 from cpl_core.database.connection.database_connection import DatabaseConnection
-from cpl_core.database.connection.database_connection_abc import \
-    DatabaseConnectionABC
+from cpl_core.database.connection.database_connection_abc import DatabaseConnectionABC
 from cpl_core.database.context.database_context_abc import DatabaseContextABC
 from cpl_core.database.database_settings import DatabaseSettings
 from cpl_core.database.table_abc import TableABC
@@ -15,8 +13,7 @@ from mysql.connector.cursor import MySQLCursorBuffered
 class DatabaseContext(DatabaseContextABC):
     r"""Representation of the database context
 
-    Parameter
-    ---------
+    Parameter:
         database_settings: :class:`cpl_core.database.database_settings.DatabaseSettings`
     """
 
@@ -38,7 +35,7 @@ class DatabaseContext(DatabaseContextABC):
         except mysql.connector.Error as err:
             # reconnect your cursor as you did in __init__ or wherever
             if self._settings is None:
-                raise Exception('Call DatabaseContext.connect first')
+                raise Exception("Call DatabaseContext.connect first")
             self.connect(self._settings)
 
     def connect(self, database_settings: DatabaseSettings):
@@ -53,7 +50,7 @@ class DatabaseContext(DatabaseContextABC):
     def save_changes(self):
         self._ping_and_reconnect()
         self._db.server.commit()
-        
+
     def select(self, statement: str) -> list[tuple]:
         self._ping_and_reconnect()
         self._db.cursor.execute(statement)

src/cpl_core/database/context/database_context_abc.py

@@ -13,33 +13,31 @@ class DatabaseContextABC(ABC):
 
     @property
     @abstractmethod
-    def cursor(self) -> MySQLCursorBuffered: pass
-    
+    def cursor(self) -> MySQLCursorBuffered:
+        pass
+
     @abstractmethod
     def connect(self, database_settings: DatabaseSettings):
         r"""Connects to a database by connection settings
 
-        Parameter
-        ---------
+        Parameter:
             database_settings :class:`cpl_core.database.database_settings.DatabaseSettings`
         """
         pass
-    
+
     @abstractmethod
     def save_changes(self):
         r"""Saves changes of the database"""
         pass
-    
+
     @abstractmethod
     def select(self, statement: str) -> list[tuple]:
         r"""Runs SQL Statements
-        
-        Parameter
-        ---------
+
+        Parameter:
             statement: :class:`str`
-        
-        Returns
-        -------
+
+        Returns:
             list: Fetched list of selected elements
         """
         pass