utg-base 1.3.2__py3-none-any.whl → 1.5.0__py3-none-any.whl

utg_base/api/permissions.py

@@ -0,0 +1,11 @@
+from rest_framework.permissions import BasePermission
+
+
+class IsSuperUser(BasePermission):
+    """
+    Custom permission to allow access only to superusers.
+    """
+
+    def has_permission(self, request, view):
+        # Check if the requesting user is a superuser
+        return request.user and request.user.is_superuser

utg_base/celery/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class QApiConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "utg_base.celery"

utg_base/celery/filters/__init__.py

@@ -0,0 +1 @@
+from .task_result import TaskResultFilterSet

utg_base/celery/filters/task_result.py

@@ -0,0 +1,5 @@
+from django_filters import rest_framework as filters
+
+
+class TaskResultFilterSet(filters.FilterSet):
+    status = filters.BooleanFilter()

utg_base/celery/management/commands/migrate_tasks.py

@@ -0,0 +1,45 @@
+import importlib
+import json
+
+from django.core.management.base import BaseCommand
+from django_celery_beat.models import CrontabSchedule, PeriodicTask
+
+
+class Command(BaseCommand):
+    help = "Migrate tasks"
+
+    def add_arguments(self, parser):
+        parser.add_argument('--app', type=str, help="An optional argument", required=True)
+
+    def handle(self, *args, **options):
+        try:
+            tasks = importlib.import_module(f"{options['app']}.tasks")
+            tasks = tasks.tasks
+            for task in tasks:
+                celery_task, _ = PeriodicTask.objects.update_or_create(
+                    name=task['name'],
+                    defaults={
+                        'crontab': self.get_crontab_schedule(task['crontab']),
+                        'task': task['task'].name,
+                        'args': json.dumps(task.get('args') or []),
+                        'kwargs': json.dumps(task.get('kwargs') or {}),
+                        'enabled': task.get('enabled', True),
+                    }
+                )
+            self.stdout.write(
+                self.style.SUCCESS('Successfully migrated tasks')
+            )
+        except ModuleNotFoundError:
+            self.stdout.write(self.style.ERROR("Tasks module not found"))
+
+    @staticmethod
+    def get_crontab_schedule(crontab='* * * * *'):
+        minute, hour, day_of_month, month_of_year, day_of_week = crontab.split(' ')
+        cron, _ = CrontabSchedule.objects.get_or_create(
+            minute=minute,
+            hour=hour,
+            day_of_month=day_of_month,
+            month_of_year=month_of_year,
+            day_of_week=day_of_week,
+        )
+        return cron

utg_base/celery/serializers/__init__.py

@@ -0,0 +1,2 @@
+from .task_result import TaskResultSerializer
+from .periodic_task import PeriodicTaskSerializer

utg_base/celery/serializers/periodic_task.py

@@ -0,0 +1,38 @@
+from django_celery_beat.models import PeriodicTask, CrontabSchedule
+from django_celery_results.models import TaskResult
+from rest_framework import serializers
+
+
+from utg_base.celery.serializers import TaskResultSerializer
+
+
+class CrontabScheduleSerializer(serializers.ModelSerializer):
+    timezone = serializers.SerializerMethodField()
+
+    class Meta:
+        model = CrontabSchedule
+        fields = '__all__'
+
+    def get_timezone(self, obj):
+        return str(obj.timezone) if obj.timezone else None
+
+
+class PeriodicTaskSerializer(serializers.ModelSerializer):
+    crontab = CrontabScheduleSerializer(read_only=True)
+    task_result = serializers.SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = PeriodicTask
+        fields = '__all__'
+        read_only_fields = ['name', 'task', 'args', 'kwargs', 'queue', 'exchange', 'routing_key', 'headers', 'priority',
+                            'expires', 'expire_seconds', 'one_off', 'start_time', 'interval', 'solar', 'clocked']
+
+    def get_task_result(self, obj):
+        latest_task_result = TaskResult.objects.filter(
+            periodic_task_name=obj.name
+        ).order_by('-date_created').first()
+
+        if not latest_task_result:
+            return None
+
+        return TaskResultSerializer(latest_task_result).data

utg_base/celery/serializers/task_result.py

@@ -0,0 +1,8 @@
+from django_celery_results.models import TaskResult
+from rest_framework import serializers
+
+
+class TaskResultSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = TaskResult
+        fields = '__all__'

