From 094a3c2aa94c6d6dc6f83bd48b2e5c2277dcb163 Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Sun, 14 Mar 2021 16:28:23 +0100 Subject: [PATCH] Improved comments of database --- src/cpl/database/connection/database_connection.py | 4 ++++ src/cpl/database/connection/database_connection_abc.py | 8 +++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/cpl/database/connection/database_connection.py b/src/cpl/database/connection/database_connection.py index e83f12b2..87f77758 100644 --- a/src/cpl/database/connection/database_connection.py +++ b/src/cpl/database/connection/database_connection.py @@ -12,6 +12,10 @@ from cpl.database.database_settings import DatabaseSettings class DatabaseConnection(DatabaseConnectionABC): def __init__(self, database_settings: DatabaseSettings): + """ + Represents an connection to a database + :param database_settings: + """ DatabaseConnectionABC.__init__(self) self._db_settings = database_settings diff --git a/src/cpl/database/connection/database_connection_abc.py b/src/cpl/database/connection/database_connection_abc.py index 0e2db3b1..139e9214 100644 --- a/src/cpl/database/connection/database_connection_abc.py +++ b/src/cpl/database/connection/database_connection_abc.py @@ -18,4 +18,10 @@ class DatabaseConnectionABC(ABC): def session(self) -> Session: pass @abstractmethod - def connect(self, connection_string: str): pass + def connect(self, connection_string: str): + """ + Connects to a database by connection string + :param connection_string: + :return: + """ + pass