holado 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

holado_db/tools/db/clients/base/db_client.py

@@ -0,0 +1,206 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2023 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from builtins import NotImplementedError
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tables.table_with_header import TableWithHeader
+from holado_core.common.tables.table_row import TableRow
+import abc
+from holado_core.common.tools.tools import Tools
+from holado_core.common.tables.table import Table
+from holado_db.tools.db.query.base.query_builder import QueryBuilder
+
+logger = logging.getLogger(__name__)
+
+
+class DBClient(object):
+    __metaclass__ = abc.ABCMeta
+
+    def __init__(self, name, connect_kwargs, with_cursor=True, auto_commit=True):
+        self.__name = name
+        self.__connect_kwargs = connect_kwargs
+        self.__with_cursor = with_cursor
+        self.__auto_commit = auto_commit
+        
+        self.__connection = None
+        self.__query_builder = None
+    
+    @property
+    def name(self):
+        return self.__name
+    
+    @property
+    def query_builder(self) -> QueryBuilder:
+        return self.__query_builder
+    
+    @query_builder.setter
+    def query_builder(self, builder):
+        self.__query_builder = builder
+    
+    @property
+    def is_connected(self):
+        return self.__connection is not None
+    
+    @property
+    def connection(self):
+        return self.__connection
+    
+    @property
+    def cursor(self):
+        if not self.__with_cursor:
+            raise TechnicalException(f"DB client '{self.__name}' doesn't manage cursor")
+        return self.__cursor
+    
+    def connect(self):
+        try:
+            self.__connection = self._connect(**self.__connect_kwargs)
+        except Exception as exc:
+            Tools.raise_same_exception_type(exc, f"[{self.name}] Failed to connect with parameters {self.__connect_kwargs}")
+        if self.__with_cursor:
+            self.__cursor = self.__connection.cursor()
+    
+    def _connect(self, **kwargs):
+        raise NotImplementedError()
+    
+    def _verify_is_connected(self):
+        if not self.is_connected:
+            raise FunctionalException(f"DB Client '{self.name}' is not connected")
+        
+    def execute_query(self, query, *args, **kwargs):
+        sql = self.query_builder.to_sql(query)
+        return self.execute(sql, *args, **kwargs)
+        
+    def execute(self, sql, *args, **kwargs):
+        # Manage commit & auto commit
+        do_commit = None
+        if 'do_commit' in kwargs:
+            do_commit = kwargs.pop('do_commit')
+        if do_commit is None:
+            do_commit = self.__auto_commit
+            
+        self._verify_is_connected()
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] Executing SQL [{sql}] with parameters [{args if args else ''}{kwargs if kwargs else ''}]...")
+        try:
+            if args:
+                self.cursor.execute(sql, args)
+            elif kwargs:
+                self.cursor.execute(sql, kwargs)
+            else:
+                self.cursor.execute(sql)
+        except self._get_base_exception_type() as exc:
+            self.rollback()
+            raise TechnicalException(f"[{self.name}] Error while executing SQL [{sql}] (args: {args} ; kwargs: {kwargs})") from exc
+        
+        if self.cursor.description:
+            field_names = [field[0] for field in self.cursor.description]
+            
+            res = TableWithHeader()
+            res.header = TableRow(cells_content=field_names)
+            
+            row_values = self.cursor.fetchone()
+            while row_values:
+                res.add_row(cells_content=row_values)
+                row_values = self.cursor.fetchone()
+        elif self.cursor.rowcount > 0:
+            res = self.cursor.rowcount
+        else:
+            res = None
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] Executed SQL [{sql}] with parameters [{args if args else ''}{kwargs if kwargs else ''}] => [{res}]")
+        self.__log_sql_result(res)
+        
+        # Manage commit
+        if do_commit:
+            try:
+                self.commit()
+            except self._get_base_exception_type() as exc:
+                self.rollback()
+                raise TechnicalException(f"[{self.name}] Error while commit after SQL [{sql}] (args: {args} ; kwargs: {kwargs})") from exc
+            
+        return res
+    
+    def _get_base_exception_type(self):
+        raise NotImplementedError()
+    
+    def __log_sql_result(self, sql_result, limit_rows=10):
+        if Tools.do_log(logger, logging.DEBUG):
+            res_str = self.__represent_sql_result(sql_result, limit_rows=limit_rows)
+            if '\n' in res_str:
+                logger.debug(f"[{self.name}] SQL result:\n{Tools.indent_string(4, res_str)}")
+            else:
+                logger.debug(f"[{self.name}] SQL result: {res_str}")
+    
+    def __represent_sql_result(self, sql_result, limit_rows = 10):
+        if isinstance(sql_result, Table):
+            return sql_result.represent(limit_rows=limit_rows)
+        else:
+            return str(sql_result)
+    
+    def commit(self):
+        self.connection.commit()
+        
+    def rollback(self):
+        self.connection.rollback()
+        
+    def exist_table(self, table_name):
+        raise NotImplementedError()
+    
+    def insert(self, table_name, data: dict, do_commit=None):
+        """
+        Insert given data.
+        Parameter 'data' has to be a dictionary with keys equal to table column names.
+        """
+        query, values = self.query_builder.insert(table_name, data)
+        return self.execute_query(query, *values, do_commit=do_commit)
+    
+    def update(self, table_name, data: dict, where_data: dict, do_commit=None):
+        """
+        Update given data.
+        Parameters 'data' and 'where_data' have to be dictionaries with keys equal to table column names.
+        """
+        query, values = self.query_builder.update(table_name, data, where_data)
+        return self.execute_query(query, *values, do_commit=do_commit)
+    
+    def select(self, table_name, where_data: dict=None, sql_return="*"):
+        """
+        Select by filtering on given where data.
+        Parameter 'where_data' has to be a dictionary with keys equal to table column names.
+        """
+        query, values = self.query_builder.select(table_name, where_data, sql_return)
+        return self.execute_query(query, *values, do_commit=False)
+    
+    def delete(self, table_name, where_data: dict=None, do_commit=None):
+        """
+        Delete by filtering on given where data.
+        Parameter 'where_data' has to be a dictionary with keys equal to table column names.
+        """
+        query, values = self.query_builder.delete(table_name, where_data)
+        return self.execute_query(query, *values, do_commit=do_commit)
+    
+    def set_or_update_json_key_value(self, table_name, field_name, json_key, json_value, where_data):
+        """
+        Set or update a json field with key=value.
+        """
+        raise NotImplementedError()
+        
+    def _get_sql_placeholder(self):
+        """
+        Return the character/string to use as placeholder in SQL requests.
+        """
+        raise NotImplementedError()
+

