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

educommon/auth/rbac/backends/caching.py

@@ -58,20 +58,19 @@ class CachingBackend(BackendBase):
     """Ключ кеша, в котором сохраняется время изменения объектов в БД."""
 
     # Модели, данные которых кэшируются.
-    _cached_models = {
-        Permission,
-        Role,
-        RoleParent,
-        UserRole,
-        RolePermission
-    }
+    _cached_models = {Permission, Role, RoleParent, UserRole, RolePermission}
 
     @cached_property
     def _logger(self):
         return getLogger(__name__.rpartition('.')[0])
 
     def __init__(self, *args, **kwargs):
-        super(CachingBackend, self).__init__(*args, **kwargs)
+        """Инициализация бэкенда RBAC с поддержкой кэширования.
+
+        Устанавливает параметры кэширования и подписывается на сигналы
+        для обновления кэша при изменениях в связанных моделях.
+        """
+        super().__init__(*args, **kwargs)
 
         # Максимальная продолжительность кеширования объектов до их
         # перезагрузки (в секундах).
@@ -107,7 +106,8 @@ class CachingBackend(BackendBase):
         """Обработчик сигналов об изменениях в моделях."""
         if (
             # changed приходит только от post_init
-            kwargs.get('changed', False) or
+            kwargs.get('changed', False)
+            or
             # а port_save и post_delete нужно обрабатывать только для
             # кэшируемых моделей
             sender in self._cached_models
@@ -158,23 +158,17 @@ class CachingBackend(BackendBase):
 
     def _load_role_permissions(self):
         """Загрузка данных о разрешениях ролей RBAC."""
-        for role_id, permission_id in RolePermission.objects.values_list(
-            'role', 'permission'
-        ):
+        for role_id, permission_id in RolePermission.objects.values_list('role', 'permission'):
             self._role_permissions[role_id].add(permission_id)
 
     def _load_user_roles(self):
         """Загрузка данных о ролях пользователей."""
         query = UserRole.objects.filter(
             Q(date_to__isnull=True) | Q(date_to__gte=date.today()),
-        ).values_list(
-            'content_type', 'object_id', 'date_from', 'date_to', 'role'
-        )
+        ).values_list('content_type', 'object_id', 'date_from', 'date_to', 'role')
 
         for ct_id, obj_id, date_from, date_to, role_id in query:
-            self._user_roles[ct_id, obj_id].add(
-                (date_from, date_to, role_id)
-            )
+            self._user_roles[ct_id, obj_id].add((date_from, date_to, role_id))
 
     def _get_role_descendants(self, role_id, include_self=False):
         """Возвращает вложенные роли."""
@@ -184,9 +178,7 @@ class CachingBackend(BackendBase):
             result.add(role_id)
 
         for child_role_id in self._role_children[role_id]:
-            result.update(
-                self._get_role_descendants(child_role_id, include_self=True)
-            )
+            result.update(self._get_role_descendants(child_role_id, include_self=True))
 
         return result
 
@@ -199,30 +191,30 @@ class CachingBackend(BackendBase):
         roles_data = self._user_roles[content_type_id, user.id]
         today = date.today()
 
-        return set(chain(*(
-            self._get_role_descendants(role_id, include_self=True)
-            for date_from, date_to, role_id in roles_data
-            if (date_from or today) <= today <= (date_to or today)
-        )))
+        return set(
+            chain(
+                *(
+                    self._get_role_descendants(role_id, include_self=True)
+                    for date_from, date_to, role_id in roles_data
+                    if (date_from or today) <= today <= (date_to or today)
+                )
+            )
+        )
 
     def _get_user_permissions(self, user):
         """Возврвщает все доступные пользователю разрешения.
 
         :rtype: itertools.chain
         """
+
         def get_role_permissions(role_id):
             # pylint: disable=protected-access
             for permission_id in self._role_permissions[role_id]:
                 yield permission_id
-                for name in self._manager.get_dependent_permissions(
-                    self._permissions_by_id[permission_id]
-                ):
+                for name in self._manager.get_dependent_permissions(self._permissions_by_id[permission_id]):
                     yield self._permissions_by_name[name]
 
