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

educommon/m3/extensions/ui.py

@@ -1,4 +1,5 @@
 """Расширение поведения интерфейсов."""
+
 from m3_ext.ui import (
     all_components as ext,
 )
@@ -9,8 +10,7 @@ from objectpack.ui import (
 
 
 class BaseEditWinExtender:
-    """
-    Базовый объект для расширения окон редактирования.
+    """Базовый объект для расширения окон редактирования.
 
     ``_extend_edit_win`` - добавление и размещение контролов
     ``bind_to_object`` - заполнение объекта данными из полей формы
@@ -31,39 +31,31 @@ class BaseEditWinExtender:
         self._extend_edit_win()
 
     def _extend_edit_win(self):
-        """
-        Расширение формы окна.
+        """Расширение формы окна.
 
         ..code::
 
             for fld in self.model_fields_to_controls(self.model_fields):
                 self._win.form.items.append(fld)
-
         """
         raise NotImplementedError()
 
     def model_fields_to_controls(self, fields):
         """Шорткат для генерации контролов."""
         assert self.model, 'No model defined in Extender!'
-        return model_fields_to_controls(
-            self.model,
-            self._win,
-            field_list=fields,
-            model_register=self.model_register
-        )
+        return model_fields_to_controls(self.model, self._win, field_list=fields, model_register=self.model_register)
 
     # -------------------------------------------------------------------------
     # Биндинг из формы в объект
 
     @classmethod
     def set_value(cls, instance, field_names, value):
-        """
-        Установка значения поля (полей).
+        """Установка значения поля (полей).
 
         :param instance: инстанс модели, которая расширяет основную ``model``
         :param list field_names: список связаных полей (либо одно поле)
         :raise: DoesNotExist если предварительно не инстанцировали зависимые
-        сущности (для случая связанных полей)
+        сущности (для случая связанных полей).
         """
         if len(field_names) == 1:
             # связанных полей нет
@@ -76,15 +68,13 @@ class BaseEditWinExtender:
 
     @classmethod
     def bind_to_object(cls, instance, context):
-        """
-        Заполнение полей ``model_fields`` модели instance по полям формы.
+        """Заполнение полей ``model_fields`` модели instance по полям формы.
 
         :param instance: инстанс модели, которая расширяет основную ``model``
         :param context: контекст
         :type context: m3.actions.context.DeclarativeActionContext
         """
-        assert cls.model_fields is not None, (
-            'No model_fields defined in Extender')
+        assert cls.model_fields is not None, 'No model_fields defined in Extender'
 
         for field_name in cls.model_fields:
             try:
@@ -99,13 +89,11 @@ class BaseEditWinExtender:
     # Биндинг из объекта в форму
 
     def bind_from_object(self, instance):
-        """
-        Заполнение полей ``model_fields`` формы по полям модели instance.
+        """Заполнение полей ``model_fields`` формы по полям модели instance.
 
         :param instance: инстанс модели, которая расширяет основную ``model``
         """
-        assert self.model_fields is not None, (
-            'No model_fields defined in Extender')
+        assert self.model_fields is not None, 'No model_fields defined in Extender'
         for name in self.model_fields:
             field = self._win.find_by_name(name)
             field_names = field.name.split('.')
@@ -114,8 +102,7 @@ class BaseEditWinExtender:
                 self._set_value_to_field(field, value)
 
     def _get_value(self, instance, field_names):
-        """
-        Получение значение поля (полей).
+        """Получение значение поля (полей).
 
         :param instance: инстанс модели, которая расширяет основную ``model``
         :param list field_names: список связаных полей (либо одно поле)
@@ -132,8 +119,7 @@ class BaseEditWinExtender:
 
     @staticmethod
     def _set_value_to_field(field, value):
-        """
-        Установка значения в поле.
+        """Установка значения в поле.
 
         :param field: наследник BaseExtField
         :param value: значение для установки в поле
@@ -145,22 +131,18 @@ class BaseEditWinExtender:
                 if isinstance(field, ext.ExtMultiSelectField):
                     field.value = pack.model.get_serialized_values(value)
                 else:
-                    field.default_text = pack.get_display_text(
-                        value, field.display_field)
+                    field.default_text = pack.get_display_text(value, field.display_field)
         elif isinstance(field, ext.ExtCheckBox):
             field.checked = bool(value)
 
     def set_params(self, params):
-        """
-        Установка параметров компонентам.
+        """Установка параметров компонентам.
 
         Выполняется по завершению создания компонент, размещению на форме и
         после биндинга значений в форму.
 
         ..code::
 
-            self._win.field__some.make_read_only(
-                access_off=params['instance'].date > datetime.date.today()
-            )
+            self._win.field__some.make_read_only(access_off=params['instance'].date > datetime.date.today())
         """
         pass

educommon/m3/transaction_context.py

@@ -29,6 +29,7 @@ with TransactionCM('user_import'):
             user.set_password(pwd)
             user.save()
 """
+
 from functools import (
     wraps,
 )
@@ -58,27 +59,25 @@ def _prepare_state():
     if not hasattr(_state, 'situation'):
         _reset_state()
 
+
 _reset_state()
 
 
 class AbortTransaction(Exception):
-    """
-    Исключение, прерывающее текущий CM (SavePointCM/TransactionCM).
+    """Исключение, прерывающее текущий CM (SavePointCM/TransactionCM).
+
     Поймав это исключение CM откатывает изменения,
     произошедшие с момента входа в него и корректно завершается.
     """
+
     pass
 
 
 class SavePointCM:
-    """
-    Context Manager создающий на время своего действия savepoint
-    """
+    """Context Manager создающий на время своего действия savepoint."""
 
     def __init__(self):
-        assert _state.situation, (
-            'Must be nested in TransactionCM!'
-        )
+        assert _state.situation, 'Must be nested in TransactionCM!'
         cookie = uuid4()
         _state.cookies.append(cookie)
         self._cookie = cookie
@@ -103,15 +102,11 @@ class SavePointCM:
 
 
 class TransactionCM:
-    """
-    ContextManager создающий "ручную" транзакцию
-    """
+    """ContextManager создающий "ручную" транзакцию."""
 
     def __init__(self, situation, rollback_all=True, using=None):
         _prepare_state()
-        assert not _state.situation, (
-            'Nested contexts not supported!'
-        )
+        assert not _state.situation, 'Nested contexts not supported!'
         _reset_state()
         _state.situation = self._situation = situation
 
@@ -126,10 +121,10 @@ class TransactionCM:
         try:
             if ex_type is None:
                 try:
-                    for (task, cookie) in _state.task_queue:
+                    for task, cookie in _state.task_queue:
                         if cookie not in _state.rolled_back:
                             task()
-                except Exception as e:
+                except Exception:
                     transaction.rollback(self._using)
                     _reset_state()
                     raise
@@ -149,22 +144,25 @@ class TransactionCM:
 
 
 def delay_in_situations(*situations):
-    """
-    Оборачивает функцию и возвращает функцию-обработчик сигнала Django.
+    """Оборачивает функцию и возвращает функцию-обработчик сигнала Django.
+
     В контексте одной из ситуаций, перечисленных в @situations
     выполнение функции, возвращённой оборачиваемой функцией,
     будет отложено до успешного завершения TransactionCM, создавшего ситуацию.
     """
+
     def wrapper(fn):
         @wraps(fn)
         def inner(*args, **kwargs):
             cont = fn(*args, **kwargs)
-            assert callable(cont), "Task must return the callable object!"
+            assert callable(cont), 'Task must return the callable object!'
             situation = getattr(_state, 'situation', None)
             if not situation or situation not in situations:
                 cont()
             else:
                 cookie = (_state.cookies or [None])[-1]
                 _state.task_queue.append((cont, cookie))
+
         return inner
+
     return wrapper

educommon/objectpack/actions.py

@@ -60,12 +60,11 @@ class BaseGridPack(BasePack):
 
     @property
     def id_param_name(self):
-        return '%s_id' % self.short_name
+        return f'{self.short_name}_id'
 
     @property
     def grid_panel(cls):
-        """
-        Класс панели с гридом.
+        """Класс панели с гридом.
 
         .. note::
             Вынесено в метод для случая, когда пак работает с гридом,
@@ -74,14 +73,14 @@ class BaseGridPack(BasePack):
         return cls.window.grid_panel_cls
 
     def __init__(self):
-        super(BaseGridPack, self).__init__()
+        super().__init__()
+
         self.grid_action = BaseGridCreateAction()
         self.window_action = BaseGridWinAction()
         self.actions.extend([self.grid_action, self.window_action])
 
     def create_columns(self, request, context):
-        """
-        Метод возвращающий колонки.
+        """Метод возвращающий колонки.
 
         .. seealso:: objectpack.actions.ObjectPack.columns
 
@@ -90,18 +89,17 @@ class BaseGridPack(BasePack):
         return []
 
     def create_grid(self, columns):
-        """
-        Создание грида.
+        """Создание грида.
 
         :param list columns: список колонок
         :rtype: m3_ext.ui.ExtObjectGrid
         """
         grid = self.grid_panel.create_grid(pack=self, columns=columns)
+
         return grid
 
     def set_grid_params(self, grid, request, context):
-        """
-        Настройка параметров для конфигурации грида.
+        """Настройка параметров для конфигурации грида.
 
         Параметры грида передаются панели с гридом в метод configure_grid.
         :param grid: грид
@@ -115,11 +113,12 @@ class BaseGridPack(BasePack):
         """
         # пак для настройки грида (column_param_name, id_param_name, url_data)
         params = {'pack': self}
+
         return params
 
     def configure_grid(self, grid, request, context):
-        """
-        Метод конфигурирования грида после его создания.
+        """Метод конфигурирования грида после его создания.
+
         :param grid: грид
         :type grid: m3_ext.ui.ExtObjectGrid
         :param request: Запрос
@@ -129,34 +128,31 @@ class BaseGridPack(BasePack):
         """
         params = self.set_grid_params(grid, request, context)
         grid = self.grid_panel.configure_grid(grid, params)
+
         return grid
 
     def get_grid_action_url(self):
-        """
-        Получение адреса экшна построения грид.
+        """Получение адреса экшна построения грид.
 
         :rtype: str
         """
         return self.grid_action.get_absolute_url()
 
     def get_rows_url(self):
-        """
-        Получение адреса экшна, возвращающего строки грида.
+        """Получение адреса экшна, возвращающего строки грида.
 
         Должен быть определен в потомке.
         :rtype: str
         """
-        raise NotImplementedError(
-            "Не определен метод get_rows_url() "
-            "в %s!" % self.__class__.__name__)
+        raise NotImplementedError(f'Не определен метод get_rows_url() в {self.__class__.__name__}!')
 
     def create_window(self, request, context):
         """Получение окна."""
         return self.window()
 
     def get_window_params(self, request, context):
-        """
-        Параметры для показа окна
+        """Параметры для показа окна.
+
         :param request: Запрос
         :type request: django.http.HttpRequest
         :param context: Контекст
@@ -170,8 +166,9 @@ class BaseGridPack(BasePack):
         """
         params = {
             # пак отвечающий за получения грида окном
-            "grid_pack": self
+            'grid_pack': self
         }
+
         return params
 
 
@@ -185,6 +182,7 @@ class BaseGridCreateAction(BaseAction):
         columns = pack.create_columns(request, context)
         grid = pack.create_grid(columns)
         pack.configure_grid(grid, request, context)
+
         return ExtUIComponentResult(grid)
 
 
@@ -197,15 +195,14 @@ class BaseGridWinAction(BaseWindowAction):
         self.win = self.parent.create_window(self.request, self.context)
 
     def set_window_params(self):
-        super(BaseGridWinAction, self).set_window_params()
-        self.win_params = self.parent.get_window_params(
-            self.request, self.context)
+        super().set_window_params()
+
+        self.win_params = self.parent.get_window_params(self.request, self.context)
 
 
 class ExtObjectRowsAction(ObjectRowsAction):
     def get_total_count(self):
-        """
-        В отличие от оригинала убирает из запроса лишнюю обработку даных.
+        """В отличие от оригинала убирает из запроса лишнюю обработку данных.
 
         :return: Количество объектов в выборке
         :rtype: int
@@ -214,10 +211,10 @@ class ExtObjectRowsAction(ObjectRowsAction):
 
 
 class RelationsCheckMixin:
-    """
-    Миксин для экшенов удаления и редактирования, проверяющий наличие
-    ссылок на редактируемый/удаляемый объект и выводящий данную информацию
-    в табличном виде.
+    """Миксин для экшенов удаления и редактирования.
+
+    Проверяет наличие ссылок на редактируемый/удаляемый объект
+    и выводящий данную информацию в табличном виде.
     """
 
     # Описание настроек отображения информации для каждой модели.
@@ -229,8 +226,7 @@ class RelationsCheckMixin:
     err_msg = 'На объект "{obj}" есть ссылки:'
     render_template_name = 'relations-check-mixin-template.html'
 
-    def __init__(self, rel_conf=None, rel_list=None,
-                 rel_ignore_list=None, err_msg=None, *args, **kwargs):
+    def __init__(self, rel_conf=None, rel_list=None, rel_ignore_list=None, err_msg=None, *args, **kwargs):
         """
         :param rel_conf: настройки отображения
         :type dict
@@ -265,28 +261,21 @@ class RelationsCheckMixin:
             self.rel_ignore_list = rel_ignore_list
         if err_msg:
             self.err_msg = err_msg
-        super(RelationsCheckMixin, self).__init__(*args, **kwargs)
+
+        super().__init__(*args, **kwargs)
 
     def _get_relations_to_check(self):
         """Получение всех связанных моделей для проверки."""
         model = self._get_check_model()
         opts = ModelOptions(model)
-        all_related_objects = [
-            rel_obj.relation for rel_obj in opts.get_all_related_objects()
-        ]
+        all_related_objects = [rel_obj.relation for rel_obj in opts.get_all_related_objects()]
         result = all_related_objects[:]
 
         if self.rel_ignore_list:
-            result = [
-                rel for rel in all_related_objects
-                if rel.field.model.__name__ not in self.rel_ignore_list
-            ]
+            result = [rel for rel in all_related_objects if rel.field.model.__name__ not in self.rel_ignore_list]
 
         if self.rel_list:
-            result = [
-                rel for rel in all_related_objects
-                if rel.field.model.__name__ in self.rel_list
-            ]
+            result = [rel for rel in all_related_objects if rel.field.model.__name__ in self.rel_list]
 
         return result
 
@@ -295,11 +284,10 @@ class RelationsCheckMixin:
 
         def _extract_proxy_from_model(model):
             """Если получена не модель, а прокси, то извлекает из него модель.
+
             Функция рекурсивна, т.к. возможны прокси на прокси.
             """
-            if issubclass(model, ModelProxy) and hasattr(
-                model, 'model'
-            ):
+            if issubclass(model, ModelProxy) and hasattr(model, 'model'):
                 model = _extract_proxy_from_model(model.model)
             elif model._meta.proxy:
                 # прокси django
@@ -314,11 +302,12 @@ class RelationsCheckMixin:
         ids = getattr(context, self.parent.id_param_name, [])
         if isinstance(ids, int):
             ids = [ids]
+
         return self._get_check_model().objects.filter(id__in=ids)
 
     def collect_related_objects(self, request, context):
-        """
-        Получение списка связанных объектов
+        """Получение списка связанных объектов.
+
         :param request: Запрос
         :type request: django.http.HttpRequest
         :param context: Контекст
@@ -336,26 +325,25 @@ class RelationsCheckMixin:
         for obj in objects:
             assert isinstance(obj, model)
 
-            object_relations = result.setdefault(obj.id, {
-                'object': obj,
-                'relations': [],
-                'err_msg': self.err_msg.format(
-                    model_verbose=model._meta.verbose_name.capitalize(),
-                    obj=obj,
-                ),
-            })
+            object_relations = result.setdefault(
+                obj.id,
+                {
+                    'object': obj,
+                    'relations': [],
+                    'err_msg': self.err_msg.format(
+                        model_verbose=model._meta.verbose_name.capitalize(),
+                        obj=obj,
+                    ),
+                },
+            )
 
             for rel in relations:
-                assert getattr(
-                    rel, 'parent_model', getattr(rel, 'model')
-                ) == model
+                assert getattr(rel, 'parent_model', getattr(rel, 'model')) == model
 
                 rel_model_name = rel.field.model.__name__
                 conf = self.rel_conf.get(rel_model_name, {})
 
-                query = rel.field.model.objects.filter(
-                    **{str(rel.field.attname): obj.pk}
-                )
+                query = rel.field.model.objects.filter(**{str(rel.field.attname): obj.pk})
                 if conf.get('get_query'):
                     query = conf['get_query'](query, obj)
 
@@ -367,14 +355,15 @@ class RelationsCheckMixin:
                 objects = [display(o) for o in query]
 
                 if count:
-                    object_relations['relations'].append({
-                        'model': rel.field.model,
-                        'title': (conf.get('title') or
-                                  rel.field.model._meta.verbose_name),
-                        'columns': conf.get('columns'),
-                        'objects': objects,
-                        'count': count,
-                    })
+                    object_relations['relations'].append(
+                        {
+                            'model': rel.field.model,
+                            'title': (conf.get('title') or rel.field.model._meta.verbose_name),
+                            'columns': conf.get('columns'),
+                            'objects': objects,
+                            'count': count,
+                        }
+                    )
 
         return dict(
             items=[v for v in result.values() if v['relations']],
@@ -382,8 +371,8 @@ class RelationsCheckMixin:
         )
 
     def pre_run(self, request, context):
-        """
-        Вывод окна отчета
+        """Вывод окна отчета.
+
         :param request: Запрос
         :type request: django.http.HttpRequest
         :param context: Контекст
@@ -391,13 +380,11 @@ class RelationsCheckMixin:
 
         """
 
-        super(RelationsCheckMixin, self).pre_run(request, context)
+        super().pre_run(request, context)
 
-        related_objects_data = self.collect_related_objects(
-            request, context)
+        related_objects_data = self.collect_related_objects(request, context)
 
         if related_objects_data['items']:
-
             html = render_to_string(
                 self.render_template_name,
                 related_objects_data,
@@ -406,10 +393,7 @@ class RelationsCheckMixin:
             win = ui.RelatedErrorWindow()
             win.set_params(params)
 
-            return OperationResult(
-                success=False,
-                code=win.get_script()
-            )
+            return OperationResult(success=False, code=win.get_script())
 
 
 class ViewWindowPackMixin:
@@ -419,16 +403,14 @@ class ViewWindowPackMixin:
     """
 
     def create_edit_window(self, create_new, request, context):
-        window = super(ViewWindowPackMixin, self).create_edit_window(
-            create_new, request, context
-        )
+        window = super().create_edit_window(create_new, request, context)
+
         window.make_read_only()
+
         return window
 
     def create_list_window(self, is_select_mode, request, context):
-        window = super(ViewWindowPackMixin, self).create_list_window(
-            is_select_mode, request, context
-        )
+        window = super().create_list_window(is_select_mode, request, context)
 
         reconfigure_grid_by_access(window.grid)
 

educommon/objectpack/apps.py

@@ -4,6 +4,11 @@ from django.apps import (
 
 
 class EduObjectPackConfig(AppConfig):
+    """Конфигурация приложения educommon.objectpack.
+
+    Определяет имя, метку и читаемое имя Django-приложения,
+    содержащего расширения и дополнения к objectpack.
+    """
 
     name = 'educommon.objectpack'
     label = 'educommon_objectpack'