holado_db/tools/db/clients/postgresql/postgresql_client.py

@@ -0,0 +1,65 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2023 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_db.tools.db.clients.base.db_client import DBClient
+from holado_core.common.tables.table_with_header import TableWithHeader
+from holado_core.common.tools.tools import Tools
+
+logger = logging.getLogger(__name__)
+
+try:
+    import psycopg
+    with_psycopg = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"PostgreSQLClient is not available. Initialization failed on error: {exc}")
+    with_psycopg = False
+
+
+class PostgreSQLClient(DBClient):
+    @classmethod
+    def is_available(cls):
+        return with_psycopg
+
+    def __init__(self, name, connect_kwargs):
+        super().__init__(name if name else 'PostgreSQL', connect_kwargs)
+        
+    def _get_base_exception_type(self):
+        return psycopg.Error
+    
+    def _connect(self, **kwargs):
+        return psycopg.connect(**kwargs)
+        
+    def _get_sql_placeholder(self):
+        return "%s"
+        
+    def exist_table(self, table_name):
+        result = self.execute(f"SELECT tablename FROM pg_tables WHERE schemaname = 'public' AND tablename = '{table_name}'")
+        return result is not None
+        
+    def set_or_update_json_key_value(self, table_name, field_name, json_key, json_value, where_data: dict=None):
+        # Help on JSON column: https://www.databasestar.com/postgresql-json/#How_to_Update_JSON_Data_in_PostgreSQL
+        result = self.select(table_name, where_data, sql_return=field_name)
+        is_set = isinstance(result, TableWithHeader) and result[0][0].content is not None
+        if not is_set:
+            self.update(table_name, {field_name: f'{{"{json_key}":"{json_value}"}}'}, where_data, do_commit=True)
+        else:
+            result = self.select(table_name, where_data, sql_return=f"{field_name} ->> '{json_key}'")
+            is_key_set = isinstance(result, TableWithHeader) and result[0][0].content is not None
+            if is_key_set:
+                self.update(table_name, {field_name: f"JSONB_SET({field_name}, '{json_key}', '\"{json_value}\"')"}, where_data, do_commit=True)
+            else:
+                self.update(table_name, {field_name: f'{field_name} || {{"{json_key}":"{json_value}"}}'}, where_data, do_commit=True)
+    
+    

