holado 0.13.22__py3-none-any.whl

holado_db/tools/db/query/pypika/pypika_query_builder.py

@@ -0,0 +1,244 @@
+
+#################################################
+# 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_core.common.exceptions.technical_exception import TechnicalException
+from holado_db.tools.db.query.base.query_builder import QueryBuilder, DBCompareOperator
+from holado_core.common.tools.tools import Tools
+from holado_python.standard_library.typing import Typing
+
+
+logger = logging.getLogger(__name__)
+
+try:
+    import pypika.functions
+    from pypika.queries import Table, Query
+    from pypika.terms import Parameter, Function
+    with_pypika = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"PyPika is not available for QueryBuilder. Initialization failed on error: {exc}")
+    with_pypika = False
+
+
+
+class PypikaQueryBuilder(QueryBuilder):
+    """
+    Query builder for PyPika library.
+    """
+    @classmethod
+    def is_available(cls):
+        return with_pypika
+    
+    def __init__(self, name, db_client=None):
+        super().__init__(name, db_client)
+    
+    def select(self, table_name, where_data: dict=None, where_compare_data: list=None, sql_return="*"):
+        """
+        Simple query & values builder of a select by filtering on given where data.
+        @param where_data: dictionary of (field_name, value) for simple where clauses.
+        @param where_compare_data: list of tuples (field_name, operator, value) for where clauses comparing fields with values.
+        """
+        table = Table(table_name)
+        res = Query.from_(table)
+        values = ()
+        
+        if sql_return == "count(*)":
+            res = res.select(pypika.functions.Count("*"))
+        elif isinstance(sql_return, list):
+            res = res.select(*sql_return)
+        else:
+            res = res.select(sql_return)
+        
+        if where_data:
+            res, values = self.where(res, values, where_data)
+        if where_compare_data:
+            res, values = self.where_compare(res, values, list_of_field_operator_value=where_compare_data)
+        
+        return res, values
+    
+    def insert(self, table_name, data: dict):
+        """
+        Simple query & values builder of an insert of given data.
+        @param data: data to insert as dictionary of (field_name, value).
+        """
+        col_names = tuple(sorted(data.keys()))
+        values = tuple((data[c] for c in col_names))
+        sql_placeholder = self.db_client._get_sql_placeholder()
+        
+        values_placeholder = [Parameter(sql_placeholder)] * len(col_names)
+        res = Query.into(table_name).columns(*col_names).insert(*values_placeholder)
+        
+        return res, values
+    
+    def update(self, table_name, data: dict, where_data: dict=None, where_compare_data: list=None):
+        """
+        Simple query & values builder of an update of given data.
+        @param data: data to update as dictionary of (field_name, value).
+        @param where_data: dictionary of (field_name, value) for simple where clauses.
+        @param where_compare_data: list of tuples (field_name, operator, value) for where clauses comparing fields with values.
+        """
+        col_names = tuple(sorted(data.keys()))
+        sql_placeholder = self.db_client._get_sql_placeholder()
+        
+        table = Table(table_name)
+        res = Query.update(table)
+        values = []
+        for c in col_names:
+            val = data[c]
+            if isinstance(val, Function):
+                res = res.set(c, val)
+            else:
+                res = res.set(c, Parameter(sql_placeholder))
+                values.append(val)
+            
+        if where_data:
+            res, values = self.where(res, values, where_data)
+        if where_compare_data:
+            res, values = self.where_compare(res, values, list_of_field_operator_value=where_compare_data)
+        
+        return res, values
+    
+    def delete(self, table_name, where_data: dict=None, where_compare_data: list=None):
+        """
+        Simple query & values builder of a delete by filtering on given where data.
+        @param where_data: dictionary of (field_name, value) for simple where clauses.
+        @param where_compare_data: list of tuples (field_name, operator, value) for where clauses comparing fields with values.
+        """
+        table = Table(table_name)
+        res = Query.from_(table).delete()
+        values = ()
+        
+        if where_data:
+            res, values = self.where(res, values, where_data)
+        if where_compare_data:
+            res, values = self.where_compare(res, values, list_of_field_operator_value=where_compare_data)
+            
+        return res, values
+    
+    def where(self, query, values, where_data: dict):
+        col_names = tuple(sorted(where_data.keys()))
+        sql_placeholder = self.db_client._get_sql_placeholder()
+        
+        res = query
+        table = self.__get_table(query)
+        where_values = []
+        for c in col_names:
+            val = where_data[c]
+            if val is None:
+                res, where_values = self.where_is_null(res, where_values, c)
+            else:
+                res = res.where(getattr(table, c) == Parameter(sql_placeholder))
+                where_values.append(where_data[c])
+        
+        if values is not None:
+            values = (*values, *where_values)
+        else:
+            values = where_values
+        return res, values
+    
+    def where_compare(self, query, values, *, field_name=None, operator:DBCompareOperator=None, value=None, list_of_field_operator_value=None):
+        if list_of_field_operator_value is not None:
+            return super().where_compare(query, values, list_of_field_operator_value=list_of_field_operator_value)
+        
+        # Manage operators calling other methods
+        if operator == DBCompareOperator.In:
+            return self.where_in(query, values, field_name, value, not_in=False)
+        elif operator == DBCompareOperator.NotIn:
+            return self.where_in(query, values, field_name, value, not_in=True)
+        
+        # Manage other operators
+        table = self.__get_table(query)
+        sql_placeholder = self.db_client._get_sql_placeholder()
+        
+        if operator == DBCompareOperator.Different:
+            res = query.where(getattr(table, field_name) != Parameter(sql_placeholder))
+        elif operator == DBCompareOperator.Equal:
+            res = query.where(getattr(table, field_name) == Parameter(sql_placeholder))
+        elif operator == DBCompareOperator.Inferior:
+            res = query.where(getattr(table, field_name) < Parameter(sql_placeholder))
+        elif operator == DBCompareOperator.InferiorOrEqual:
+            res = query.where(getattr(table, field_name) <= Parameter(sql_placeholder))
+        elif operator == DBCompareOperator.Superior:
+            res = query.where(getattr(table, field_name) > Parameter(sql_placeholder))
+        elif operator == DBCompareOperator.SuperiorOrEqual:
+            res = query.where(getattr(table, field_name) >= Parameter(sql_placeholder))
+        else:
+            raise TechnicalException(f"Unmanaged compare operator {operator}")
+            
+        if values is not None:
+            values = (*values, value)
+        else:
+            values = (value)
+        return res, values
+    
+    def where_in(self, query, values, field_name, field_values, not_in=False):
+        table = self.__get_table(query)
+        if not_in:
+            res = query.where(getattr(table, field_name).notin(field_values))
+        else:
+            res = query.where(getattr(table, field_name).isin(field_values))
+        return res, values
+    
+    def where_is_null(self, query, values, field_name, is_not_null=False):
+        table = self.__get_table(query)
+        if is_not_null:
+            res = query.where(getattr(table, field_name).notnull())
+        else:
+            res = query.where(getattr(table, field_name).isnull())
+        return res, values
+        
+    def where_json_value(self, query, values, field_name, key, value, as_text_value=False):
+        table = self.__get_table(query)
+        sql_placeholder = self.db_client._get_sql_placeholder()
+        
+        if as_text_value:
+            res = query.where(getattr(table, field_name).get_text_value(key) == Parameter(sql_placeholder))
+        else:
+            res = query.where(getattr(table, field_name).get_json_value(key) == Parameter(sql_placeholder))
+        
+        if values is not None:
+            values = (*values, value)
+        else:
+            values = (value)
+        return res, values
+    
+    def to_sql(self, query):
+        if query.__module__.startswith('pypika'):
+            return query.get_sql()
+        else:
+            raise TechnicalException(f"Unmanaged query of type {Typing.get_object_class_fullname(query)}")
+    
+    # def is_query_type(self, query, query_type):
+    #     query_type = query_type.lower()
+    #
+    #     if query_type == 'insert':
+    #         return query._insert_table is not None
+    #     elif query_type == 'select':
+    #         return len(query._selects) > 0
+    #     elif query_type == 'update':
+    #         return query._update_table is not None
+    #     elif query_type == 'delete':
+    #         return query._delete_from
+    #     else:
+    #         raise TechnicalException(f"Unmanaged query type '{query_type}' (managed query types: 'insert', 'select', 'update', 'delete')")
+        
+    def __get_table(self, query):
+        if query._from is not None and len(query._from) > 0:
+            return query._from[0]
+        elif query._insert_table is not None:
+            return query._insert_table
+        elif query._update_table is not None:
+            return query._update_table
+        else:
+            raise TechnicalException(f"Failed to extract table from query [{query}]: {Tools.represent_object(query)}")

