educommon 3.13.0__py3-none-any.whl → 3.13.2__py3-none-any.whl

educommon/async_task/tasks.py

@@ -1,4 +1,5 @@
 """Базовые классы для асинхронных задач."""
+
 import time
 from datetime import (
     datetime,
@@ -166,8 +167,14 @@ class AsyncTask(Task):
             kwargs['is_replica'] = True
 
         async_result = super().apply_async(
-            args=args, kwargs=kwargs, task_id=task_id, producer=producer,
-            link=link, link_error=link_error, shadow=shadow, **options
+            args=args,
+            kwargs=kwargs,
+            task_id=task_id,
+            producer=producer,
+            link=link,
+            link_error=link_error,
+            shadow=shadow,
+            **options,
         )
 
         self.debug(f'Task {self.__name__} (id = {task_id}) added')
@@ -190,10 +197,7 @@ class AsyncTask(Task):
             'exc_type': '',
             'exc_message': '',
         }
-        self.update_state(
-            state=AsyncTaskStatus.to_state(AsyncTaskStatus.STARTED),
-            meta=self.state
-        )
+        self.update_state(state=AsyncTaskStatus.to_state(AsyncTaskStatus.STARTED), meta=self.state)
         self.set_read_from_replica(kwargs.get('is_replica', False))
 
         self.debug(f'Task {self.__name__} (id = {self.request.id}) started')
@@ -358,7 +362,7 @@ class UniquePeriodicAsyncTask(PeriodicAsyncTask):
 
     @property
     def locker_config(self) -> dict:
-        """Настройки для механизма блокировок. """
+        """Настройки для механизма блокировок."""
         return {
             'lock_params': {'task_name': self.name},
             'lock_message': f'Task [{self.__name__}] is running',

educommon/async_task/ui.py

@@ -83,34 +83,19 @@ class AsyncTaskResultViewWindow(BaseWindow):
         """Инициализация элементов окна."""
         super()._init_components()
 
-        self.top_region = ExtContainer(
-            region='north', layout='form', height=80, style={'padding': '5px'}
-        )
+        self.top_region = ExtContainer(region='north', layout='form', height=80, style={'padding': '5px'})
         self.center_region = ExtContainer(region='center', layout='fit', style={'padding': '5px'})
-        self.bottom_region = ExtContainer(
-            region='south',
-            layout='form',
-            height=150,
-            style={'padding': '5px'}
-        )
-        self.task_type_fld = ExtStringField(
-            anchor='100%', label='Тип', read_only=True)
-        self.description_fld = ExtStringField(
-            anchor='100%', label='Описание', read_only=True)
-        self.progress_fld = ExtStringField(
-            anchor='100%', label='Прогресс', read_only=True)
-        self.error_fld = ExtTextArea(
-            anchor='100%', label='Сообщение об ошибке', read_only=True)
-        self.state_fld = ExtStringField(
-            anchor='100%', label='Состояние задачи', read_only=True)
+        self.bottom_region = ExtContainer(region='south', layout='form', height=150, style={'padding': '5px'})
+        self.task_type_fld = ExtStringField(anchor='100%', label='Тип', read_only=True)
+        self.description_fld = ExtStringField(anchor='100%', label='Описание', read_only=True)
+        self.progress_fld = ExtStringField(anchor='100%', label='Прогресс', read_only=True)
+        self.error_fld = ExtTextArea(anchor='100%', label='Сообщение об ошибке', read_only=True)
+        self.state_fld = ExtStringField(anchor='100%', label='Состояние задачи', read_only=True)
         self.results_grid = ExtObjectGrid(
             title='Результаты',
             layout='fit',
         )
-        self.close_btn = ExtButton(
-            text='Закрыть',
-            handler='function() {win.close()}'
-        )
+        self.close_btn = ExtButton(text='Закрыть', handler='function() {win.close()}')
 
         # Кнопка "Отмена" не блокируется в режиме "только для чтения"
         self._mro_exclude_list.append(self.close_btn)
@@ -120,19 +105,15 @@ class AsyncTaskResultViewWindow(BaseWindow):
         super()._do_layout()
 
         self.layout = 'border'
-        self.items[:] = [
-            self.top_region,
-            self.center_region,
-            self.bottom_region
-        ]
+        self.items[:] = [self.top_region, self.center_region, self.bottom_region]
         self.center_region.items.append(self.results_grid)
-        self.bottom_region.items.extend([
-            self.progress_fld, self.state_fld, self.error_fld])
-        self.top_region.items.extend([
-            self.task_type_fld, self.description_fld])
-        self.buttons.extend([
-            self.close_btn,
-        ])
+        self.bottom_region.items.extend([self.progress_fld, self.state_fld, self.error_fld])
+        self.top_region.items.extend([self.task_type_fld, self.description_fld])
+        self.buttons.extend(
+            [
+                self.close_btn,
+            ]
+        )
 
     def _configure_results_grid(self, data: dict):
         """Конфигурирование грида с результатами задачи."""

educommon/async_tasks/__init__.py

@@ -1,4 +1,3 @@
 """Реестр "Асинхронные задачи"."""
 
-
 default_app_config = __name__ + '.apps.AppConfig'

educommon/async_tasks/apps.py

@@ -4,6 +4,10 @@ from django.apps import (
 
 
 class AppConfig(AppConfigBase):
+    """Конфигурация реестра "Асинхронные задачи".
+
+    Устанавливает имя и метку приложения для регистрации в системе Django.
+    """
 
     name = __package__
     label = 'async'

educommon/async_tasks/locks.py

@@ -32,12 +32,13 @@ class TaskLocker:
     task_id = None
     expire_on = DEFAULT_LOCK_EXPIRE
 
-    def __init__(self,
-                 task_name='',
-                 params={},
-                 task_id=None,
-                 expire_on=DEFAULT_LOCK_EXPIRE,
-                 ):
+    def __init__(
+        self,
+        task_name='',
+        params={},
+        task_id=None,
+        expire_on=DEFAULT_LOCK_EXPIRE,
+    ):
         self.task_name = task_name
         self.params = params
         self.task_id = task_id
@@ -50,21 +51,14 @@ class TaskLocker:
     @cached_property
     def lock_id(self) -> str:
         """Ключ в кэше."""
-        str_params = ['%s=%s' % (k, v) for k, v in self.params.items()]
-        return self.lock_id_format.format(
-            task_name=self.task_name,
-            params='&'.join(str_params)
-        )
+        str_params = [f'{k}={v}' for k, v in self.params.items()]
+        return self.lock_id_format.format(task_name=self.task_name, params='&'.join(str_params))
 
     def acquire_lock(self) -> None:
         """Установка блокировки."""
         value = self.task_id or 'true'
         cache.set(self.lock_id, value, self.expire_on)
-        self.debug(
-            'Lock acquired for Task %s (%s) with value: %s' % (
-                self.task_name, self.params, value
-            )
-        )
+        self.debug(f'Lock acquired for Task {self.task_name} ({self.params}) with value: {value}')
 
     def delete_lock(self) -> None:
         """Удаление блокировки."""
@@ -104,9 +98,5 @@ class TaskLocker:
         :raises: educommon.async_task.exceptions.TaskUniqueException
         """
         if self.is_locked():
-            self.debug(
-                'Add failed. Task %s currently locked (%s)' % (
-                    self.task_name, self.params
-                )
-            )
+            self.debug(f'Add failed. Task {self.task_name} currently locked ({self.params})')
             raise TaskUniqueException(message or self.DEFAULT_LOCK_MSG)

educommon/async_tasks/migrations/0001_initial.py

@@ -5,7 +5,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('contenttypes', '0001_initial'),
     ]
@@ -15,8 +14,21 @@ class Migration(migrations.Migration):
             name='AsyncTaskMeta',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('description', models.CharField(max_length=400, null=True, verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0437\u0430\u0434\u0430\u0447\u0438', blank=True)),
-                ('location', models.CharField(max_length=400, verbose_name='\u041f\u0443\u0442\u044c \u043a\u043b\u0430\u0441\u0441\u0430')),
+                (
+                    'description',
+                    models.CharField(
+                        max_length=400,
+                        null=True,
+                        verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0437\u0430\u0434\u0430\u0447\u0438',
+                        blank=True,
+                    ),
+                ),
+                (
+                    'location',
+                    models.CharField(
+                        max_length=400, verbose_name='\u041f\u0443\u0442\u044c \u043a\u043b\u0430\u0441\u0441\u0430'
+                    ),
+                ),
             ],
             options={
                 'verbose_name': '\u0414\u0430\u043d\u043d\u044b\u0435 \u0430\u0441\u0438\u043d\u0445\u0440\u043e\u043d\u043d\u043e\u0439 \u0437\u0430\u0434\u0430\u0447\u0438',
@@ -42,11 +54,59 @@ class Migration(migrations.Migration):
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
                 ('object_id', models.PositiveIntegerField(null=True, blank=True)),
                 ('task_id', models.CharField(max_length=36, verbose_name='ID \u0437\u0430\u0434\u0430\u0447\u0438')),
-                ('status', models.SmallIntegerField(default=1, db_index=True, verbose_name='\u0421\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0437\u0430\u0434\u0430\u0447\u0438', choices=[(1, '\u041d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043d\u043e'), (2, '\u0412 \u043e\u0447\u0435\u0440\u0435\u0434\u0438'), (3, '\u0412\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f'), (4, '\u0423\u0441\u043f\u0435\u0448\u043d\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d\u0430'), (5, '\u041e\u0441\u0442\u0430\u043d\u043e\u0432\u043b\u0435\u043d\u0430'), (6, '\u041e\u0448\u0438\u0431\u043a\u0430'), (7, '\u041f\u0435\u0440\u0435\u0437\u0430\u043f\u0443\u0441\u043a'), (8, '\u0418\u0433\u043d\u043e\u0440\u0438\u0440\u043e\u0432\u0430\u043d\u0430'), (9, '\u041e\u0442\u043c\u0435\u043d\u0435\u043d\u0430')])),
-                ('queued_on', models.DateTimeField(null=True, verbose_name='\u0421\u0442\u0430\u0440\u0442 \u0437\u0430\u0434\u0430\u0447\u0438', db_index=True)),
-                ('content_type', models.ForeignKey(blank=True, to='contenttypes.ContentType', null=True, on_delete=models.SET_NULL)),
-                ('task_meta', models.ForeignKey(verbose_name='\u0414\u0430\u043d\u043d\u044b\u0435 \u0437\u0430\u0434\u0430\u0447\u0438', blank=True, to='async.AsyncTaskMeta', null=True, on_delete=models.SET_NULL)),
-                ('task_type', models.ForeignKey(default=1, verbose_name='\u0422\u0438\u043f \u0437\u0430\u0434\u0430\u0447\u0438', to='async.AsyncTaskType', on_delete=models.CASCADE)),
+                (
+                    'status',
+                    models.SmallIntegerField(
+                        default=1,
+                        db_index=True,
+                        verbose_name='\u0421\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0437\u0430\u0434\u0430\u0447\u0438',
+                        choices=[
+                            (1, '\u041d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043d\u043e'),
+                            (2, '\u0412 \u043e\u0447\u0435\u0440\u0435\u0434\u0438'),
+                            (3, '\u0412\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f'),
+                            (
+                                4,
+                                '\u0423\u0441\u043f\u0435\u0448\u043d\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d\u0430',
+                            ),
+                            (5, '\u041e\u0441\u0442\u0430\u043d\u043e\u0432\u043b\u0435\u043d\u0430'),
+                            (6, '\u041e\u0448\u0438\u0431\u043a\u0430'),
+                            (7, '\u041f\u0435\u0440\u0435\u0437\u0430\u043f\u0443\u0441\u043a'),
+                            (8, '\u0418\u0433\u043d\u043e\u0440\u0438\u0440\u043e\u0432\u0430\u043d\u0430'),
+                            (9, '\u041e\u0442\u043c\u0435\u043d\u0435\u043d\u0430'),
+                        ],
+                    ),
+                ),
+                (
+                    'queued_on',
+                    models.DateTimeField(
+                        null=True,
+                        verbose_name='\u0421\u0442\u0430\u0440\u0442 \u0437\u0430\u0434\u0430\u0447\u0438',
+                        db_index=True,
+                    ),
+                ),
+                (
+                    'content_type',
+                    models.ForeignKey(blank=True, to='contenttypes.ContentType', null=True, on_delete=models.SET_NULL),
+                ),
+                (
+                    'task_meta',
+                    models.ForeignKey(
+                        verbose_name='\u0414\u0430\u043d\u043d\u044b\u0435 \u0437\u0430\u0434\u0430\u0447\u0438',
+                        blank=True,
+                        to='async.AsyncTaskMeta',
+                        null=True,
+                        on_delete=models.SET_NULL,
+                    ),
+                ),
+                (
+                    'task_type',
+                    models.ForeignKey(
+                        default=1,
+                        verbose_name='\u0422\u0438\u043f \u0437\u0430\u0434\u0430\u0447\u0438',
+                        to='async.AsyncTaskType',
+                        on_delete=models.CASCADE,
+                    ),
+                ),
             ],
             options={
                 'verbose_name': '\u0410\u0441\u0438\u043d\u0445\u0440\u043e\u043d\u043d\u0430\u044f \u0437\u0430\u0434\u0430\u0447\u0430',

educommon/async_tasks/migrations/0002_load_initial_data.py

@@ -14,7 +14,6 @@ APP_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('async', '0001_initial'),
     ]

educommon/async_tasks/models.py

@@ -1,4 +1,5 @@
 """Модели для асинхронных задач Celery."""
+
 from django.contrib.contenttypes.models import (
     ContentType,
 )
@@ -40,19 +41,11 @@ class AsyncTaskType(ModelValidationMixin, BaseObjectModel):
 class AsyncTaskMeta(ModelValidationMixin, BaseObjectModel):
     """Модель данных асинхронных задач."""
 
-    description = models.CharField(
-        max_length=400,
-        verbose_name='Описание задачи',
-        null=True,
-        blank=True
-    )
+    description = models.CharField(max_length=400, verbose_name='Описание задачи', null=True, blank=True)
 
     # путь класса от корня проекта, содержит имя модуля и название класса
     # пример для ЭДО: 'extedu.person.merge.tasks.MergeTask'
-    location = models.CharField(
-        max_length=400,
-        verbose_name='Путь класса'
-    )
+    location = models.CharField(max_length=400, verbose_name='Путь класса')
 
     class Meta:
         verbose_name = 'Данные асинхронной задачи'
@@ -67,12 +60,9 @@ class RunningTask(ModelValidationMixin, BaseObjectModel):
     # отображение пользователя, если пользователь не задан
     DEFAULT_USER = 'Система'
 
-    MSG_TASK_NOT_FOUND = (
-        'Информации не найдено! Возможно задача была удалена!')
+    MSG_TASK_NOT_FOUND = 'Информации не найдено! Возможно задача была удалена!'
 
-    content_type = models.ForeignKey(
-        ContentType, null=True, blank=True, on_delete=models.SET_NULL
-    )
+    content_type = models.ForeignKey(ContentType, null=True, blank=True, on_delete=models.SET_NULL)
     object_id = models.PositiveIntegerField(null=True, blank=True)
     user = GenericForeignKey()
     task_id = models.CharField(
@@ -80,28 +70,18 @@ class RunningTask(ModelValidationMixin, BaseObjectModel):
         verbose_name='ID задачи',
     )
     task_type = models.ForeignKey(
-        AsyncTaskType,
-        default=AsyncTaskType.TASK_UNKNOWN,
-        verbose_name='Тип задачи',
-        on_delete=models.CASCADE
+        AsyncTaskType, default=AsyncTaskType.TASK_UNKNOWN, verbose_name='Тип задачи', on_delete=models.CASCADE
     )
     task_meta = models.ForeignKey(
-        AsyncTaskMeta,
-        verbose_name='Данные задачи',
-        null=True,
-        blank=True,
-        on_delete=models.SET_NULL
+        AsyncTaskMeta, verbose_name='Данные задачи', null=True, blank=True, on_delete=models.SET_NULL
     )
     status = models.SmallIntegerField(
-        choices=statuses.STATUS_CHOICES,
-        default=statuses.STATUS_PENDING,
-        verbose_name='Состояние задачи',
-        db_index=True
+        choices=statuses.STATUS_CHOICES, default=statuses.STATUS_PENDING, verbose_name='Состояние задачи', db_index=True
     )
     queued_on = models.DateTimeField(
         verbose_name='Старт задачи',
         db_index=True,
-        null=True  # null - если задача ещё не в работе
+        null=True,  # null - если задача ещё не в работе
     )
 
     class Meta:

educommon/async_tasks/tasks.py

@@ -1,4 +1,5 @@
 """Базовые классы для асинхронных задач."""
+
 import logging
 from collections import (
     OrderedDict,
@@ -39,8 +40,7 @@ class AsyncTask(Task):
         logger = logging.getLogger('educommon.async')
         logger.debug(*args, **kwargs)
 
-    def apply_async(self, args=None, kwargs=None, task_id=None, producer=None,
-                    link=None, link_error=None, **options):
+    def apply_async(self, args=None, kwargs=None, task_id=None, producer=None, link=None, link_error=None, **options):
         """Постановка задачи в очередь.
 
         автор задачи задаётся снаружи через 2 поля в словаре kwargs:
@@ -49,35 +49,27 @@ class AsyncTask(Task):
         if kwargs is None:
             kwargs = {}
 
-        async_result = super(AsyncTask, self).apply_async(
-            args=args, kwargs=kwargs, task_id=task_id, producer=producer,
-            link=link, link_error=link_error, **options
+        async_result = super().apply_async(
+            args=args, kwargs=kwargs, task_id=task_id, producer=producer, link=link, link_error=link_error, **options
         )
 
         location = self.__class__.__module__ + '.' + self.__class__.__name__
-        task_meta = models.AsyncTaskMeta.objects.create(
-            location=location,
-            description=self.description
-        )
+        task_meta = models.AsyncTaskMeta.objects.create(location=location, description=self.description)
         params = dict(
             task_meta=task_meta,
             status=statuses.STATUS_RECEIVED,
             object_id=kwargs.get('object_id'),
             content_type=kwargs.get('content_type'),
-            task_type_id=kwargs.get(
-                'task_type', models.AsyncTaskType.TASK_UNKNOWN
-            ),
+            task_type_id=kwargs.get('task_type', models.AsyncTaskType.TASK_UNKNOWN),
             # время начала задачи
             # для случая, когда celery успевает начать задачу ещё до
             # коммита в БД создаваемой здесь models.RunningTask
-            queued_on=datetime.now()
+            queued_on=datetime.now(),
         )
 
-        models.RunningTask.objects.get_or_create(
-            task_id=async_result.task_id, defaults=params
-        )
+        models.RunningTask.objects.get_or_create(task_id=async_result.task_id, defaults=params)
 
-        self.debug("Task %s added" % self.__name__)
+        self.debug(f'Task {self.__name__} added')
 
         return async_result
 
@@ -90,23 +82,19 @@ class AsyncTask(Task):
             # описание результата
             'description': self.description,
             # прогресс выполнения задачи
-            'progress': 'Неизвестно'
+            'progress': 'Неизвестно',
         }
-        self.update_state(
-            state=statuses.get_state_str(statuses.STATUS_STARTED),
-            meta=self.state
-        )
-        self.debug("Task %s run (task_id = %s )" % (
-            self.__name__, self.request.id))
+        self.update_state(state=statuses.get_state_str(statuses.STATUS_STARTED), meta=self.state)
+        self.debug(f'Task {self.__name__} run (task_id = {self.request.id} )')
+
         return {}
 
     def after_return(self, status, retval, task_id, args, kwargs, einfo):
         """Завершение задачи."""
-        self.debug("Task %s completed" % self.__name__)
+        self.debug(f'Task {self.__name__} completed')
 
         if isinstance(retval, dict):
-            self.update_state(
-                state=retval.get('task_state', status), meta=retval)
+            self.update_state(state=retval.get('task_state', status), meta=retval)
         else:
             self.update_state(state=status, meta=retval)
 
@@ -120,19 +108,15 @@ class AsyncTask(Task):
         if task_id is None:
             task_id = self.request.id
 
-        running_task = models.RunningTask.objects.filter(
-            task_id=task_id
-        ).order_by('queued_on').first()
+        running_task = models.RunningTask.objects.filter(task_id=task_id).order_by('queued_on').first()
 
         if not running_task:
             return
 
         if state == states.SUCCESS:
-            self.state['values']['Время выполения'] = (
-                datetime.now() - running_task.queued_on)
+            self.state['values']['Время выполения'] = datetime.now() - running_task.queued_on
 
-        super(AsyncTask, self).update_state(
-            task_id=task_id, state=state, meta=meta)
+        super().update_state(task_id=task_id, state=state, meta=meta)
 
         running_task.status = statuses.get_status_idx(state)
 
@@ -141,8 +125,7 @@ class AsyncTask(Task):
             running_task.queued_on = datetime.now()
         running_task.clean_and_save()
 
-    def set_progress(self, task_id=None, task_state=states.STARTED,
-                     progress=None, values=None):
+    def set_progress(self, task_id=None, task_state=states.STARTED, progress=None, values=None):
         """Обновление состояния выполнения задачи.
 
         :param str task_id: id задачи celery
@@ -236,11 +219,12 @@ class LockableAsyncTask(AsyncTask):
                 # UUID задачи
                 task_id,
                 # время жизни
-                lock_expire
+                lock_expire,
             )
             locker.raise_if_locked(message)
 
             locker.acquire_lock()
+
             return locker.lock_id
 
     def _validate_lock_data(self, lock_data):
@@ -250,16 +234,7 @@ class LockableAsyncTask(AsyncTask):
         """
         pass
 
-    def apply_async(
-            self,
-            args=None,
-            kwargs={},
-            task_id=None,
-            producer=None,
-            link=None,
-            link_error=None,
-            **options
-    ):
+    def apply_async(self, args=None, kwargs={}, task_id=None, producer=None, link=None, link_error=None, **options):
         """Постановка в очередь.
 
         Для задач, реализующих уникальность, метод выбрасывает исключение.
@@ -279,21 +254,17 @@ class LockableAsyncTask(AsyncTask):
         kwargs.update(lock_id=lock_id)
 
         async_result = super().apply_async(
-            args=args, kwargs=kwargs, task_id=task_id, producer=producer,
-            link=link, link_error=link_error, **options
+            args=args, kwargs=kwargs, task_id=task_id, producer=producer, link=link, link_error=link_error, **options
         )
 
         return async_result
 
     def after_return(self, status, retval, task_id, args, kwargs, einfo):
         """Завершение задачи"""
-        super().after_return(
-            status, retval, task_id, args, kwargs, einfo
-        )
+        super().after_return(status, retval, task_id, args, kwargs, einfo)
         # снимаем блокировку
         lock_id = kwargs.get('lock_id')
         if lock_id:
             # задача завершена, убрать лок
-            self.debug("Unlock task %s lock_id = %s" % (
-                self.__name__, lock_id))
+            self.debug(f'Unlock task {self.__name__} lock_id = {lock_id}')
             self._locker_class.delete_lock_by_id(lock_id)

educommon/audit_log/__init__.py

@@ -47,6 +47,7 @@
     - __str__()
 Для каждой модели проекта желательно добавить/изменить один из данных методов.
 """
+
 import django