holado_db/tools/db/clients/sqlite/sqlite_client.py

@@ -0,0 +1,56 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2023 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_db.tools.db.clients.base.db_client import DBClient
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.tools.tools import Tools
+
+logger = logging.getLogger(__name__)
+
+try:
+    import sqlite3
+    with_sqlite3 = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"SQLite3Client is not available. Initialization failed on error: {exc}")
+    with_sqlite3 = False
+
+
+class SQLite3Client(DBClient):
+    @classmethod
+    def is_available(cls):
+        return with_sqlite3
+
+    def __init__(self, name, connect_kwargs):
+        super().__init__(name if name else 'SQLite3', connect_kwargs)
+        
+    def _get_base_exception_type(self):
+        return sqlite3.Error
+        
+    def _connect(self, **kwargs):
+        try:
+            connect_kwargs = dict(kwargs)
+            database = connect_kwargs.pop("database")
+            return sqlite3.connect(database, **connect_kwargs)
+        except Exception as exc:
+            raise FunctionalException(f"Failed to connect with kwargs={kwargs}.\nUsage:\n{Tools.indent_string(4, sqlite3.connect.__doc__)}") from exc
+        
+    def _get_sql_placeholder(self):
+        return "?"
+        
+    def exist_table(self, table_name):
+        result = self.execute(f"SELECT name FROM sqlite_master WHERE type='table' AND name='{table_name}'")
+        return result is not None and result.nb_rows > 0
+        
+        

holado_db/tools/db/db_manager.py