holado_db/tools/db/query/query_manager.py

@@ -0,0 +1,77 @@
+
+#################################################
+# 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_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.tools import Tools
+
+
+logger = logging.getLogger(__name__)
+
+
+
+class QueryManager():
+    """
+    Manage Query builders, agnostic to managed libraries.
+    """
+    
+    def __init__(self, name):
+        self.__name = name if name else "QueryManager"
+        
+        self.__builder_new_func_by_type = {}
+        self.__default_builder_type = None
+        
+    def initialize(self):
+        from holado_db.tools.db.query.pypika.pypika_query_builder import PypikaQueryBuilder
+        if PypikaQueryBuilder.is_available():
+            self.register_query_builder("pypika", PypikaQueryBuilder)
+            self.__default_builder_type = "pypika"
+        else:
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug("PyPika package is not installed, this type of Query builder is not available")
+        
+    @property
+    def name(self):
+        return self.__name
+        
+    @property
+    def default_builder_type(self):
+        return self.__default_builder_type
+        
+    @default_builder_type.setter
+    def default_builder_type(self, builder_type):
+        self.__default_builder_type = builder_type
+    
+    def register_query_builder(self, builder_type, new_builder_func):
+        self.__builder_new_func_by_type[builder_type] = new_builder_func
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Registered Query builder type '{builder_type}'")
+    
+    def new_default_query_builder(self, name, db_client):
+        if self.__default_builder_type is None:
+            raise TechnicalException(f"Default query builder type is not defined. Registered query builders: {list(self.__builder_new_func_by_type.keys())}")
+        return self.new_query_builder(name, self.__default_builder_type, db_client)
+    
+    def new_query_builder(self, name, builder_type, db_client):
+        if builder_type in self.__builder_new_func_by_type:
+            try:
+                res = self.__builder_new_func_by_type[builder_type](name, db_client)
+            except Exception as exc:
+                raise TechnicalException(f"Failed to create Query builder for builder type '{builder_type}'") from exc
+        else:
+            raise TechnicalException(f"Unmanaged Query builder type '{builder_type}'")
+        return res
+        
+        
+        
+        