-        return chain(*(
-            get_role_permissions(role_id)
-            for role_id in self._get_user_roles(user)
-        ))
+        return chain(*(get_role_permissions(role_id) for role_id in self._get_user_roles(user)))
 
     def _reload(self, force=False):
         """Перезагрузка кешируемых объектов при необходимости.
@@ -278,15 +270,13 @@ class CachingBackend(BackendBase):
 
         # Id разрешений экшена, доступность которых будем проверять
         action_permissions = set(
-            self._permissions_by_name[perm_name]
-            for perm_name in self._get_action_permissions(action)
+            self._permissions_by_name[perm_name] for perm_name in self._get_action_permissions(action)
         )
 
         for permission_id in self._get_user_permissions(user):
             if permission_id in action_permissions:
                 permission_name = self._permissions_by_id[permission_id]
-                if self._check_permission(permission_name, action, request,
-                                          user):
+                if self._check_permission(permission_name, action, request, user):
                     return True
 
         return False

educommon/auth/rbac/backends/simple.py

@@ -72,7 +72,6 @@ def _get_user_permissions_query(user, permissions=None):
 
 
 class SimpleBackend(BackendBase):
-
     """Предоставляет прямой доступ к объектам RBAC.
 
     Доступ к объектам RBAC (разрешениям, ролям и их связям между собой)
@@ -91,9 +90,7 @@ class SimpleBackend(BackendBase):
         :rtype: generator
         """
         # pylint: disable=protected-access
-        for name in _get_user_permissions_query(user, permissions).values_list(
-            'name', flat=True
-        ):
+        for name in _get_user_permissions_query(user, permissions).values_list('name', flat=True):
             yield name
             for name in self._manager.get_dependent_permissions(name):
                 yield name

educommon/auth/rbac/checker.py

@@ -53,9 +53,7 @@ class PermissionChecker(AbstractPermissionChecker):
 
         pack_perm_code = getattr(pack, 'perm_code', False)
         if not pack_perm_code:
-            pack_perm_code = '/'.join(
-                (pack.__class__.__module__, pack.__class__.__name__)
-            )
+            pack_perm_code = '/'.join((pack.__class__.__module__, pack.__class__.__name__))
 
         if action is None:
             action_perm_code = 'default'

educommon/auth/rbac/management/commands/rbac.py

@@ -1,4 +1,5 @@
 """Management-команда для обслуживания системы авторизации."""
+
 import os
 
 from django.core.management import (
@@ -21,7 +22,6 @@ from educommon.auth.rbac.models import (
 
 
 class Command(BaseCommand):
-
     """Обслуживание системы авторизации."""
 
     use_argparse = False
@@ -84,8 +84,6 @@ class Command(BaseCommand):
             return
 
         max_width = max(len(permission) for permission in permissions)
-        template = '  {} {:<%s}\n' % max_width
-
         self.stdout.write('Permissions:\n')
 
         for permission in sorted(permissions):
@@ -96,9 +94,8 @@ class Command(BaseCommand):
             else:
                 status, color = '[  REGISTERED  ]', 'green'
 
-            self.stdout.write(
-                colored(template.format(status, permission), color)
-            )
+            line = f'  {status} {permission:<{max_width}}\n'
+            self.stdout.write(colored(line, color))
 
     def _show(self, objects='permissions', *args, **options):
         """Отображение данных системы авторизации."""
@@ -119,13 +116,11 @@ class Command(BaseCommand):
             return
 
         max_width = max(len(p.name) for p in permissions)
-        template = '{:<%s}  [DELETED]\n' % max_width
 
         for permission in permissions:
             permission.delete()
-            self.stdout.write(
-                colored(template.format(permission.name), 'red')
-            )
+            line = f'{permission.name:<{max_width}}  [DELETED]\n'
+            self.stdout.write(colored(line, 'red'))
 
     def _clean(self, objects='all', **options):
         """Удаление незарегистрированных правил и разрешений."""
@@ -137,7 +132,7 @@ class Command(BaseCommand):
             raise CommandError('Unknown objects type: {}'.format(objects))
 
     def handle(self, action, *args, **options):
-        # TODO: Написать документацию
+        """Обработка команды управления RBAC."""
         rbac.init(update_db=False)
 
         if not self.stdout.isatty():

educommon/auth/rbac/manager.py

@@ -42,6 +42,7 @@ def _get_handler(handler):
     module, handler = handler.rsplit('.', 1)
     module = __import__(module, fromlist=[handler])
     handler = getattr(module, handler)
+
     return handler
 
 
@@ -89,11 +90,7 @@ def _set_permission(permission, name, title, description, hidden):
         permission.full_clean()
         permission.save()
         changed = True
-    elif (
-        permission.title != title or
-        permission.description != description or
-        permission.hidden != hidden
-    ):
+    elif permission.title != title or permission.description != description or permission.hidden != hidden:
         permission.title = title
         permission.description = description
         permission.hidden = hidden
@@ -129,6 +126,7 @@ class RBACManager:
         :returns: ``('employee', 'Сотрудники')``
         """
         group_name = permission_name.split('/')[0]