@@ -0,0 +1,109 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_db.tools.db.clients.sqlite.sqlite_client import SQLite3Client
+from holado_db.tools.db.clients.postgresql.postgresql_client import PostgreSQLClient
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.handlers.abstracts.get_or_create import GetOrCreateVariableObject
+from holado_core.common.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+
+
+logger = logging.getLogger(__name__)
+
+
+
+class DBManager(GetOrCreateVariableObject):
+    """
+    Manage DB clients, agnostic to managed DB.
+    
+    It manages an instance by thread for DB types (ex: sqlite3) which clients don't support multithreading.
+    Note: Even if sqlite3 can support multithreading (with 'connect' parameter 'check_same_thread=False'),
+          current implementation of DBManager keeps sqlite3 default behavior.
+    """
+    
+    def __init__(self, name):
+        super().__init__(name if name else "DBManager")
+        
+        self.__func_query_manager = None
+        self.__db_info_by_db_type = {}
+    
+    def initialize(self, func_variable_manager, func_query_manager):
+        super().initialize(func_variable_manager)
+        self.__func_query_manager = func_query_manager
+        
+        if SQLite3Client.is_available():
+            self.register_db_client("sqlite3", SQLite3Client, do_support_multithreading=False)
+        else:
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug("SQLite3 package is not installed, this type of DB is not available")
+        if PostgreSQLClient.is_available():
+            self.register_db_client("postgresql", PostgreSQLClient)
+        else:
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug("PostgreSQL package is not installed, this type of DB is not available")
+    
+    @property
+    def __query_manager(self):
+        return self.__func_query_manager()
+    
+    def register_db_client(self, db_type, new_client_func, do_support_multithreading=True):
+        self.__db_info_by_db_type[db_type] = (new_client_func, do_support_multithreading)
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Registered DB type '{db_type}'")
+    
+    def get_or_create(self, name, *args, **kwargs):
+        # Manager DB types that need a client by thread
+        db_type = self.__find_db_type(args, kwargs)
+        if db_type is not None and not self.__db_info_by_db_type[db_type][1]:
+            thread_db_manager = SessionContext.instance().multitask_manager.get_thread_context().db_manager
+            if thread_db_manager is not self:
+                return thread_db_manager.get_or_create(name, *args, **kwargs)
+            else:
+                # Prefix name by thread UID, since same variable manager is shared by all thread context DBManagers
+                thread_uid = SessionContext.instance().multitask_manager.get_thread_uid()
+                real_name = f"{thread_uid}-{name}"
+        else:
+            real_name = name
+        
+        return super().get_or_create(real_name, *args, **kwargs)
+    
+    def __find_db_type(self, args, kwargs):
+        if kwargs and 'db_type' in kwargs:
+            return kwargs['db_type']
+        elif args and len(args) > 0 and args[0] in self.__db_info_by_db_type:
+            return args[0]
+        else:
+            return None
+    
+    def _goc_new_object(self, name, db_type, connect_kwargs):
+        res = self.new_client(name, db_type, connect_kwargs)
+        res.connect()
+        return res
+    
+    def new_client(self, name, db_type, connect_kwargs):
+        if db_type in self.__db_info_by_db_type:
+            try:
+                res = self.__db_info_by_db_type[db_type][0](name, connect_kwargs)
+            except Exception as exc:
+                raise TechnicalException(f"Failed to create client for DB type '{db_type}' with connect parameters: {connect_kwargs}") from exc
+        else:
+            raise TechnicalException(f"Unmanaged DB type '{db_type}'")
+        
+        res.query_builder = self.__query_manager.new_default_query_builder(db_type, res)
+        return res
+        
+        
+        
+        

holado_db/tools/db/query/base/query_builder.py

@@ -0,0 +1,87 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+import abc
+
+
+logger = logging.getLogger(__name__)
+
+
+
+class QueryBuilder():
+    """
+    Generic Query builder.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name, db_client=None):
+        self.__name = name
+        self.__db_client = db_client
+    
+    @property
+    def name(self):
+        return self.__name
+    
+    @property
+    def db_client(self):
+        return self.__db_client
+    
+    @db_client.setter
+    def db_client(self, client):
+        self.__db_client = client
+    
+    def select(self, table_name, where_data: dict=None, sql_return="*"):
+        """
+        Simple query & values builder of a select by filtering on given where data.
+        Parameter 'where_data' has to be a dictionary with keys equal to table column names.
+        """
+        raise NotImplementedError
+
+    def insert(self, table_name, data: dict):
+        """
+        Simple query & values builder of an insert of given data.
+        Parameter 'data' has to be a dictionary with keys equal to table column names.
+        """
+        raise NotImplementedError
+    
+    def update(self, table_name, data: dict, where_data: dict):
+        """
+        Simple query & values builder of an update of given data.
+        Parameters 'data' and 'where_data' have to be dictionaries with keys equal to table column names.
+        """
+        raise NotImplementedError
+    
+    def delete(self, table_name, where_data: dict=None):
+        """
+        Simple query & values builder of a delete by filtering on given where data.
+        Parameter 'where_data' has to be a dictionary with keys equal to table column names.
+        """
+        raise NotImplementedError
+    
+    def where(self, query, values, where_data: dict):
+        """
+        Add where clauses to current couple (query, values), and return a new couple (query, values).
+        """
+        raise NotImplementedError
+    
+    def where_in(self, query, values, field_name, field_values, not_in=False):
+        """
+        Add where in clause to current couple (query, values), and return a new couple (query, values).
+        """
+        raise NotImplementedError
+        
+    
+    def to_sql(self, query):
+        raise NotImplementedError
+