Renamed project

src/cpl_core/database/connection/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_cpl-core sh-edraft Common Python library
+~~~~~~~~~~~~~~~~~~~
+
+sh-edraft Common Python library
+
+:copyright: (c) 2020 - 2021 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'cpl_core.database.connection'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
+__version__ = '2021.10.6'
+
+from collections import namedtuple
+
+# imports:
+from .database_connection import DatabaseConnection
+from .database_connection_abc import DatabaseConnectionABC
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='2021', minor='10', micro='6')

src/cpl_core/database/connection/database_connection.py

@@ -0,0 +1,64 @@
+from typing import Optional
+
+from sqlalchemy import engine, create_engine
+from sqlalchemy.orm import Session, sessionmaker
+
+from cpl.console.console import Console
+from cpl.console.foreground_color_enum import ForegroundColorEnum
+from cpl.database.connection.database_connection_abc import DatabaseConnectionABC
+from cpl.database.database_settings import DatabaseSettings
+
+
+class DatabaseConnection(DatabaseConnectionABC):
+    r"""Representation of the database connection
+
+    Parameter
+    ---------
+        database_settings: :class:`cpl.database.database_settings.DatabaseSettings`
+    """
+
+    def __init__(self, database_settings: DatabaseSettings):
+        DatabaseConnectionABC.__init__(self)
+
+        self._db_settings = database_settings
+
+        self._engine: Optional[engine] = None
+        self._session: Optional[Session] = None
+        self._credentials: Optional[str] = None
+
+    @property
+    def engine(self) -> engine:
+        return self._engine
+
+    @property
+    def session(self) -> Session:
+        return self._session
+
+    def connect(self, connection_string: str):
+        try:
+            self._engine = create_engine(connection_string)
+
+            if self._db_settings.auth_plugin is not None:
+                self._engine = create_engine(connection_string, connect_args={'auth_plugin': self._db_settings.auth_plugin})
+
+            if self._db_settings.encoding is not None:
+                self._engine.encoding = self._db_settings.encoding
+
+            if self._db_settings.case_sensitive is not None:
+                self._engine.case_sensitive = self._db_settings.case_sensitive
+
+            if self._db_settings.echo is not None:
+                self._engine.echo = self._db_settings.echo
+
+            self._engine.connect()
+
+            db_session = sessionmaker(bind=self._engine)
+            self._session = db_session()
+            Console.set_foreground_color(ForegroundColorEnum.green)
+            Console.write_line(f'[{__name__}] Connected to database')
+            Console.set_foreground_color(ForegroundColorEnum.default)
+        except Exception as e:
+            Console.set_foreground_color(ForegroundColorEnum.red)
+            Console.write_line(f'[{__name__}] Database connection failed -> {e}')
+            Console.set_foreground_color(ForegroundColorEnum.default)
+            exit()

src/cpl_core/database/connection/database_connection_abc.py

@@ -0,0 +1,30 @@
+from abc import abstractmethod, ABC
+
+from sqlalchemy import engine
+from sqlalchemy.orm import Session
+
+
+class DatabaseConnectionABC(ABC):
+    r"""ABC for the :class:`cpl.database.connection.database_connection.DatabaseConnection`"""
+
+    @abstractmethod
+    def __init__(self): pass
+
+    @property
+    @abstractmethod
+    def engine(self) -> engine: pass
+
+    @property
+    @abstractmethod
+    def session(self) -> Session: pass
+
+    @abstractmethod
+    def connect(self, connection_string: str):
+        r"""Connects to a database by connection string
+
+        Parameter
+        ---------
+            connection_string: :class:`str`
+                Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html
+        """
+        pass