+
         return group_name, self.groups[group_name]
 
     def get_partition_title(self, group_name) -> Optional[str]:
@@ -154,8 +152,7 @@ class RBACManager:
             for title, group_codes in partitions.items():
                 for code in group_codes:
                     assert code not in processed_codes, (
-                        'Группа разрешений "{}" уже закреплена за другим '
-                        'разделом системы.'.format(code)
+                        'Группа разрешений "{}" уже закреплена за другим разделом системы.'.format(code)
                     )
                     self.partitions[title].add(code)
                     processed_codes.add(code)
@@ -170,9 +167,8 @@ class RBACManager:
                 continue
 
             for code, title in groups.items():
-                assert code not in self.groups, (
-                    'Группа разрешений "{}" ({}) уже описана в другом '
-                    'приложении.'.format(code, title)
+                assert code not in self.groups, 'Группа разрешений "{}" ({}) уже описана в другом приложении.'.format(
+                    code, title
                 )
 
                 self.groups[code] = title
@@ -203,13 +199,9 @@ class RBACManager:
                     if hidden:
                         self.hidden_permissions.add(name)
                 else:
-                    raise ValueError(
-                        'Invalid permission params: ' + repr(params)
-                    )
+                    raise ValueError('Invalid permission params: ' + repr(params))
 
-                assert name in self.permissions_by_name, (
-                    'Permission {} not found'.format(name)
-                )
+                assert name in self.permissions_by_name, 'Permission {} not found'.format(name)
 
                 _title, _description = self.permissions_by_name[name]
                 self.permissions_by_name[name] = (
@@ -227,27 +219,16 @@ class RBACManager:
                 module_dependencies = module_dependencies()
 
             for name, dependencies in module_dependencies.items():
-                assert name in self.permissions_by_name, (
-                    'Permission {} not found'.format(name)
-                )
+                assert name in self.permissions_by_name, 'Permission {} not found'.format(name)
                 assert name not in self.hidden_permissions or all(
-                    dependency in self.hidden_permissions
-                    for dependency in dependencies
-                ), (
-                    'Скрытые разрешения могут зависеть только от скрытых '
-                    'разрешений: ' + name
-                )
+                    dependency in self.hidden_permissions for dependency in dependencies
+                ), 'Скрытые разрешения могут зависеть только от скрытых разрешений: ' + name
                 if __debug__:
                     for dependency in dependencies:
                         if name == dependency:
-                            raise AssertionError(
-                                'Permission {} can''t depend on itself'
-                                .format(dependency)
-                            )
+                            raise AssertionError('Permission {} cant depend on itself'.format(dependency))
                         if dependency not in self.permissions_by_name:
-                            raise AssertionError(
-                                'Permission {} not found'.format(dependency)
-                            )
+                            raise AssertionError('Permission {} not found'.format(dependency))
 
                 self.permission_dependencies[name].update(dependencies)
 
@@ -271,10 +252,7 @@ class RBACManager:
         with Lock(settings.DEFAULT_DB_ALIAS, 'rbac_lock'):
             permissions_changed = False
 
-            permissions = {
-                permission.name: permission
-                for permission in Permission.objects.iterator()
-            }
+            permissions = {permission.name: permission for permission in Permission.objects.iterator()}
 
             for params in self.permissions_by_name.items():
                 name, (title, description) = params
@@ -307,9 +285,7 @@ class RBACManager:
         for dependency in self.permission_dependencies[name]:
             if dependency not in _result:
                 _result.add(dependency)
-                _result.update(
-                    self.get_dependent_permissions(dependency, _result)
-                )
+                _result.update(self.get_dependent_permissions(dependency, _result))
 
         if primary_name:
             _result.remove(primary_name)
@@ -351,6 +327,7 @@ class RBACManager:
 
     @cached_property
     def _backend(self):
+        """Инициализирует и возвращает выбранный бэкенд RBAC."""
         backend_name = getattr(settings, 'RBAC_BACKEND', None) or (
             __name__.rpartition('.')[0] + '.backends.caching.CachingBackend'
         )
@@ -359,18 +336,12 @@ class RBACManager:
         try:
             module = import_module(module_name)
         except ImportError as e:
-            raise ImproperlyConfigured(
-                'Error importing RBAC backend module {}: "{}"'
-                .format(module_name, e)
-            )
+            raise ImproperlyConfigured('Error importing RBAC backend module {}: "{}"'.format(module_name, e))
 
         try:
             backend_class = getattr(module, class_name)
         except AttributeError:
-            raise ImproperlyConfigured(
-                'Module "{}" does not define a RBAC backend "{}"'
-                .format(module, class_name)
-            )
+            raise ImproperlyConfigured('Module "{}" does not define a RBAC backend "{}"'.format(module, class_name))
         else:
             backend = backend_class(self)
 

educommon/auth/rbac/migrations/0001_initial.py

@@ -5,7 +5,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('contenttypes', '0001_initial'),
     ]
