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

educommon/audit_log/actions.py

@@ -1,3 +1,7 @@
+from abc import (
+    ABCMeta,
+    abstractmethod,
+)
 from datetime import (
     date,
     timedelta,
@@ -45,7 +49,6 @@ from educommon.audit_log.ui import (
 from educommon.audit_log.utils import (
     get_model_choices,
     make_hstore_filter,
-    make_name_filter,
 )
 from educommon.m3 import (
     PackValidationMixin,
@@ -59,7 +62,7 @@ from educommon.utils.ui import (
 )
 
 
-class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
+class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack, metaclass=ABCMeta):
     """Журнал изменений."""
 
     title = 'Журнал изменений'
@@ -79,86 +82,86 @@ class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
 
     # Фильтр интервала дат
     date_filter = DatetimeFilterCreator(
-        model, 'time',
-        get_from=lambda: date.today() - timedelta(days=2),
-        get_to=date.today
+        model, 'time', get_from=lambda: date.today() - timedelta(days=2), get_to=date.today
     )
 
-    columns = [
-        {
-            'data_index': 'time',
-            'width': 140,
-            'header': 'Дата и время',
-            'sortable': True,
-            'filter': date_filter.filter
-        },
-        {
-            'data_index': 'user_name',
-            'width': 130,
-            'header': 'Пользователь',
-            'filter': ff(
-                'table__name',
-                lookup=lambda x: make_name_filter('surname', x)
-            ) & ff(
-                'table__name',
-                lookup=lambda x: make_name_filter('firstname', x)
-            ) & ff(
-                'table__name',
-                lookup=lambda x: make_name_filter('patronymic', x)
-            )
-        },
-        {
-            'data_index': 'operation',
-            'width': 60,
-            'header': 'Операция',
-            'filter': ff(
-                'operation',
-                ask_before_deleting=False
-            ),
-        },
-        {
-            'data_index': 'model_name',
-            'width': 220,
-            'header': 'Модель объекта',
-            'filter': ff(
-                'table',
-                control_creator=lambda: make_combo_box(
-                    data=get_model_choices(),
-                    ask_before_deleting=False,
+    def _generate_columns(self):
+        """Формирует наполнение столбцов."""
+        columns = [
+            {
+                'data_index': 'time',
+                'width': 140,
+                'header': 'Дата и время',
+                'sortable': True,
+                'filter': self.date_filter.filter
+            },
+            {
+                'data_index': 'user_name',
+                'width': 130,
+                'header': 'Пользователь',
+                'filter': self.ff('table__name', lookup=lambda x: self._make_name_filter('surname', x))
+                & self.ff('table__name', lookup=lambda x: self._make_name_filter('firstname', x))
+                & self.ff('table__name', lookup=lambda x: self._make_name_filter('patronymic', x)),
+            },
+            {
+                'data_index': 'operation',
+                'width': 60,
+                'header': 'Операция',
+                'filter': self.ff('operation', ask_before_deleting=False),
+            },
+            {
+                'data_index': 'model_name',
+                'width': 220,
+                'header': 'Модель объекта',
+                'filter': self.ff(
+                    'table',
+                    control_creator=lambda: make_combo_box(
+                        data=get_model_choices(),
+                        ask_before_deleting=False,
+                    ),
+                ),
+            },
+            {
+                'data_index': 'object_id',
+                'width': 50,
+                'header': 'Код объекта',
+                'filter': self.ff('object_id'),
+            },
+            {
+                'data_index': 'ip',
+                'width': 60,
+                'header': 'IP',
+                'filter': self.ff(
+                    'ip',
+                    parser_map=(GenericIPAddressField, 'str', '%s__contains'),
+                    control_creator=ExtStringField,
+                ),
+            },
+            {
+                'data_index': 'object_string',
+                'width': 180,
+                'header': 'Объект',
+                'filter': self.ff(
+                    'data',
+                    parser_map=(HStoreField, 'str', '%s__values__icontains'),
+                    lookup=lambda x: make_hstore_filter('data', x),
+                    control_creator=ExtStringField,
                 ),
-            ),
-        },
-        {
-            'data_index': 'object_id',
-            'width': 50,
-            'header': 'Код объекта',
-            'filter': ff('object_id'),
-        },
-        {
-            'data_index': 'ip',
-            'width': 60,
-            'header': 'IP',
-            'filter': ff(
-                'ip',
-                parser_map=(GenericIPAddressField, 'str', '%s__contains'),
-                control_creator=ExtStringField,
-            ),
-        },
-        {
-            'data_index': 'object_string',
-            'width': 180,
-            'header': 'Объект',
-            'filter': ff(
-                'data',
-                parser_map=(HStoreField, 'str', '%s__values__icontains'),
-                lookup=lambda x: make_hstore_filter('data', x),
-                control_creator=ExtStringField,
-            ),
-        },
-    ]
+            },
+            {
+                'data_index': '',
+                'width': 40,
+                'header': 'Имитация',
+            },
+        ]
+
+        return columns
 
     def __init__(self):
-        super(AuditLogPack, self).__init__()
+        self.columns = self._generate_columns()
+
+        super().__init__()
+
         self.view_changes_action = ViewChangeAction()
         self.actions.append(self.view_changes_action)
 
@@ -174,46 +177,62 @@ class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
         Устанавливает интервал дат фильтрации по умолчанию
         в параметрах запроса.
         """
-        super(AuditLogPack, self).configure_grid(grid)
+        super().configure_grid(grid)
+
         grid.store.base_params = self.date_filter.base_params
 
     def get_edit_window_params(self, params, request, context):
-        params = super(AuditLogPack, self).get_edit_window_params(
-            params, request, context
-        )
+        """Возвращает словарь параметров, которые будут переданы окну редактирования."""
+        params = super().get_edit_window_params(params, request, context)
+
         params['grid_action'] = self.view_changes_action
+
         return params
 
     def get_list_window_params(self, params, request, context):
-        params = super(AuditLogPack, self).get_list_window_params(
-            params, request, context
-        )
+        """Возвращает словарь параметров, которые будут переданы окну списка."""
+        params = super().get_list_window_params(params, request, context)
+
         params['maximized'] = True
+
         return params
 
     def get_rows_query(self, request, context):
-        return super(AuditLogPack, self).get_rows_query(
-            request, context
-        ).prefetch_related('table')
+        """Возвращает выборку из БД для получения списка данных."""
+        return super().get_rows_query(request, context).prefetch_related('table')
 
     def extend_menu(self, menu):
+        """Расширение главного меню."""
         return menu.administry(
             menu.Item(self.title, self.list_window_action),
         )
 
+    @abstractmethod
+    def _make_name_filter(self, field, value):
+        """Создает lookup фильтра по фамилии/имени/отчеству пользователя.
+
+        :param str field: название поля ('firstname', 'surname', 'patronymic').
+        :param str value: значение, по которому фильтруется queryset.
+        """
+
 
 class ViewChangeAction(BaseAction):
     """Action для просмотра изменений."""
 
     def context_declaration(self):
-        result = super(ViewChangeAction, self).context_declaration()
+        """Делегирует декларацию контекста в пак."""
+        result = super().context_declaration()
+
         result[self.parent.id_param_name] = dict(type='int')
+
         return result
 
     def run(self, request, context):
+        """Тело Action, вызывается при обработке запроса к серверу."""
         object_id = getattr(context, self.parent.id_param_name)
         if object_id:
-            rows = LogProxy.objects.get(id=object_id).diff
+            rows = self.parent.model.objects.get(id=object_id).diff
         else:
             rows = []
+
         return PreJsonResult({'rows': rows, 'total': len(rows)})

educommon/audit_log/app_meta.py

@@ -1,16 +1,15 @@
 from educommon import (
     ioc,
 )
-from educommon.audit_log.actions import (
-    AuditLogPack,
-)
 from educommon.audit_log.error_log.actions import (
     PostgreSQLErrorPack,
 )
 
 
 def register_actions():
-    ioc.get('main_controller').packs.extend((
-        AuditLogPack(),
-        PostgreSQLErrorPack(),
-    ))
+    """Регистрация паков и экшенов."""
+    ioc.get('main_controller').packs.extend(
+        (
+            PostgreSQLErrorPack(),
+        )
+    )

educommon/audit_log/apps.py

@@ -30,16 +30,30 @@ from educommon.utils.db.postgresql import (
 
 
 class AppConfig(AppConfig):
+    """Конфигурация подсистемы логирования изменений в БД.
+
+    При инициализации приложения:
+    - подключает обработку сигнала post_migrate;
+    - создаёт необходимые расширения PostgreSQL (hstore, postgres_fdw);
+    - проверяет и настраивает подключение к сервисной БД через FDW;
+    - выполняет установку и проверку инфраструктуры AuditLog.
+    """
 
     name = __name__.rpartition('.')[0]
 
     @property
     def _dispatch_uid(self):
-        return '.'.join((
-            self.name,
-            self.__class__.__name__,
-            self._configure_audit_log.__name__,
-        ))
+        """Уникальный идентификатор для подключения сигнала post_migrate.
+
+        Используется для предотвращения дублирующего подключения обработчиков.
+        """
+        return '.'.join(
+            (
+                self.name,
+                self.__class__.__name__,
+                self._configure_audit_log.__name__,
+            )
+        )
 
     def _create_postgresql_extensions(self):
         """Создает в БД необходимые расширения PostgreSQL.
@@ -52,13 +66,9 @@ class AppConfig(AppConfig):
         if not is_extension_exists(alias, 'postgres_fdw'):
             if create_extension(alias, 'postgres_fdw', quite=True):
                 with closing(connections[alias].cursor()) as cursor:
-                    cursor.execute(
-                        'GRANT USAGE ON FOREIGN DATA WRAPPER postgres_fdw '
-                        'TO PUBLIC'
-                    )
+                    cursor.execute('GRANT USAGE ON FOREIGN DATA WRAPPER postgres_fdw TO PUBLIC')
 
-        for alias in (settings.DEFAULT_DB_ALIAS,
-                      settings.SERVICE_DB_ALIAS):
+        for alias in (settings.DEFAULT_DB_ALIAS, settings.SERVICE_DB_ALIAS):
             if not is_extension_exists(alias, 'hstore'):
                 create_extension(alias, 'hstore', quite=True)
 
@@ -68,32 +78,41 @@ class AppConfig(AppConfig):
         from educommon.audit_log.utils import (
             configure,
         )
+
         configure()
 
         # Проверка подключения подключения к сервисной БД через FDW.
         from educommon.audit_log.utils import (
             check_connection_fdw,
         )
+
         success, error_message = check_connection_fdw()
         if not success:
             raise ImproperlyConfigured(
-                "{0} - Ошибка подключения к сервисной базе через "
+                '{0} - Ошибка подключения к сервисной базе через '
                 "postgres_fdw. Необходимо убедится что 'Журнал изменений' "
-                "настроен корректно.".format(error_message)
+                'настроен корректно.'.format(error_message)
             )
 
     def _configure_db(self, **kwargs):
+        """Инициализирует расширения PostgreSQL и настраивает AuditLog.
+
+        Вызывается после применения миграций. Если AuditLog уже инициализирован,
+        выполняется его настройка.
+        """
         from educommon.audit_log.utils import (
             is_initialized,
         )
 
         self._create_postgresql_extensions()
         if is_initialized(settings.DEFAULT_DB_ALIAS):
-            self._configure_audit_log(
-                connections[settings.DEFAULT_DB_ALIAS]
-            )
+            self._configure_audit_log(connections[settings.DEFAULT_DB_ALIAS])
 
     def ready(self):
+        """Вызывается при готовности приложения.
+
+        Подключает обработчик _configure_db к сигналу post_migrate.
+        """
         post_migrate.connect(self._configure_db, sender=self)
 
 
@@ -104,10 +123,7 @@ def check_postgres_fdw(app_configs, **kwargs):
 
     if not is_extension_exists(settings.DEFAULT_DB_ALIAS, 'postgres_fdw'):
         dbname = settings.DATABASES[settings.DEFAULT_DB_ALIAS]['NAME']
-        msg = (
-            "'postgres_fdw' PostgreSQL extension not installed in '{}' "
-            "database."
-        ).format(dbname)
+        msg = ("'postgres_fdw' PostgreSQL extension not installed in '{}' database.").format(dbname)
         hint = (
             "Execute this SQL in '{dbname}' database:\n"
             '{indent}CREATE EXTENSION postgres_fdw;\n'
@@ -125,20 +141,19 @@ def check_hstore(app_configs, **kwargs):
     errors = []
 
     msg = "'hstore' PostgreSQL extension not installed in '{}' database."
-    hint = (
-        "Execute this SQL in '{dbname}' database:\n"
-        '{indent}CREATE EXTENSION hstore;'
-    )
+    hint = "Execute this SQL in '{dbname}' database:\n{indent}CREATE EXTENSION hstore;"
     indent = ' ' * 14
 
     def check(alias, message_id):
         dbname = settings.DATABASES[alias]['NAME']
         if not is_extension_exists(alias, 'hstore'):
-            errors.append(Critical(
-                msg.format(dbname),
-                hint.format(indent=indent, dbname=dbname),
-                id=message_id,
-            ))
+            errors.append(
+                Critical(
+                    msg.format(dbname),
+                    hint.format(indent=indent, dbname=dbname),
+                    id=message_id,
+                )
+            )
 
     check(settings.DEFAULT_DB_ALIAS, 'audit_log.C002')
     check(settings.SERVICE_DB_ALIAS, 'audit_log.C003')

educommon/audit_log/constants.py

@@ -21,8 +21,11 @@ EXCLUDED_TABLES = (
 )
 
 # Папка с sql файлами
-SQL_FILES_DIR = os.path.abspath(os.path.join(
-    os.path.dirname(__file__), 'sql',
-))
+SQL_FILES_DIR = os.path.abspath(
+    os.path.join(
+        os.path.dirname(__file__),
+        'sql',
+    )
+)
 
-INSTALL_AUDIT_LOG_SQL_FILE_NAME = 'install_audit_log.sql'
+INSTALL_AUDIT_LOG_SQL_FILE_NAME = 'install_audit_log.sql'

educommon/audit_log/error_log/actions.py

@@ -72,9 +72,7 @@ class PostgreSQLErrorPack(PackValidationMixin, ObjectPack):
         )
 
     def get_list_window_params(self, params, request, context):
-        result = super(PostgreSQLErrorPack, self).get_list_window_params(
-            params, request, context
-        )
+        result = super(PostgreSQLErrorPack, self).get_list_window_params(params, request, context)
 
         result['maximized'] = True
         result['read_only'] = not self.delete_action.has_perm(request)

educommon/audit_log/helpers.py

@@ -20,11 +20,9 @@ if TYPE_CHECKING:
 
 
 def get_models_table_ids(models: Union['Model', IterableType['Model']]) -> List[int]:
-    """
-    Возвращает перечень id таблиц из AuditLog соответствующих указанным моделям.
-    """
+    """Возвращает перечень id таблиц из AuditLog соответствующих указанным моделям."""
     if not isinstance(models, Iterable):
-        models = (models, )
+        models = (models,)
 
     table_ids = Table.objects.filter(
         name__in=(model._meta.db_table for model in models),

educommon/audit_log/management/commands/reinstall_audit_log.py

@@ -37,14 +37,18 @@ class Command(BaseCommand):
 
     def add_arguments(self, parser):
         """Добавление аргументов команды."""
+        (
+            parser.add_argument(
+                '--clear_audit_logs',
+                action='store_true',
+                default=False,
+                help='Удалить записи из audit_log для неотслеживаемых таблиц',
+            ),
+        )
         parser.add_argument(
-            '--clear_audit_logs',
-            action='store_true',
-            default=False,
-            help='Удалить записи из audit_log для неотслеживаемых таблиц',
-        ),
-        parser.add_argument(
-            '--chunk_size', type=int, default=DEFAULT_QUERYSET_CHUNK_SIZE,
+            '--chunk_size',
+            type=int,
+            default=DEFAULT_QUERYSET_CHUNK_SIZE,
             help='Кол-во единовременно удаляемых записей',
         )
 

educommon/audit_log/migrations/0001_initial.py

@@ -12,9 +12,7 @@ from educommon.django.db.migration.operations import (
 
 
 class Migration(migrations.Migration):
-
-    dependencies = [
-    ]
+    dependencies = []
 
     operations = [
         CreateSchema('audit', aliases=('default',)),
@@ -22,11 +20,33 @@ class Migration(migrations.Migration):
             name='PostgreSQLError',
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('user_id', models.IntegerField(null=True, verbose_name='\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c')),
+                (
+                    'user_id',
+                    models.IntegerField(
+                        null=True,
+                        verbose_name='\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c',
+                    ),
+                ),
                 ('ip', models.GenericIPAddressField(null=True, verbose_name='IP \u0430\u0434\u0440\u0435\u0441')),
-                ('time', models.DateTimeField(auto_now_add=True, verbose_name='\u0414\u0430\u0442\u0430, \u0432\u0440\u0435\u043c\u044f')),
-                ('level', models.CharField(max_length=50, verbose_name='\u0423\u0440\u043e\u0432\u0435\u043d\u044c \u043e\u0448\u0438\u0431\u043a\u0438')),
-                ('text', models.TextField(verbose_name='\u0422\u0435\u043a\u0441\u0442 \u043e\u0448\u0438\u0431\u043a\u0438')),
+                (
+                    'time',
+                    models.DateTimeField(
+                        auto_now_add=True, verbose_name='\u0414\u0430\u0442\u0430, \u0432\u0440\u0435\u043c\u044f'
+                    ),
+                ),
+                (
+                    'level',
+                    models.CharField(
+                        max_length=50,
+                        verbose_name='\u0423\u0440\u043e\u0432\u0435\u043d\u044c \u043e\u0448\u0438\u0431\u043a\u0438',
+                    ),
+                ),
+                (
+                    'text',
+                    models.TextField(
+                        verbose_name='\u0422\u0435\u043a\u0441\u0442 \u043e\u0448\u0438\u0431\u043a\u0438'
+                    ),
+                ),
             ],
             options={
                 'db_table': 'audit"."postgresql_errors',
@@ -38,14 +58,54 @@ class Migration(migrations.Migration):
             name='AuditLog',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('user_id', models.IntegerField(null=True, verbose_name='\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c', db_index=True)),
-                ('user_type_id', models.IntegerField(null=True, verbose_name='\u0422\u0438\u043f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f', db_index=True)),
+                (
+                    'user_id',
+                    models.IntegerField(
+                        null=True,
+                        verbose_name='\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c',
+                        db_index=True,
+                    ),
+                ),
+                (
+                    'user_type_id',
+                    models.IntegerField(
+                        null=True,
+                        verbose_name='\u0422\u0438\u043f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f',
+                        db_index=True,
+                    ),
+                ),
                 ('ip', models.GenericIPAddressField(null=True, verbose_name='IP \u0430\u0434\u0440\u0435\u0441')),
-                ('time', models.DateTimeField(auto_now_add=True, verbose_name='\u0414\u0430\u0442\u0430, \u0432\u0440\u0435\u043c\u044f', db_index=True)),
-                ('object_id', models.IntegerField(verbose_name='\u041e\u0431\u044a\u0435\u043a\u0442 \u043c\u043e\u0434\u0435\u043b\u0438', db_index=True)),
+                (
+                    'time',
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        verbose_name='\u0414\u0430\u0442\u0430, \u0432\u0440\u0435\u043c\u044f',
+                        db_index=True,
+                    ),
+                ),
+                (
+                    'object_id',
+                    models.IntegerField(
+                        verbose_name='\u041e\u0431\u044a\u0435\u043a\u0442 \u043c\u043e\u0434\u0435\u043b\u0438',
+                        db_index=True,
+                    ),
+                ),
                 ('data', HStoreField(null=True, verbose_name='\u041e\u0431\u044a\u0435\u043a\u0442')),
-                ('changes', HStoreField(null=True, verbose_name='\u0418\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f')),
-                ('operation', models.SmallIntegerField(verbose_name='\u0414\u0435\u0439\u0441\u0442\u0432\u0438\u0435', choices=[(1, '\u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435'), (2, '\u0418\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0435'), (3, '\u0423\u0434\u0430\u043b\u0435\u043d\u0438\u0435')])),
+                (
+                    'changes',
+                    HStoreField(null=True, verbose_name='\u0418\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f'),
+                ),
+                (
+                    'operation',
+                    models.SmallIntegerField(
+                        verbose_name='\u0414\u0435\u0439\u0441\u0442\u0432\u0438\u0435',
+                        choices=[
+                            (1, '\u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435'),
+                            (2, '\u0418\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0435'),
+                            (3, '\u0423\u0434\u0430\u043b\u0435\u043d\u0438\u0435'),
+                        ],
+                    ),
+                ),
             ],
             options={
                 'abstract': False,
@@ -56,8 +116,19 @@ class Migration(migrations.Migration):
             name='Table',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('name', models.CharField(max_length=250, verbose_name='\u0418\u043c\u044f \u0442\u0430\u0431\u043b\u0438\u0446\u044b')),
-                ('schema', models.CharField(max_length=250, verbose_name='\u0421\u0445\u0435\u043c\u0430 \u0442\u0430\u0431\u043b\u0438\u0446\u044b')),
+                (
+                    'name',
+                    models.CharField(
+                        max_length=250, verbose_name='\u0418\u043c\u044f \u0442\u0430\u0431\u043b\u0438\u0446\u044b'
+                    ),
+                ),
+                (
+                    'schema',
+                    models.CharField(
+                        max_length=250,
+                        verbose_name='\u0421\u0445\u0435\u043c\u0430 \u0442\u0430\u0431\u043b\u0438\u0446\u044b',
+                    ),
+                ),
             ],
             options={
                 'verbose_name': '\u041b\u043e\u0433\u0438\u0440\u0443\u0435\u043c\u0430\u044f \u0442\u0430\u0431\u043b\u0438\u0446\u0430',
@@ -72,7 +143,11 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='auditlog',
             name='table',
-            field=models.ForeignKey(verbose_name='\u0422\u0430\u0431\u043b\u0438\u0446\u0430', to='audit_log.Table', on_delete=models.CASCADE),
+            field=models.ForeignKey(
+                verbose_name='\u0422\u0430\u0431\u043b\u0438\u0446\u0430',
+                to='audit_log.Table',
+                on_delete=models.CASCADE,
+            ),
             preserve_default=True,
         ),
     ]