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

educommon/m3/extensions/listeners/__init__.py

@@ -1,4 +1,5 @@
 """Расширение поведения экшнов."""
+
 from m3.actions import (
     OperationResult,
 )
@@ -18,11 +19,10 @@ from educommon.m3.extensions.ui import (
 
 
 class DeclareContextListener:
-    """
-    Предок листенеров.
+    """Предок листенеров.
 
     Предоставляет возможность задекларировать дополнительный контекст
-    выполнения экшна
+    выполнения экшна.
     """
 
     def before(self, request, context):
@@ -64,15 +64,14 @@ class DeclareContextListener:
             # если контекст неправильный, то возвращаем
             # фейльный результат операции
             return OperationResult.by_message(
-                'Не удалось выполнить операцию. '
-                'Не задан обязательный<br>параметр: ' + e.reason
+                f'Не удалось выполнить операцию. Не задан обязательный<br>параметр: {e.reason}'
             )
+
         return context
 
 
 class BaseEditWinListener(DeclareContextListener):
-    """
-    Базовый листенер для расширения окна редактирования доп.полями и данными.
+    """Базовый листенер для расширения окна редактирования доп.полями и данными.
 
     Окно редактирования связано с определенной моделью, она - расширяемая и ее
     данные требуется дополнить с помощью доп.полей.
@@ -85,38 +84,32 @@ class BaseEditWinListener(DeclareContextListener):
     parent_model_field = None
 
     def _get_id(self, context):
-        """
-        Получение из контекста параметра, определяющего id расширяемой модели.
+        """Получение из контекста параметра, определяющего id расширяемой модели.
 
         :rype: int
         """
         raise NotImplementedError()
 
     def _get_instance(self, row_id):
-        """
-        Получение модели, которая расширяет основную ``ui_extender_cls.model``.
+        """Получение модели, которая расширяет основную ``ui_extender_cls.model``.
 
         :param row_id: идентификатор расширяемой модели
         :rtype: object
         """
         try:
-            instance = self.ui_extender_cls.model.objects.get(**{
-                self.parent_model_field: row_id
-            })
+            instance = self.ui_extender_cls.model.objects.get(**{self.parent_model_field: row_id})
         except self.ui_extender_cls.model.DoesNotExist:
             # расширяющая модель еще только создается
             return
+
         return instance
 
     def _get_params(self, instance, context):
         """Дополнение параметров."""
-        return {
-            'instance': instance
-        }
+        return {'instance': instance}
 
     def after(self, request, context, response):
-        """
-        Получение истанса модели, которая расширяет и биндинг ее в окно.
+        """Получение истанса модели, которая расширяет и биндинг ее в окно.
 
         :param request: Request
         :type request: django.http.HttpRequest
@@ -126,8 +119,7 @@ class BaseEditWinListener(DeclareContextListener):
         if not isinstance(response, ExtUIScriptResult):
             # не окно
             return
-        assert self.parent_model_field, (
-            'No parent model field defined in listener!')
+        assert self.parent_model_field, 'No parent model field defined in listener!'
         assert issubclass(self.ui_extender_cls, BaseEditWinExtender)
 
         # расширение интерфейса
@@ -151,8 +143,7 @@ class BaseEditWinListener(DeclareContextListener):
 
 
 class BaseSaveListener(DeclareContextListener):
-    """
-    Базовый класс листенеров сохранения доп.данных.
+    """Базовый класс листенеров сохранения доп.данных.
 
     Обращение к данному листенеру из экшна делается через
 
@@ -170,8 +161,7 @@ class BaseSaveListener(DeclareContextListener):
     parent_model_field = None
 
     def _get_instance(self, parent_model_instance, context):
-        """
-        Получение инстанса расширяющей модели.
+        """Получение инстанса расширяющей модели.
 
         Метод вынесен для возможности инстанцирования дополнительных
         зависимых моделей (относительно расширяющей модели ``instance``)
@@ -182,26 +172,21 @@ class BaseSaveListener(DeclareContextListener):
         :returns: инстанс расширяющей модели
         """
         try:
-            instance = self.ui_extender_cls.model.objects.get(**{
-                self.parent_model_field: parent_model_instance
-            })
+            instance = self.ui_extender_cls.model.objects.get(**{self.parent_model_field: parent_model_instance})
         except self.ui_extender_cls.model.DoesNotExist:
-            instance = self.ui_extender_cls.model(**{
-                self.parent_model_field: parent_model_instance
-            })
+            instance = self.ui_extender_cls.model(**{self.parent_model_field: parent_model_instance})
+
         return instance
 
     def post_save(self, arguments):
-        """
-        Точка входа для расширения из экшна self.handle('post_save', *).
+        """Точка входа для расширения из экшна self.handle('post_save', *).
 
         :param parent_model_instance: инстанс расширяемой модели
         :param context: Context
         :type context: m3.actions.context.DeclarativeActionContext
         """
         parent_model_instance, context = arguments
-        assert self.parent_model_field, (
-            'No parent model field defined in listener!')
+        assert self.parent_model_field, 'No parent model field defined in listener!'
         assert issubclass(self.ui_extender_cls, BaseEditWinExtender)
 
         instance = self._get_instance(parent_model_instance, context)
@@ -212,10 +197,9 @@ class BaseSaveListener(DeclareContextListener):
         return parent_model_instance, context
 
     def _save_instance(self, instance):
-        """
-        Сохранение расширяющей модели.
+        """Сохранение расширяющей модели.
 
-        Вынесено для возможности сохранения связанных/зависимых сущностей
+        Вынесено для возможности сохранения связанных/зависимых сущностей.
         """
         instance.full_clean()
         instance.save()

educommon/m3/extensions/listeners/delete_check/listeners.py

@@ -54,13 +54,9 @@ class DeleteCheck:
 
     def _get_message(self, objects):
         """Возвращает сообщение в правильном склонении."""
-        return (
-            'объекта' if len(objects) == 1 else 'объектов',
-            'него' if len(objects) == 1 else 'них'
-        )
+        return ('объекта' if len(objects) == 1 else 'объектов', 'него' if len(objects) == 1 else 'них')
 
-    def _setup_window(self, objects, related_objects, blocked=True,
-                      grid_id=None):
+    def _setup_window(self, objects, related_objects, blocked=True, grid_id=None):
         """Возвращает окно с сообщением о связанных объектах.
 
         :param objects: удаляемые объекты
@@ -70,28 +66,26 @@ class DeleteCheck:
         :return: CancelConfirmWindow
         """
         if blocked:
-            title = (
-                'Удаление {} невозможно, т.к. на {} есть ссылки:'
-                .format(*self._get_message(objects))
-            )
+            title = 'Удаление {} невозможно, т.к. на {} есть ссылки:'.format(*self._get_message(objects))
         else:
-            title = (
-                'При удалении {} будут удалены следующие связи:'
-                .format(self._get_message(objects)[0])
-            )
+            title = 'При удалении {} будут удалены следующие связи:'.format(self._get_message(objects)[0])
 
         win = CancelConfirmWindow()
-        win.set_params(dict(
-            title=title,
-            objects=objects,
-            related_objects=related_objects,
-            blocked=blocked,
-            grid_id=grid_id,
-        ))
+        win.set_params(
+            dict(
+                title=title,
+                objects=objects,
+                related_objects=related_objects,
+                blocked=blocked,
+                grid_id=grid_id,
+            )
+        )
         win.pack_action_url = self.action.get_absolute_url()
+
         return win
 
     def _get_objects(self, context):
+        """Получает удаляемые объекты из контекста."""
         model = self.action.parent.model
         if issubclass(model, ModelProxy):
             model = model.model
@@ -101,6 +95,11 @@ class DeleteCheck:
         return model.objects.filter(pk__in=object_ids)
 
     def before(self, request, context):
+        """Обрабатывает удаление с проверкой на наличие связанных объектов.
+
+        Если удаление невозможно или требует подтверждения, формирует окно
+        с предупреждением или подтверждением.
+        """
         if not isinstance(self.action, ObjectDeleteAction):
             return
 
@@ -111,11 +110,9 @@ class DeleteCheck:
             return
 
         if hasattr(self.action.parent, 'skip_field'):
+
             def skip_function(field):
-                return (
-                    self.action.parent.skip_field(field) or
-                    CascadeDeleteMixin.skip_field(field)
-                )
+                return self.action.parent.skip_field(field) or CascadeDeleteMixin.skip_field(field)
         else:
             skip_function = CascadeDeleteMixin.skip_field
 
@@ -128,19 +125,15 @@ class DeleteCheck:
 
         # Проверка блокирующих удаление связей
         for obj in objects:
-            for related_obj in get_related_instances_proxy(
-                obj, skip_function
-            ):
-                key = '.'.join((
-                    related_obj._meta.app_label,
-                    related_obj._meta.object_name,
-                ))
+            for related_obj in get_related_instances_proxy(obj, skip_function):
+                key = '.'.join(
+                    (
+                        related_obj._meta.app_label,
+                        related_obj._meta.object_name,
+                    )
+                )
                 related_objects[key].append(related_obj)
-        self.collect_implicit.send(
-            self.action.parent.model,
-            objects_to_delete=objects,
-            related_objects=related_objects
-        )
+        self.collect_implicit.send(self.action.parent.model, objects_to_delete=objects, related_objects=related_objects)
 
         if related_objects:
             win = self._setup_window(objects, related_objects)
@@ -148,10 +141,7 @@ class DeleteCheck:
             # Проверка не блокирующих удаление связей
             for obj in objects:
                 related_objects.update(get_non_block_relations(obj))
-            win = self._setup_window(
-                objects, related_objects, blocked=False,
-                grid_id=getattr(context, 'grid_id', None)
-            )
+            win = self._setup_window(objects, related_objects, blocked=False, grid_id=getattr(context, 'grid_id', None))
 
         if not related_objects:
             return

educommon/m3/extensions/listeners/delete_check/mixins.py

@@ -16,7 +16,6 @@ from educommon.m3.extensions.listeners.delete_check.utils import (
 
 
 class CascadeDeletePackMixin:
-
     """Mixin определяющий исключаемые поля модели при проверке DeleteCheck.
 
     Поскольку DeleteCheck срабатывает до вызова delete_row возникают ситуации,
@@ -26,21 +25,18 @@ class CascadeDeletePackMixin:
 
     .. code-block:: python
 
-        cascade_delete_objects = (
-            ( 'parent', 'parentportfolio', 'person'),
-        )
+        cascade_delete_objects = (('parent', 'parentportfolio', 'person'),)
     """
+
     # содержит кортежи формата
     # (имя приложения, имя модели приложения, имя поля)
     cascade_delete_objects = ()
 
     def _cascade_delete(self, obj_id, request, context):
-        for app_label, model_name, field_name in (
-                self.__class__.cascade_delete_objects):
+        """Удаляет связанные объекты, указанные в cascade_delete_objects."""
+        for app_label, model_name, field_name in self.__class__.cascade_delete_objects:
             model = get_model(app_label, model_name)
-            lookup = {
-                field_name + '_id': obj_id
-            }
+            lookup = {f'{field_name}_id': obj_id}
             for obj in model.objects.filter(**lookup):
                 if hasattr(obj, 'safe_delete') and callable(obj.safe_delete):
                     obj.safe_delete()
@@ -49,19 +45,20 @@ class CascadeDeletePackMixin:
 
     @classmethod
     def skip_field(cls, field):
+        """Определяет, следует ли исключить поле из проверки DeleteCheck."""
         if cls.cascade_delete_objects:
-            for app_label, model_name, field_name in (
-                    cls.cascade_delete_objects):
+            for app_label, model_name, field_name in cls.cascade_delete_objects:
                 model = get_model(app_label, model_name)
                 if field.name == field_name and field.model == model:
                     return True
+
         return False
 
     @atomic
     def delete_row(self, obj_id, request, context):
         self._cascade_delete(obj_id, request, context)
-        return super(CascadeDeletePackMixin, self).delete_row(
-            obj_id, request, context)
+
+        return super().delete_row(obj_id, request, context)
 
 
 class CascadeDeleteMixin:
@@ -81,19 +78,19 @@ class CascadeDeleteMixin:
        :caption: Пример использования
 
        class ModelA(CascadeDeleteMixin, models.Model):
-
            field = models.TextField()
 
-       class ModelB(models.Model):
 
+       class ModelB(models.Model):
            link = models.ForeignKey(ModelA)
            cascade_delete_for = (link,)
 
-       class ModelC(models.Model):
 
+       class ModelC(models.Model):
            link = models.ForeignKey(ModelA, on_delete=models.SET_NULL)
            cascade_delete_for = (link,)
 
+
        def some_func(obj):
            obj.link = ModelA()
            obj.link.save()
@@ -101,8 +98,8 @@ class CascadeDeleteMixin:
            # В случае, если ModelA и ModelD наследуются от ModelValidationMixin
            # то вместо вызова `save` должен быть метод `clean_and_save`
 
-       class ModelD(models.Model):
 
+       class ModelD(models.Model):
            link = models.ForeignKey(ModelA, on_delete=models.SET_NULL)
            cascade_delete_for = {link: {'on_delete': some_func}}
 
@@ -128,11 +125,10 @@ class CascadeDeleteMixin:
         :caption: Пример использования сингала pre_cascade
 
         class ModelA(CascadeDeleteMixin, models.Model):
-
             field = models.TextField()
 
-        class ModelB(ReadOnlyMixin, models.Model):
 
+        class ModelB(ReadOnlyMixin, models.Model):
             # Объекты изменяются только при изменениях, вызванных в
             # обработчиках сигналов на моделях-источниках
             _changed_from_signal = False
@@ -144,6 +140,7 @@ class CascadeDeleteMixin:
 
             link = models.ForeignKey(ModelA)
 
+
         @receiver(pre_cascade, sender=ModelB)
         def pre_cascade_delete(instance, **_):
             # Каскадное удаление по умолчанию удаление по сигналу.
@@ -152,9 +149,11 @@ class CascadeDeleteMixin:
 
     @staticmethod
     def skip_field(field):
+        """Проверяет, включено ли поле в каскадное удаление."""
         cascade_delete_for = getattr(field.model, 'cascade_delete_for', ())
         if isinstance(cascade_delete_for, dict):
             cascade_delete_for = tuple(cascade_delete_for.keys())
+
         return field in cascade_delete_for
 
     @atomic
@@ -163,13 +162,9 @@ class CascadeDeleteMixin:
         for obj, handler in get_related_instances_and_handlers(
             self, skip_func=lambda field: not self.skip_field(field)
         ):
-            params = dict(
-                sender=self._meta.model,
-                instance=obj,
-                initiator=self
-            )
+            params = dict(sender=self._meta.model, instance=obj, initiator=self)
             pre_cascade.send(**params)
             handler(obj)
             post_cascade.send(**params)
 
-        return super(CascadeDeleteMixin, self).safe_delete()
+        return super().safe_delete()

educommon/m3/extensions/listeners/delete_check/signals.py

@@ -6,5 +6,5 @@ from django.db.models.signals import (
 # Сигналы перед и после каскадного удаления объекта (CascadeDeleteMixin)
 #   - instance - удаляемый объект
 #   - initiator - объект, который стал инициатором удаления instance
-pre_cascade = ModelSignal(providing_args=["instance", "initiator"])
-post_cascade = ModelSignal(providing_args=["instance", "initiator"])
+pre_cascade = ModelSignal(providing_args=['instance', 'initiator'])
+post_cascade = ModelSignal(providing_args=['instance', 'initiator'])

educommon/m3/extensions/listeners/delete_check/ui.py

@@ -21,7 +21,6 @@ from educommon.utils.ui import (
 
 
 class RelatedObjectsWindow(BaseWindow):
-
     """Окно с информацией о зависимых объектах.
 
     Используется для отображения информации об объектах, зависящих от
@@ -40,7 +39,7 @@ class RelatedObjectsWindow(BaseWindow):
         return registries['related_objects']
 
     def _init_components(self):
-        super(RelatedObjectsWindow, self)._init_components()
+        super()._init_components()
 
         self.panel = ExtPanel(
             auto_scroll=True,
@@ -49,7 +48,8 @@ class RelatedObjectsWindow(BaseWindow):
         self.items.append(self.panel)
 
     def _do_layout(self):
-        super(RelatedObjectsWindow, self)._do_layout()
+        super()._do_layout()
+
         self.width = 800
         self.height = 600
 
@@ -57,8 +57,7 @@ class RelatedObjectsWindow(BaseWindow):
 
     def _get_html(self, title, objects, related_objects):
         views = tuple(
-            self.model_view_registry.get(model).get_view(objects)
-            for model, objects in related_objects.items()
+            self.model_view_registry.get(model).get_view(objects) for model, objects in related_objects.items()
         )
 
         return render_to_string(
@@ -70,7 +69,7 @@ class RelatedObjectsWindow(BaseWindow):
         )
 
     def set_params(self, params):
-        super(RelatedObjectsWindow, self).set_params(params)
+        super().set_params(params)
 
         self.title = 'Внимание!'
 
@@ -82,7 +81,6 @@ class RelatedObjectsWindow(BaseWindow):
 
 
 class CancelConfirmWindow(RelatedObjectsWindow):
-
     """Окно подтверждения удаления объекта и связанных с ним объектов.
 
     Содержит информацию об объектах, которые будут удалены при удалении
@@ -90,7 +88,7 @@ class CancelConfirmWindow(RelatedObjectsWindow):
     """
 
     def _init_components(self):
-        super(CancelConfirmWindow, self)._init_components()
+        super()._init_components()
 
         self.button__confirm = ext.ExtButton(
             text='Удалить',
@@ -102,15 +100,18 @@ class CancelConfirmWindow(RelatedObjectsWindow):
         )
 
     def _do_layout(self):
-        super(CancelConfirmWindow, self)._do_layout()
+        super()._do_layout()
 
-        self.buttons.extend((
-            self.button__confirm,
-            self.button__cancel,
-        ))
+        self.buttons.extend(
+            (
+                self.button__confirm,
+                self.button__cancel,
+            )
+        )
 
     def set_params(self, params):
-        super(CancelConfirmWindow, self).set_params(params)
+        super().set_params(params)
+
         self.template_globals = local_template('cancel-confirm-window.js')
 
         self.blocked = params.get('blocked', True)

educommon/m3/extensions/listeners/delete_check/utils.py

@@ -24,9 +24,7 @@ def get_related_instances_and_handlers(obj, skip_func=None):
             related_model = field.remote_field.through
             field_name = field.m2m_reverse_name()
 
-        related_objects = related_model.objects.filter(
-            **{field_name: obj}
-        )
+        related_objects = related_model.objects.filter(**{field_name: obj})
 
         on_delete_function = get_on_relation_delete_function(field)
         for related_obj in related_objects.iterator():
@@ -41,24 +39,19 @@ def get_on_relation_delete_function(field):
     возвращается функция, соответсвующая поведению, указанному в атрибуте
     `on_delete` поля.
     """
-    return (
-        get_custom_on_delete_function(field) or
-        get_field_on_delete_function(field)
-    )
+    return get_custom_on_delete_function(field) or get_field_on_delete_function(field)
 
 
 def get_custom_on_delete_function(field):
     """Возвращает функцию, указанную в cascade_delete_for для поля."""
-    if (
-        not hasattr(field.model, 'cascade_delete_for') or
-        not isinstance(field.model.cascade_delete_for, dict)
-    ):
+    if not hasattr(field.model, 'cascade_delete_for') or not isinstance(field.model.cascade_delete_for, dict):
         return None
 
     on_delete_params = {}
     for _field, _field_params in field.model.cascade_delete_for.items():
         if _field == field:
             on_delete_params = _field_params
+
     return on_delete_params.get('on_delete')
 
 
@@ -71,18 +64,23 @@ def get_field_on_delete_function(field):
         return safe_delete
 
     if on_delete_function == SET_NULL:
+
         def set_null(obj):
             setattr(obj, field.name, None)
             getattr(obj, 'clean_and_save', obj.save)()
+
         return set_null
 
     if on_delete_function == SET_DEFAULT:
+
         def set_default(obj):
             setattr(obj, field.name, field.default)
             getattr(obj, 'clean_and_save', obj.save)()
+
         return set_default
 
     # По-умолчанию остается поведение с безопасным удалением
     if hasattr(model, 'safe_delete') and callable(model.safe_delete):
         return model.safe_delete
+
     return safe_delete