@@ -15,9 +14,23 @@ class Migration(migrations.Migration):
             name='Permission',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('name', models.CharField(unique=True, max_length=100, verbose_name='\u0418\u043c\u044f', db_index=True)),
-                ('title', models.CharField(max_length=200, null=True, verbose_name='\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435', blank=True)),
-                ('description', models.TextField(verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435', blank=True)),
+                (
+                    'name',
+                    models.CharField(unique=True, max_length=100, verbose_name='\u0418\u043c\u044f', db_index=True),
+                ),
+                (
+                    'title',
+                    models.CharField(
+                        max_length=200,
+                        null=True,
+                        verbose_name='\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435',
+                        blank=True,
+                    ),
+                ),
+                (
+                    'description',
+                    models.TextField(verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435', blank=True),
+                ),
             ],
             options={
                 'verbose_name': '\u0420\u0430\u0437\u0440\u0435\u0448\u0435\u043d\u0438\u0435',
@@ -29,9 +42,26 @@ class Migration(migrations.Migration):
             name='Role',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('name', models.CharField(unique=True, max_length=300, verbose_name='\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435', db_index=True)),
-                ('description', models.TextField(verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435', blank=True)),
-                ('can_be_assigned', models.BooleanField(default=True, verbose_name='\u041c\u043e\u0436\u0435\u0442 \u0431\u044b\u0442\u044c \u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0430 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044e')),
+                (
+                    'name',
+                    models.CharField(
+                        unique=True,
+                        max_length=300,
+                        verbose_name='\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435',
+                        db_index=True,
+                    ),
+                ),
+                (
+                    'description',
+                    models.TextField(verbose_name='\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435', blank=True),
+                ),
+                (
+                    'can_be_assigned',
+                    models.BooleanField(
+                        default=True,
+                        verbose_name='\u041c\u043e\u0436\u0435\u0442 \u0431\u044b\u0442\u044c \u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0430 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044e',
+                    ),
+                ),
             ],
             options={
                 'verbose_name': '\u0420\u043e\u043b\u044c',
@@ -56,8 +86,20 @@ class Migration(migrations.Migration):
             name='RolePermission',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('permission', models.ForeignKey(verbose_name='\u0420\u0430\u0437\u0440\u0435\u0448\u0435\u043d\u0438\u0435', to='rbac.Permission', on_delete=models.CASCADE)),
-                ('role', models.ForeignKey(verbose_name='\u0420\u043e\u043b\u044c', to='rbac.Role', on_delete=models.CASCADE)),
+                (
+                    'permission',
+                    models.ForeignKey(
+                        verbose_name='\u0420\u0430\u0437\u0440\u0435\u0448\u0435\u043d\u0438\u0435',
+                        to='rbac.Permission',
+                        on_delete=models.CASCADE,
+                    ),
+                ),
+                (
+                    'role',
+                    models.ForeignKey(
+                        verbose_name='\u0420\u043e\u043b\u044c', to='rbac.Role', on_delete=models.CASCADE
+                    ),
+                ),
             ],
             options={
                 'db_table': 'rbac_role_permissions',
@@ -71,10 +113,29 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
                 ('object_id', models.PositiveIntegerField()),
-                ('date_from', models.DateField(null=True, verbose_name='\u041d\u0430\u0447\u0430\u043b\u043e \u0438\u043d\u0442\u0435\u0440\u0432\u0430\u043b\u0430', blank=True)),
-                ('date_to', models.DateField(null=True, verbose_name='\u041a\u043e\u043d\u0435\u0446 \u0438\u043d\u0442\u0435\u0440\u0432\u0430\u043b\u0430', blank=True)),
+                (
+                    'date_from',
+                    models.DateField(
+                        null=True,
+                        verbose_name='\u041d\u0430\u0447\u0430\u043b\u043e \u0438\u043d\u0442\u0435\u0440\u0432\u0430\u043b\u0430',
+                        blank=True,
+                    ),
+                ),
+                (
+                    'date_to',
+                    models.DateField(
+                        null=True,
+                        verbose_name='\u041a\u043e\u043d\u0435\u0446 \u0438\u043d\u0442\u0435\u0440\u0432\u0430\u043b\u0430',
+                        blank=True,
+                    ),
+                ),
                 ('content_type', models.ForeignKey(to='contenttypes.ContentType', on_delete=models.CASCADE)),
-                ('role', models.ForeignKey(verbose_name='\u0420\u043e\u043b\u044c', to='rbac.Role', on_delete=models.CASCADE)),
+                (
+                    'role',
+                    models.ForeignKey(
+                        verbose_name='\u0420\u043e\u043b\u044c', to='rbac.Role', on_delete=models.CASCADE
+                    ),
+                ),
             ],
             options={
                 'verbose_name': '\u0420\u043e\u043b\u044c \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f',

educommon/auth/rbac/migrations/0002_model_modifier_metaclass_fix.py

@@ -5,18 +5,19 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
-    dependencies = [('rbac', '0001_initial'), ]
+    dependencies = [
+        ('rbac', '0001_initial'),
+    ]
 
     operations = [
         migrations.AlterField(
             model_name='userrole',
             name='date_from',
-            field=models.DateField(
-                blank=True, null=True, verbose_name='Действует с'), ),
+            field=models.DateField(blank=True, null=True, verbose_name='Действует с'),
+        ),
         migrations.AlterField(
             model_name='userrole',
             name='date_to',
-            field=models.DateField(
-                blank=True, null=True, verbose_name='по'), ),
+            field=models.DateField(blank=True, null=True, verbose_name='по'),
+        ),
     ]

educommon/auth/rbac/migrations/0003_permission_hidden.py

@@ -5,7 +5,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('rbac', '0002_model_modifier_metaclass_fix'),
     ]
@@ -14,9 +13,6 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='permission',
             name='hidden',
-            field=models.BooleanField(
-                default=False,
-                verbose_name='Видимость пользователям'
-            ),
+            field=models.BooleanField(default=False, verbose_name='Видимость пользователям'),
         ),
     ]