holado_django/__init__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.
+#################################################
+
+
+def dependencies():
+    """
+    Return None or the list of names of modules it depend on
+    """
+    return None
+
+def register():
+    """
+    Register the services of this module
+    """
+    # from holado.common.context.session_context import SessionContext
+    
+    # from holado_xxx.xxx import XXXManager
+    # SessionContext.instance().services.register_service_type("xxx_manager", XXXManager)
+    pass
+

holado_django/server/HOWTO.txt

@@ -0,0 +1,27 @@
+
+#################################################
+# 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.
+#################################################
+
+
+HOWTO create a REST server easier with HolAdo:
+
+    1. Create a working directory (WORK_DIR) where all server files will be stored
+    2. Copy in WORK_DIR the appropriate django project. For this case, it is holado_django/server/django_projects/rest_api
+    3. Update application with wanted REST APIs. For this case, update/add files in rest_api/rest_api/application: views.py, models.py,...
+    4. Make migrations if needed (cf django documentation)
+    5. Run server manually with a command like "python manage.py runserver", or use module holado_django/server/django_server.py
+
+    Example: A simple example is in holado_examples/projects/server_rest/server_rest_example
+
+    Note: These steps are simple and doesn't give help to developpers knowing Django and Django REST framework.
+          They should be a first step towards future more powerful tools.
+

holado_django/server/django_projects/rest_api/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

holado_django/server/django_projects/rest_api/rest_api/application/admin.py

@@ -0,0 +1,3 @@
+# from django.contrib import admin
+
+# Register your models here.

holado_django/server/django_projects/rest_api/rest_api/application/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+django_application_inst = None
+
+
+class ApplicationConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'application'

holado_django/server/django_projects/rest_api/rest_api/application/models.py

@@ -0,0 +1,3 @@
+# from django.db import models
+
+# Create your models here.

holado_django/server/django_projects/rest_api/rest_api/application/tests.py

@@ -0,0 +1,3 @@
+# from django.test import TestCase
+
+# Create your tests here.

holado_django/server/django_projects/rest_api/rest_api/application/views.py

@@ -0,0 +1,6 @@
+# from django.shortcuts import render
+# from rest_framework import viewsets
+# from rest_framework import permissions
+
+
+

holado_django/server/django_projects/rest_api/rest_api/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for server_rest_example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+
+application = get_asgi_application()

holado_django/server/django_projects/rest_api/rest_api/settings.py

@@ -0,0 +1,130 @@
+"""
+Django settings for server_rest_example project.
+
+Generated by 'django-admin startproject' using Django 5.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-(4nx+&@_ylqw(sa25syu5gdnu1q0bhyy69%*)^al_=2*%c*=ar'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'rest_framework',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'rest_api.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'rest_api.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.2/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
+    'PAGE_SIZE': 10
+}
+

holado_django/server/django_projects/rest_api/rest_api/urls.py

@@ -0,0 +1,35 @@
+"""
+URL configuration for server_rest_example project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+from rest_framework import routers
+from django.urls.conf import include
+from rest_api.application.apps import django_application_inst  # @UnresolvedImport
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+router = routers.DefaultRouter()
+if django_application_inst is not None:
+    django_application_inst.register_urls(router)
+    print(f"router urls: {router.urls}")
+else:
+    raise TechnicalException("Django application instance is not set")
+
+urlpatterns = [
+    path('', include(router.urls)),
+    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    path('admin/', admin.site.urls),
+]

holado_django/server/django_projects/rest_api/rest_api/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for server_rest_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+
+application = get_wsgi_application()