utg_base/celery/urls.py

@@ -0,0 +1,14 @@
+from django.urls import path
+
+from utg_base.api.routers import OptionalSlashRouter
+from utg_base.celery.views import TaskResultViewSet, PeriodicTaskViewSet, PeriodicTaskRunNowView
+
+router = OptionalSlashRouter()
+router.register('task-results', TaskResultViewSet, basename='task-results')
+router.register('periodic-tasks', PeriodicTaskViewSet, basename='periodic-tasks')
+
+urlpatterns = [
+    path('periodic-tasks/<pk>/run-now/', PeriodicTaskRunNowView.as_view(), name='periodic-tasks-run-now'),
+]
+
+urlpatterns += router.urls

utg_base/celery/views/__init__.py

@@ -0,0 +1,2 @@
+from .periodic_task import PeriodicTaskViewSet, PeriodicTaskRunNowView
+from .task_result import TaskResultViewSet

utg_base/celery/views/periodic_task.py

@@ -0,0 +1,56 @@
+import json
+
+from celery import current_app
+from django_celery_beat.models import PeriodicTask
+from drf_spectacular.utils import extend_schema
+from rest_framework import viewsets, filters
+from rest_framework.exceptions import NotFound, ValidationError
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from utg_base.api.permissions import IsSuperUser
+from utg_base.celery.serializers import PeriodicTaskSerializer
+from utg_base.utils.translation import translate as _
+
+
+@extend_schema(tags=['admin/periodic-tasks'])
+class PeriodicTaskViewSet(viewsets.ModelViewSet):
+    http_method_names = ['get', 'patch']
+    queryset = PeriodicTask.objects.all()
+    serializer_class = PeriodicTaskSerializer
+    permission_classes = [IsSuperUser]
+    filter_backends = [filters.SearchFilter]
+    search_fields = ['name']
+
+
+@extend_schema(tags=['admin/periodic-tasks'])
+class PeriodicTaskRunNowView(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def patch(self, request, pk):
+        try:
+            periodic_task = PeriodicTask.objects.get(pk=pk)
+        except PeriodicTask.DoesNotExist:
+            raise NotFound(detail=_("Periodic task not found"))
+
+        if not periodic_task.enabled:
+            raise ValidationError(detail=_("Task is disabled"))
+
+        args = json.loads(periodic_task.args) if periodic_task.args else []
+        kwargs = json.loads(periodic_task.kwargs) if periodic_task.kwargs else {}
+
+        task = current_app.send_task(
+            periodic_task.task,
+            args=args,
+            kwargs=kwargs,
+            countdown=0,
+            headers = {'periodic_task_name': periodic_task.name}
+        )
+
+        return Response({
+            "detail": _("Task successfully triggered"),
+            "task_id": task.id,
+            "task_name": periodic_task.name,
+            "celery_task": periodic_task.task,
+        })

utg_base/celery/views/task_result.py

@@ -0,0 +1,18 @@
+import django_filters
+from django_celery_results.models import TaskResult
+from drf_spectacular.utils import extend_schema
+from rest_framework import viewsets, filters
+
+from utg_base.celery.filters import TaskResultFilterSet
+from utg_base.api.permissions import IsSuperUser
+from utg_base.celery.serializers import TaskResultSerializer
+
+
+@extend_schema(tags=['admin/task-results'])
+class TaskResultViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = TaskResult.objects.all()
+    serializer_class = TaskResultSerializer
+    permission_classes = [IsSuperUser]
+    filterset_class = TaskResultFilterSet
+    filter_backends = [filters.SearchFilter, django_filters.rest_framework.DjangoFilterBackend]
+    search_fields = ['name']

utg_base/env.py

@@ -0,0 +1,27 @@
+import os
+
+import dotenv
+import hvac
+from django.conf import settings
+
+dotenv.load_dotenv(settings.BASE_DIR / '.env')
+
+client = hvac.Client(
+    url=os.environ.get("VAULT_URL"),
+    token=os.environ.get("VAULT_TOKEN"),
+    verify=False
+)
+if not client.is_authenticated():
+    raise Exception("Vault authentication failed")
+
+envs = client.secrets.kv.read_secret_version(
+    path=os.environ.get("VAULT_PATH"),
+    mount_point="utg-scada"
+)['data']['data']
+
+
+def env(key, default=None):
+    if key in os.environ:
+        return os.environ.get(key, default)
+    else:
+        return envs.get(key, default)

utg_base/logging.py

@@ -21,7 +21,6 @@ class UtgBaseFilter(logging.Filter):
 
 
 class UtgBaseLogging:
-    enable_file = int(os.environ.get('LOGGING_FILE', False))
     enable_console_info = int(os.environ.get('LOGGING_CONSOLE_INFO', True))
     enable_db_debug = int(os.environ.get('LOGGING_DB_DEBUG', False))
     enable_loki = int(os.environ.get('LOGGING_LOKI', True))
@@ -51,13 +50,6 @@ class UtgBaseLogging:
             },
         },
         'handlers': {
-            'file': {
-                'level': 'ERROR',
-                'class': 'logging.FileHandler',
-                'filename': 'logs/django-error.log',
-                'formatter': 'simple',
-                'filters': ['trim_path'],
-            },
             'console_info': {
                 'level': 'INFO',
                 'class': 'logging.StreamHandler',
@@ -114,8 +106,6 @@ class UtgBaseLogging:
     def logging(cls):
         _logging = cls.__LOGGING.copy()
 
-        if cls.enable_file:
-            _logging['loggers']['django']['handlers'].append('file')
         if cls.enable_console_info:
             _logging['loggers']['django']['handlers'].append('console_info')
         if cls.enable_db_debug:

utg_base/models/__init__.py

@@ -1 +1,2 @@
 from .jwt_user import JWTUser
+from .timestamp import BaseTimestamp

utg_base/models/timestamp.py

@@ -0,0 +1,9 @@
+from django.db import models
+
+
+class BaseTimestamp(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True

utg_base/utils/data.py

@@ -24,13 +24,24 @@ def deep_map(data: dict | list, func_cond, func_map, in_place=True):
     return data
 
 
-def deep_round(data: dict | list, ndigits: int, in_place=True):
-    return deep_map(data, lambda value: isinstance(value, float), lambda value: round(value, ndigits), in_place)
+def to_numeric_or_none(*args):
+    _is_iterable = isinstance(args[0], Iterable) and not isinstance(args[0], str)
+    if _is_iterable:
+        args = args[0]
+    result = []
+
+    for x in args:
+        if isinstance(x, (int, float, complex, bool)):
+            result.append(x)
+        else:
+            result.append(None)
+    if not _is_iterable and len(result) == 1 and len(args) == 1:
+        return result[0]
+    return result
 
 
 def safe_sum(*args, allow_null=True):
-    if isinstance(args[0], Iterable):
-        args = args[0]
+    args = to_numeric_or_none(*args)
 
     if all(arg is None for arg in args):
         return None
@@ -44,8 +55,7 @@ def safe_sum(*args, allow_null=True):
 
 
 def safe_subtract(*args, allow_null=False):
-    if isinstance(args[0], Iterable):
-        args = args[0]
+    args = to_numeric_or_none(*args)
 
     if all(arg is None for arg in args):
         return None
@@ -56,3 +66,37 @@ def safe_subtract(*args, allow_null=False):
     for arg in args[1:]:
         _sum -= arg or 0
     return _sum
+
+
+def safe_multiply(*args, allow_null=False):
+    args = to_numeric_or_none(*args)
+
+    if all(arg is None for arg in args):
+        return None
+    if not allow_null and any(arg is None for arg in args):
+        return None
+
+    result = 1
+    for arg in args:
+        value = 0 if allow_null and arg is None else arg
+        result *= value
+    return result
+
+
+def safe_divide(*args, allow_null=False):
+    args = to_numeric_or_none(*args)
+
+    if all(arg is None for arg in args):
+        return None
+    if not allow_null and any(arg is None for arg in args):
+        return None
+
+    result = 0 if allow_null and args[0] is None else args[0]
+
+    for arg in args[1:]:
+        value = 0 if allow_null and arg is None else arg
+        if value == 0:
+            return None
+        result /= value
+
+    return result

{utg_base-1.3.2.dist-info → utg_base-1.5.0.dist-info}/METADATA

@@ -1,17 +1,22 @@
 Metadata-Version: 2.1
 Name: utg-base
-Version: 1.3.2
+Version: 1.5.0
 Summary: UTG Base Package
 Author: Rovshen
 Author-email: rovshenashirov1619@gmail.com
 Requires-Python: >=3.14,<4.0
 Classifier: Programming Language :: Python :: 3
+Requires-Dist: celery (>=5.5.3,<6.0.0)
 Requires-Dist: croniter (>=2.0.3,<3.0.0)
 Requires-Dist: django (>=5.2.7,<6.0.0)
+Requires-Dist: django-celery-beat (>=2.8.1,<3.0.0)
+Requires-Dist: django-celery-results (>=2.6.0,<3.0.0)
 Requires-Dist: django-filter (>=23.5,<24.0)
 Requires-Dist: djangorestframework (>=3.16.1,<4.0.0)
 Requires-Dist: djangorestframework-simplejwt[crypto] (>=5.5.1,<6.0.0)
+Requires-Dist: dotenv (>=0.9.9,<0.10.0)
 Requires-Dist: drf-spectacular[sidecar] (>=0.29.0,<0.30.0)
+Requires-Dist: hvac (>=2.4.0,<3.0.0)
 Requires-Dist: inflect (>=7.2.1,<8.0.0)
 Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
 Description-Content-Type: text/markdown

{utg_base-1.3.2.dist-info → utg_base-1.5.0.dist-info}/RECORD

@@ -2,19 +2,36 @@ utg_base/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 utg_base/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 utg_base/api/base.py,sha256=giGKC68sL1j1NQbbkhIWzhHPcPlvjTPG2evra-xAJ3s,2574
 utg_base/api/pagination.py,sha256=zzIUwW3iF5G_11gFsno9y1DmgFiULQIWRHUj0LKhYfE,854
+utg_base/api/permissions.py,sha256=RjkxYWPl5Xwgk5lIZrcBzIAwlXolX5XPlae1jr-Ln2w,323
 utg_base/api/routers.py,sha256=lU54MVN2BF_q1AWp9EdXkG3m_ivYRtvbNGXFIRKz7u0,177
 utg_base/api/serializers.py,sha256=qI6wWjwl1oeUPHCJUCpYFIaiRFvfQW6FM0xPC9fwfQI,1214
 utg_base/api/views.py,sha256=yYCEJRouFA71cI2Ubc1A736oLg9NGWyTIVnD-Q85k6w,279
 utg_base/authentications/__init__.py,sha256=a6twO_bBf8FAHYl7PXawfR2UbBwwdueG1uS_dbq2g_I,109
 utg_base/authentications/microservice_authentication.py,sha256=6aAncxIpA4FcyRegd7QqRYvW5Wn8FxyPU0nQqCVuEs4,976
 utg_base/authentications/models.py,sha256=JQonSdXeSeoF003QlmPvH58nWmVJRKlWWjW_ySqXaYg,2496
+utg_base/celery/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+utg_base/celery/apps.py,sha256=eL9Il9gGLrtZtXOxWgQK1j8JH5g677h_He7Z1ldUiuA,151
+utg_base/celery/filters/__init__.py,sha256=wnkV8cPEvvHIl8OoMTv7fvSglDSFY8XxpCjUveRNUyg,45
+utg_base/celery/filters/task_result.py,sha256=iXgOrXrO8bvF9S47D53UzsdWQr_JrJ-LtxdjPfcTVjA,138
+utg_base/celery/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+utg_base/celery/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+utg_base/celery/management/commands/migrate_tasks.py,sha256=TAvPmYAmMkODdPAucbQDya2dd-BkVFCvWJrolqFdz6w,1667
+utg_base/celery/serializers/__init__.py,sha256=NjQ4dcnyoX9p5ljUBCjDegTKt7icia48GkVSmFCK9Ao,96
+utg_base/celery/serializers/periodic_task.py,sha256=lQShBqUQUOvk6-VQocyGfATZHAAVrng-w6_VjD3_WH4,1298
+utg_base/celery/serializers/task_result.py,sha256=pt6BRjjvqU1Ah8IUSyL67AZJ1Z5iXAelYe6z-Pv1Nco,220
+utg_base/celery/urls.py,sha256=ww-ZwAzK0CnOZxqh4gaEYGuRoCgkrolB3jvKsLZEknI,524
+utg_base/celery/views/__init__.py,sha256=WPNtK_40JCSYGWkDgtpTdOWJ_GOp_dBKs9eK4VNq5Xs,114
+utg_base/celery/views/periodic_task.py,sha256=OyRJh_-KCicUZD84hksRoOXLHGk7mLF7QlsjncqvQac,1945
+utg_base/celery/views/task_result.py,sha256=c9HIcohrToRfz1jfZRRZ1ri15FOasjKgMYnzKcA2X8M,726
 utg_base/constants/__init__.py,sha256=nC8qE-2V6APtjSz8j0A-3ez8yyoRpdRO8pwQnvvpRMk,53
 utg_base/constants/available_languages.py,sha256=zQh0S0PMuYUdRW_RH36llvMxbvsfbdUtotDjFeysWfQ,56
-utg_base/logging.py,sha256=MNPUQ9Hdg-0YTFlJBOwhajqKz-8Y5P4POkqRNIU9ga8,5078
+utg_base/env.py,sha256=1Ljxt9clniKl_P2FKG9eoU-7lj00iLHKWDcSVd8wBD4,603
+utg_base/logging.py,sha256=6mqhirIz5p1ne3av4S8j02TD5lJ4HyDKvMQsfUJ62po,4667
 utg_base/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 utg_base/middleware/locale.py,sha256=1hp_T_VuHCz0ITjwJ_F1rpf5kXQ0ulEmK1yoRWD1GRc,557
-utg_base/models/__init__.py,sha256=ylLp_n2WJqvmuG-4X8yv119Ikcx-OFSYHUcnggUeQeo,30
+utg_base/models/__init__.py,sha256=1zXygGICiR3iUCKdkNal9d3i3kNp654gFgBf_VlR2gI,67
 utg_base/models/jwt_user.py,sha256=6TQ5wB_OZBtGhRL-2MonBGZm0n0Y86s4BRTxiRlUJOk,375
+utg_base/models/timestamp.py,sha256=AkCliNXnvs8Z17b1mcS7gOK7v6h3Jul6WCyGyVAkb-w,217
 utg_base/references_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 utg_base/references_api/admin.py,sha256=suMo4x8I3JBxAFBVIdE-5qnqZ6JAZV0FESABHOSc-vg,63
 utg_base/references_api/apps.py,sha256=thAGmO-ZT-OD9dHHBSQRL_RRt-Es_jt-mEmHgVTpERs,168
@@ -25,12 +42,12 @@ utg_base/references_api/utils.py,sha256=VzQMnGeWC0I-6BkK_9Lo9eSH6wd4C766oQ84n7SB
 utg_base/services/__init__.py,sha256=LqtwUiqEZPIbKRGJfve5D5m3ucV6Kw1Nbo5Jnj_hPhY,37
 utg_base/services/base_api.py,sha256=RBwzO6frYs2TeMKkAohUxtH9JhDTgmb9G5BFijajg68,5207
 utg_base/utils/__init__.py,sha256=5XmIPVpOl9Tjtzkx_bBeZD1uCpBE-R3WX6yiJii9Ip0,101
-utg_base/utils/data.py,sha256=XmGJStl2f5Bx2B5F45KOUlyS7JkxYiVdWu66_RA_sWQ,1635
+utg_base/utils/data.py,sha256=luD1L8RwAtvs-qraQMJ2K34fZTlGZy1PvClNeF_Ei-s,2661
 utg_base/utils/date.py,sha256=thcbK6RgTUYZfs4_vW5ucuu2e8H0rei6tv7SEC72iwM,3612
 utg_base/utils/dict_util.py,sha256=ipdCZO8aTukGQ319OWHb2Ij5MNtV-FioJQ4qCX3Th48,758
 utg_base/utils/response_processors.py,sha256=WdZQL49wOJqCIY2MucAI6sez_llCqih0v_ltQa-mv7k,687
 utg_base/utils/sql.py,sha256=rqIWcSjdjIMszdRnsnhV5TTYB8W17RPOujIQA9rKC_Y,762
 utg_base/utils/translation.py,sha256=HAUB64h0Maw82ehCoi0Yb6V6gj1Y5l5RMsv8_FMoV2U,456
-utg_base-1.3.2.dist-info/METADATA,sha256=l3-bW6rMxuC_4bQtj6PGK-9Rndx2pwQHkTtmypb0-D0,660
-utg_base-1.3.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-utg_base-1.3.2.dist-info/RECORD,,
+utg_base-1.5.0.dist-info/METADATA,sha256=E-cHB0OHYpNnWjOuSBCW-H5dxE8EtirNZOLsTn3gJXE,881
+utg_base-1.5.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+utg_base-1.5.0.dist-info/RECORD,,