educommon/auth/rbac/migrations/0004_auto_20171024_1245.py

@@ -8,7 +8,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('contenttypes', '0002_remove_content_type_name'),
         ('rbac', '0003_permission_hidden'),
@@ -18,26 +17,31 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='RoleUserType',
             fields=[
-                ('id', models.AutoField(
-                    auto_created=True,
-                    primary_key=True,
-                    serialize=False,
-                    verbose_name='ID')),
-                ('role', models.ForeignKey(
-                    on_delete=django.db.models.deletion.CASCADE,
-                    related_name='+',
-                    to='rbac.Role',
-                    verbose_name='Роль')),
-                ('user_type', models.ForeignKey(
-                    on_delete=django.db.models.deletion.CASCADE,
-                    related_name='+',
-                    to='contenttypes.ContentType',
-                    verbose_name='Тип пользователя')),
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                (
+                    'role',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name='+',
+                        to='rbac.Role',
+                        verbose_name='Роль',
+                    ),
+                ),
+                (
+                    'user_type',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name='+',
+                        to='contenttypes.ContentType',
+                        verbose_name='Тип пользователя',
+                    ),
+                ),
             ],
             options={
                 'verbose_name': 'Тип пользователя роли',
                 'verbose_name_plural': 'Типы пользователей ролей',
-            }, ),
+            },
+        ),
         migrations.AlterModelManagers(
             name='userrole',
             managers=[
@@ -52,8 +56,11 @@ class Migration(migrations.Migration):
                 related_name='_role_user_types_+',
                 through='rbac.RoleUserType',
                 to='contenttypes.ContentType',
-                verbose_name='Может быть назначена'), ),
+                verbose_name='Может быть назначена',
+            ),
+        ),
         migrations.AlterUniqueTogether(
             name='roleusertype',
-            unique_together=set([('role', 'user_type')]), ),
+            unique_together=set([('role', 'user_type')]),
+        ),
     ]