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

educommon/auth/rbac/models.py

@@ -1,11 +1,11 @@
 # pylint: disable=no-init
 """Модели для хранения данных системы авторизации RBAC."""
+
 from django.contrib.contenttypes.models import (
     ContentType,
 )
 from django.core.exceptions import (
     NON_FIELD_ERRORS,
-    FieldDoesNotExist,
     ValidationError,
 )
 from django.db import (
@@ -77,7 +77,8 @@ class Permission(BaseModel):
     title = models.CharField(
         'Название',
         max_length=200,
-        blank=True, null=True,
+        blank=True,
+        null=True,
     )
     description = models.TextField(
         'Описание',
@@ -161,17 +162,21 @@ class Role(CascadeDeleteMixin, BaseModel):
         return result
 
     def simple_clean(self, errors):
-        super(Role, self).simple_clean(errors)
+        """Проверка бизнес-логики роли.
 
-        if (self.pk and not self.can_be_assigned and
-                self.userrole_set.exists()):
-            errors['can_be_assigned'].append(
-                'Есть пользователи, которым назначана роль "{}" '.format(
-                    self.name
-                )
-            )
+        Запрещает отключение флага `can_be_assigned`, если роль уже назначена пользователям.
+        """
+        super().simple_clean(errors)
+
+        if self.pk and not self.can_be_assigned and self.userrole_set.exists():
+            errors['can_be_assigned'].append('Есть пользователи, которым назначана роль "{}" '.format(self.name))
+
+    def safe_delete(self) -> bool:
+        """Безопасное удаление роли и связанных с ней связей.
 
-    def safe_delete(self):
+        Удаляет связи роли с разрешениями и родителями. Если возникает
+        ошибка целостности, возвращает False.
+        """
         # safe_delete неправильно работает внутри транзакций, из-за этого
         # при вызове commit() валится IntegrityError, который надо обрабатывать
         # вручную.
@@ -221,23 +226,22 @@ class RoleUserType(BaseModel):
         verbose_name_plural = 'Типы пользователей ролей'
 
     def simple_clean(self, errors):
-        super(RoleUserType, self).simple_clean(errors)
+        """Проверка соответствия типа пользователя и роли.
+
+        Запрещает назначение роли пользователям, если:
+        - роль не может быть назначена;
+        - тип пользователя не входит в допустимые типы.
+        """
+        super().simple_clean(errors)
 
         from educommon.auth.rbac.config import (
             rbac_config,
         )
 
         if not self.role.can_be_assigned:
-            errors['role'].append(
-                'Роль "{}" не может назначаться пользователям'.format(
-                    self.role.name
-                )
-            )
+            errors['role'].append('Роль "{}" не может назначаться пользователям'.format(self.role.name))
 
-        if (
-            rbac_config.user_types and
-            self.user_type.model_class() not in rbac_config.user_types
-        ):
+        if rbac_config.user_types and self.user_type.model_class() not in rbac_config.user_types:
             errors['role'].append(
                 'Роль "{}" не может быть назначена типу "{}".'.format(
                     self.role.name,
@@ -266,16 +270,11 @@ class RoleUserType(BaseModel):
 
         if instance.user_types.exists():
             errors[NON_FIELD_ERRORS].append(
-                'Для снятия флага "Может быть назначена пользователя", '
-                'необходимо отвязать все типы пользователей.'
+                'Для снятия флага "Может быть назначена пользователя", необходимо отвязать все типы пользователей.'
             )
 
 
-post_clean.connect(
-    receiver=RoleUserType.clean_role,
-    sender=Role,
-    dispatch_uid='RoleUserType.clean_role'
-)
+post_clean.connect(receiver=RoleUserType.clean_role, sender=Role, dispatch_uid='RoleUserType.clean_role')
 
 
 class RolePermission(BaseModel):
@@ -302,8 +301,7 @@ class RolePermission(BaseModel):
         db_table = 'rbac_role_permissions'
 
     def __str__(self):
-        return 'Роль: {}; Разрешение: {}'.format(
-            self.role.name, self.permission.title)
+        return 'Роль: {}; Разрешение: {}'.format(self.role.name, self.permission.title)
 
 
 @receiver(pre_delete, sender=RolePermission)
@@ -316,10 +314,12 @@ def protect_role_edit_permission(instance, **kwargs):
     if (
         not RolePermission.objects.filter(
             permission__name=PERM__ROLE__EDIT,
-        ).exclude(
+        )
+        .exclude(
             id=instance.pk,
-        ).exists() and
-        instance.permission.name == PERM__ROLE__EDIT
+        )
+        .exists()
+        and instance.permission.name == PERM__ROLE__EDIT
     ):
         raise ApplicationLogicException(
             'Роль "{role}" является единственной ролью в Cистеме, в которой '
@@ -327,8 +327,7 @@ def protect_role_edit_permission(instance, **kwargs):
             'возможность настройки ролей, поэтому удаление из неё этого '
             'разрешения невозможно. Для удаления разрешения "{permission}" '
             'из роли "{role}" сначала назначьте данное разрешение любой '
-            'другой роли в системе.'
-            .format(
+            'другой роли в системе.'.format(
                 role=instance.role.name,
                 permission=get_permission_full_title(instance.permission.name),
             )
@@ -338,25 +337,24 @@ def protect_role_edit_permission(instance, **kwargs):
 class RoleParent(BaseModel):
     """M2M-модель "Вложенная роль"."""
 
-    parent = models.ForeignKey(
-        Role, related_name='+', on_delete=models.CASCADE
-    )
-    role = models.ForeignKey(
-        Role, related_name='+', on_delete=models.CASCADE
-    )
+    parent = models.ForeignKey(Role, related_name='+', on_delete=models.CASCADE)
+    role = models.ForeignKey(Role, related_name='+', on_delete=models.CASCADE)
 
     cascade_delete_for = (parent, role)
     display_related_error = False
 
     def simple_clean(self, errors):
-        super(RoleParent, self).simple_clean(errors)
+        """Валидация вложенности роли.
+
+        Проверяет:
+        - роль не может быть вложена сама в себя;
+        - отсутствие циклов в иерархии ролей.
+        """
+        super().simple_clean(errors)
 
         if self.parent.id == self.role.id:
-            errors['parent'].append(
-                'Роль не может содержать сама себя'
-            )
+            errors['parent'].append('Роль не может содержать сама себя')
 
-        # ---------------------------------------------------------------------
         # Проверка отсутствия цикла
         query = RoleParent.objects.all()
         if self.pk:
@@ -373,12 +371,9 @@ class RoleParent(BaseModel):
             check(self.role, self.parent)
         except ValidationError as error:
             errors['parent'].extend(error.messages)
-        # ---------------------------------------------------------------------
 
     def __str__(self):
-        return 'RoleParent({} --> {})'.format(
-            str(self.role), str(self.parent)
-        )
+        return 'RoleParent({} --> {})'.format(str(self.role), str(self.parent))
 
     class Meta:
         unique_together = ('parent', 'role')
@@ -419,37 +414,37 @@ class UserRole(DateIntervalMixin, BaseModel, metaclass=UserRoleMeta):
 
     def __str__(self):
         return 'UserRole({} --> {})'.format(
-            str(self.user), str(self.role),
+            str(self.user),
+            str(self.role),
         )
 
-    def interval_intersected_error_message(self, others=None):
-        return (
-            'Роль "{}" уже назначена этому пользователю в указанном '
-            'интервале дат.'.format(self.role.name)
-        )
+    def interval_intersected_error_message(self, others=None) -> str:
+        """Сообщение об ошибке при пересечении интервалов действия роли."""
+        return 'Роль "{}" уже назначена этому пользователю в указанном интервале дат.'.format(self.role.name)
 
     def simple_clean(self, errors):
-        super(UserRole, self).simple_clean(errors)
+        """Валидация бизнес-логики при назначении роли пользователю.
+
+        Проверяет:
+        - возможность назначения роли;
+        - доступность роли для указанного типа пользователя.
+        """
+        super().simple_clean(errors)
 
         if not self.role.can_be_assigned:
-            errors['role'].append(
-                'Роль "{}" не может быть назначена пользователю'.format(
-                    self.role.name
-                )
-            )
+            errors['role'].append('Роль "{}" не может быть назначена пользователю'.format(self.role.name))
 
         if (
-            config.rbac_config.user_types and
-            self.role_id and
-            self.content_type_id and
-            not RoleUserType.objects.filter(
+            config.rbac_config.user_types
+            and self.role_id
+            and self.content_type_id
+            and not RoleUserType.objects.filter(
                 role_id=self.role_id,
                 user_type_id=self.content_type_id,
             ).exists()
         ):
             errors['role'].append(
-                'Роль "{}" не доступна для назначения '
-                'пользователям типа "{}".'.format(
+                'Роль "{}" не доступна для назначения пользователям типа "{}".'.format(
                     self.role.name,
                     self.content_type.name,
                 )

educommon/auth/rbac/permissions.py

@@ -6,13 +6,12 @@ PERM__ROLE__EDIT = PERM_ROLE_EDIT = PERM_GROUP__ROLE + '/edit'
 
 
 permissions = (
-    (PERM__ROLE__VIEW,
-     'Просмотр ролей',
-     'Разрешает просмотр имеющихся в системе ролей.'),
-    (PERM__ROLE__EDIT,
-     'Редактирование ролей',
-     'Разрешает создавать/изменять/удалять роли и назначать ролям '
-     'разрешения.'),
+    (PERM__ROLE__VIEW, 'Просмотр ролей', 'Разрешает просмотр имеющихся в системе ролей.'),
+    (
+        PERM__ROLE__EDIT,
+        'Редактирование ролей',
+        'Разрешает создавать/изменять/удалять роли и назначать ролям разрешения.',
+    ),
 )
 # -----------------------------------------------------------------------------
 

educommon/auth/rbac/ui.py

@@ -79,7 +79,7 @@ class RolesTree(BaseObjectTree):
     """
 
     def __init__(self, *args, **kwargs):
-        super(RolesTree, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
         # Меню "Добавить"
         self.top_bar.button_add_to_role = ExtContextMenuItem(
@@ -87,9 +87,7 @@ class RolesTree(BaseObjectTree):
             icon_cls='add_item',
             handler='topBarAddToRole',
         )
-        self.top_bar.add_menu.menu.items.append(
-            self.top_bar.button_add_to_role
-        )
+        self.top_bar.add_menu.menu.items.append(self.top_bar.button_add_to_role)
 
         # Меню "Удалить"
         self.top_bar.items.remove(self.top_bar.button_delete)
@@ -105,49 +103,43 @@ class RolesTree(BaseObjectTree):
         )
 
         menu = ExtContextMenu()
-        menu.items.extend((
-            self.top_bar.button_delete_from_role,
-            self.top_bar.button_delete,
-        ))
-        self.top_bar.delete_menu = ExtToolbarMenu(
-            icon_cls="delete_item",
-            menu=menu,
-            text='Удалить'
+        menu.items.extend(
+            (
+                self.top_bar.button_delete_from_role,
+                self.top_bar.button_delete,
+            )
         )
+        self.top_bar.delete_menu = ExtToolbarMenu(icon_cls='delete_item', menu=menu, text='Удалить')
         self.top_bar.items.append(self.top_bar.delete_menu)
 
         # Передаем индексы, так как некорректно
         # формируется client_id для данных элементов.
-        self.add_menu_index = self.top_bar.items.index(
-            self.top_bar.add_menu
-        )
-        self.new_child_index = self.top_bar.add_menu.menu.items.index(
-            self.top_bar.button_new_child
-        )
-        self.add_to_role_index = self.top_bar.add_menu.menu.items.index(
-            self.top_bar.button_add_to_role
-        )
-        self.delete_menu_index = self.top_bar.items.index(
-            self.top_bar.delete_menu
-        )
-        self.delete_from_role_index = menu.items.index(
-            self.top_bar.button_delete_from_role
-        )
+        self.add_menu_index = self.top_bar.items.index(self.top_bar.add_menu)
+        self.new_child_index = self.top_bar.add_menu.menu.items.index(self.top_bar.button_new_child)
+        self.add_to_role_index = self.top_bar.add_menu.menu.items.index(self.top_bar.button_add_to_role)
+        self.delete_menu_index = self.top_bar.items.index(self.top_bar.delete_menu)
+        self.delete_from_role_index = menu.items.index(self.top_bar.button_delete_from_role)
 
 
 class RolesListWindow(BaseListWindow):
     """Окно для отображения иерархии ролей."""
 
     def _init_components(self):
-        super(RolesListWindow, self)._init_components()
+        """Метод создаёт визуальные компоненты, отражающие поля модели.
+
+        Не определяет расположение компонентов в окне.
+        """
+        super()._init_components()
 
         self.grid = RolesTree()
 
     def set_params(self, params):
-        super(RolesListWindow, self).set_params(params)
+        """Метод принимает словарь, содержащий параметры окна, передаваемые в окно слоем экшенов."""
+        super().set_params(params)
+
         template = 'rbac/roles-list-window.js'
         self.pack = params['pack']
-        # ---------------------------------------------------------------------
+
         # Включение/отключение элементов окна в зависимости от прав доступа
         if not params['can_edit']:
             template = 'rbac/roles-view-list-window.js'
@@ -155,10 +147,7 @@ class RolesListWindow(BaseListWindow):
             self.grid.action_new = None
 
             # Отключение контролов для изменения ролей
-            for control in (
-                self.grid.top_bar.button_edit,
-                self.grid.context_menu_row.menuitem_edit
-            ):
+            for control in (self.grid.top_bar.button_edit, self.grid.context_menu_row.menuitem_edit):
                 control.text = 'Просмотр'
                 control.icon_cls = Icons.APPLICATION_VIEW_DETAIL
 
@@ -166,7 +155,7 @@ class RolesListWindow(BaseListWindow):
             self.grid.action_delete = None
             self.grid.url_delete = None
             self.grid.top_bar.items.remove(self.grid.top_bar.delete_menu)
-        # ---------------------------------------------------------------------
+
         self.template_globals = template
 
 
@@ -174,7 +163,8 @@ class RoleSelectWindow(BaseTreeSelectWindow):
     """Окно выбора роли, в которую будет добавлена указанная роль."""
 
     def _init_components(self):
-        super(RoleSelectWindow, self)._init_components()
+        """Создание компонентов."""
+        super()._init_components()
 
         self.label_message = ExtLabel(
             text='Выберите роль, в которую будет добавлена роль "{}":',
@@ -183,14 +173,16 @@ class RoleSelectWindow(BaseTreeSelectWindow):
         )
 
     def _do_layout(self):
-        super(RoleSelectWindow, self)._do_layout()
+        """Метод располагает уже созданные визуальные компоненты на окне."""
+        super()._do_layout()
 
         self.layout = 'border'
 
         self.items.insert(0, self.label_message)
 
     def set_params(self, params):
-        super(RoleSelectWindow, self).set_params(params)
+        """Установка параметров окна."""
+        super().set_params(params)
 
         self.title = 'Добавление одной роли в другую'
 
@@ -203,9 +195,9 @@ class RoleSelectWindow(BaseTreeSelectWindow):
             self.grid.action_context = ActionContext()
         self.grid.action_context.role_id = params['role'].id
 
-        self.label_message.text = (
-            mark_safe(self.label_message.text.format(params['role'].name))
-        )
+        self.label_message.text = mark_safe(self.label_message.text.format(params['role'].name))
+
+
 # -----------------------------------------------------------------------------
 
 
@@ -216,7 +208,7 @@ def _make_user_type_field(name='user_type_ids', **kwargs):
         hide_edit_trigger=False,
         hide_trigger=False,
         hide_dict_select_trigger=False,
-        **kwargs
+        **kwargs,
     )
     field.name = name
 
@@ -239,7 +231,8 @@ class PermissionsChangeTab(ObjectTab):
     )
 
     def init_components(self, win):
-        super(PermissionsChangeTab, self).init_components(win)
+        """Создаются компоненты, но не задаётся расположение."""
+        super().init_components(win)
 
         self.field__user_types = _make_user_type_field()
         self.container__top = ExtPanel(
@@ -261,10 +254,10 @@ class PermissionsChangeTab(ObjectTab):
         )
 
     def do_layout(self, win, tab):
-        super(PermissionsChangeTab, self).do_layout(win, tab)
+        """Задаётся расположение компонентов."""
+        super().do_layout(win, tab)
 
         tab.border = False
-        # ---------------------------------------------------------------------
 
         win.tab__permissions_change = tab
         win.field__name = self.field__name
@@ -275,7 +268,6 @@ class PermissionsChangeTab(ObjectTab):
         win.container__right = self.container__right
         win.grid__permissions = self.grid__permissions
         win.panel__description = self.panel__description
-        # ---------------------------------------------------------------------
 
         self.container__top.items[:] = (
             self.field__name,
@@ -291,7 +283,6 @@ class PermissionsChangeTab(ObjectTab):
             self.grid__partitions,
             self.container__right,
         )
-        # ---------------------------------------------------------------------
 
         tab.layout = 'border'
         self.container__top.region = 'north'
@@ -312,19 +303,17 @@ class PermissionsChangeTab(ObjectTab):
         self.panel__description.flex = 0
         self.panel__description.height = 100
         self.grid__permissions.flex = 1
-        # ---------------------------------------------------------------------
 
     def set_params(self, win, params):
-        super(PermissionsChangeTab, self).set_params(win, params)
+        """Установка параметров."""
+        super().set_params(win, params)
 
         if params.get('show_user_types', False):
             self.container__top.height += 45
             self.container__top.label_width = 140
             self.container__top.items.append(self.field__user_types)
 
-            self.field__user_types.set_store(
-                ExtDataStore(data=params['user_types'])
-            )
+            self.field__user_types.set_store(ExtDataStore(data=params['user_types']))
             self.field__user_types.value = params.get('user_type_ids', ())
 
         if params['can_edit']:
@@ -343,22 +332,24 @@ class ResultPermissionsTree(ExtTree):
     """
 
     def __init__(self, *args, **kwargs):
-        super(ResultPermissionsTree, self).__init__()
-
-        ColumnsConstructor.from_config((
-            dict(
-                data_index='title',
-                header='Наименование',
-            ),
-            dict(
-                data_index='description',
-                hidden=True,
-            ),
-            dict(
-                data_index='source',
-                header='Источник',
-            ),
-        )).configure_grid(self)
+        super().__init__()
+
+        ColumnsConstructor.from_config(
+            (
+                dict(
+                    data_index='title',
+                    header='Наименование',
+                ),
+                dict(
+                    data_index='description',
+                    hidden=True,
+                ),
+                dict(
+                    data_index='source',
+                    header='Источник',
+                ),
+            )
+        ).configure_grid(self)
 
 
 class ResultPermissionsTab(WindowTab):
@@ -378,7 +369,8 @@ class ResultPermissionsTab(WindowTab):
     title = 'Итоговые разрешения'
 
     def init_components(self, win):
-        super(ResultPermissionsTab, self).init_components(win)
+        """Создаются компоненты, но не задаётся расположение."""
+        super().init_components(win)
 
         self.tree__result_permissions = ResultPermissionsTree()
 
@@ -389,18 +381,19 @@ class ResultPermissionsTab(WindowTab):
         )
 
     def do_layout(self, win, tab):
-        super(ResultPermissionsTab, self).do_layout(win, tab)
-        # ---------------------------------------------------------------------
+        """Задаётся расположение компонентов."""
+        super().do_layout(win, tab)
 
         win.tab__result_permissions = tab
         tab.tree__result_permissions = self.tree__result_permissions
         tab.panel__description = self.panel__description
 
-        tab.items.extend((
-            self.tree__result_permissions,
-            self.panel__description,
-        ))
-        # ---------------------------------------------------------------------
+        tab.items.extend(
+            (
+                self.tree__result_permissions,
+                self.panel__description,
+            )
+        )
 
         tab.layout = 'vbox'
         tab.layout_config = dict(
@@ -409,7 +402,6 @@ class ResultPermissionsTab(WindowTab):
         self.tree__result_permissions.flex = 1
         self.panel__description.flex = 0
         self.panel__description.height = 100
-        # ---------------------------------------------------------------------
 
 
 class RoleAddWindow(ModelEditWindow):
@@ -423,22 +415,26 @@ class RoleAddWindow(ModelEditWindow):
     )
 
     def _init_components(self):
-        super(RoleAddWindow, self)._init_components()
+        """Метод создаёт визуальные компоненты, отражающие поля модели.
+
+        Не определяет расположение компонентов в окне.
+        """
+        super()._init_components()
         self.field__user_types = _make_user_type_field()
 
     def _do_layout(self):
-        super(RoleAddWindow, self)._do_layout()
+        """Метод располагает уже созданные визуальные компоненты на окне."""
+        super()._do_layout()
         self.form.items.append(self.field__user_types)
 
     def set_params(self, params):
-        super(RoleAddWindow, self).set_params(params)
+        """Метод принимает словарь, содержащий параметры окна, передаваемые в окно слоем экшенов."""
+        super().set_params(params)
 
         self.template_globals = 'rbac/role-add-window.js'
 
         if params.get('show_user_types', False):
-            self.field__user_types.set_store(
-                ExtDataStore(data=params['user_types'])
-            )
+            self.field__user_types.set_store(ExtDataStore(data=params['user_types']))
 
 
 class RoleEditWindow(TabbedEditWindow):
@@ -452,7 +448,8 @@ class RoleEditWindow(TabbedEditWindow):
     )
 
     def set_params(self, params):
-        super(RoleEditWindow, self).set_params(params)
+        """Метод принимает словарь, содержащий параметры окна, передаваемые в окно слоем экшенов."""
+        super().set_params(params)
 
         self.width = 1100
         self.height = 700
@@ -469,4 +466,6 @@ class RoleEditWindow(TabbedEditWindow):
 
         if not params['can_edit']:
             switch_window_in_read_only_mode(self)
+
+
 # -----------------------------------------------------------------------------