utg-base 1.3.1__py3-none-any.whl → 1.4.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,4 @@
+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/utils/response_processors.py

@@ -1,6 +1,8 @@
 from requests import Response
 
 
+# noinspection PyDecorator
+@staticmethod
 def call_processor(response: Response):
     try:
         data = response.json()
@@ -13,6 +15,8 @@ def call_processor(response: Response):
     }
 
 
+# noinspection PyDecorator
+@staticmethod
 def data_processor(response: Response):
     try:
         data = response.json()

{utg_base-1.3.1.dist-info → utg_base-1.4.0.dist-info}/METADATA

@@ -1,13 +1,16 @@
 Metadata-Version: 2.1
 Name: utg-base
-Version: 1.3.1
+Version: 1.4.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)

{utg_base-1.3.1.dist-info → utg_base-1.4.0.dist-info}/RECORD

@@ -2,12 +2,27 @@ 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=L2xbYvFZa3FitjiVD6HwA0vwdOCD0ofUez_rVx68Ozo,116
+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
@@ -28,9 +43,9 @@ utg_base/utils/__init__.py,sha256=5XmIPVpOl9Tjtzkx_bBeZD1uCpBE-R3WX6yiJii9Ip0,10
 utg_base/utils/data.py,sha256=XmGJStl2f5Bx2B5F45KOUlyS7JkxYiVdWu66_RA_sWQ,1635
 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=Eim0NIbCt2GH_grzrD6DHqr5iczCHfu1wr9lqThlX3U,605
+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.1.dist-info/METADATA,sha256=_VWqPBkJ0EoajvscvSsD_68Pm4siuvCLFDKgyCd7nWI,660
-utg_base-1.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-utg_base-1.3.1.dist-info/RECORD,,
+utg_base-1.4.0.dist-info/METADATA,sha256=MjQxUE3JqEN6wiA75E8t86l2uL22z9nbuLEwmjUxkK8,804
+utg_base-1.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+utg_base-1.4.0.dist-info/RECORD,,