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

educommon/audit_log/migrations/0002_install_audit_log.py

@@ -30,8 +30,7 @@ class InitDefaultDatabase(Operation):
     def state_forwards(self, app_label, state):
         pass
 
-    def database_forwards(self, app_label, schema_editor, from_state,
-                          to_state):
+    def database_forwards(self, app_label, schema_editor, from_state, to_state):
         if schema_editor.connection.alias != settings.DEFAULT_DB_ALIAS:
             return
 
@@ -44,8 +43,7 @@ class InitDefaultDatabase(Operation):
 
         schema_editor.execute(sql)
 
-    def database_backwards(self, app_label, schema_editor, from_state,
-                           to_state):
+    def database_backwards(self, app_label, schema_editor, from_state, to_state):
         if schema_editor.connection.alias != settings.DEFAULT_DB_ALIAS:
             return
 
@@ -64,24 +62,26 @@ class LoadTableData(Operation):
     def state_forwards(self, app_label, state):
         pass
 
-    def database_forwards(self, app_label, schema_editor, from_state,
-                          to_state):
+    def database_forwards(self, app_label, schema_editor, from_state, to_state):
         Table = to_state.apps.get_model('audit_log', 'Table')
 
         if self.allow_migrate_model(schema_editor.connection.alias, Table):
             cursor = connections[settings.DEFAULT_DB_ALIAS].cursor()
-            cursor.execute('\n'.join((
-                "SELECT table_name, table_schema",
-                "FROM information_schema.tables",
-                "WHERE table_schema = 'public'",
-            )))
+            cursor.execute(
+                '\n'.join(
+                    (
+                        'SELECT table_name, table_schema',
+                        'FROM information_schema.tables',
+                        "WHERE table_schema = 'public'",
+                    )
+                )
+            )
 
             for name, schema in cursor:
                 if (schema, name) not in EXCLUDED_TABLES:
                     Table.objects.get_or_create(name=name, schema=schema)
 
-    def database_backwards(self, app_label, schema_editor, from_state,
-                           to_state):
+    def database_backwards(self, app_label, schema_editor, from_state, to_state):
         pass
 
 

educommon/audit_log/migrations/0003_logproxy.py

@@ -4,7 +4,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0002_install_audit_log'),
     ]
@@ -12,8 +11,7 @@ class Migration(migrations.Migration):
     operations = [
         migrations.CreateModel(
             name='LogProxy',
-            fields=[
-            ],
+            fields=[],
             options={
                 'proxy': True,
             },

educommon/audit_log/migrations/0004_reinstall_audit_log.py

@@ -8,11 +8,8 @@ from educommon.audit_log.utils.operations import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0003_logproxy'),
     ]
 
-    operations = [
-        ReinstallAuditLog()
-    ]
+    operations = [ReinstallAuditLog()]

educommon/audit_log/migrations/0005_postgresql_error.py

@@ -8,7 +8,6 @@ from educommon.audit_log.utils.operations import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0004_reinstall_audit_log'),
     ]
@@ -17,6 +16,9 @@ class Migration(migrations.Migration):
         ReinstallAuditLog(),
         migrations.AlterModelOptions(
             name='auditlog',
-            options={'verbose_name': '\u0417\u0430\u043f\u0438\u0441\u044c \u0436\u0443\u0440\u043d\u0430\u043b\u0430 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439', 'verbose_name_plural': '\u0417\u0430\u043f\u0438\u0441\u0438 \u0436\u0443\u0440\u043d\u0430\u043b\u0430 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439'},
+            options={
+                'verbose_name': '\u0417\u0430\u043f\u0438\u0441\u044c \u0436\u0443\u0440\u043d\u0430\u043b\u0430 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439',
+                'verbose_name_plural': '\u0417\u0430\u043f\u0438\u0441\u0438 \u0436\u0443\u0440\u043d\u0430\u043b\u0430 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439',
+            },
         ),
     ]

educommon/audit_log/migrations/0006_auto_20200806_1707.py

@@ -8,7 +8,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0005_postgresql_error'),
     ]
@@ -19,8 +18,8 @@ class Migration(migrations.Migration):
             name='time',
             field=models.DateTimeField(
                 auto_now_add=True,
-                validators=[django.core.validators.MinValueValidator(
-                    datetime.datetime(1900, 1, 1, 0, 0))],
-                verbose_name='Дата, время'),
+                validators=[django.core.validators.MinValueValidator(datetime.datetime(1900, 1, 1, 0, 0))],
+                verbose_name='Дата, время',
+            ),
         ),
     ]

educommon/audit_log/migrations/0007_create_selective_tables_function.py

@@ -13,14 +13,17 @@ def drop_select_table_function(apps, schema_editor):
         return
 
     cursor = connections[settings.DEFAULT_DB_ALIAS].cursor()
-    cursor.execute('\n'.join((
-        "SELECT",
-        "audit.drop_functions_by_name('set_for_selective_tables_triggers');",
-    )))
+    cursor.execute(
+        '\n'.join(
+            (
+                'SELECT',
+                "audit.drop_functions_by_name('set_for_selective_tables_triggers');",
+            )
+        )
+    )
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0006_auto_20200806_1707'),
     ]

educommon/audit_log/migrations/0008_table_logged.py

@@ -7,7 +7,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0007_create_selective_tables_function'),
     ]

educommon/audit_log/migrations/0009_reinstall_audit_log.py

@@ -8,7 +8,6 @@ from educommon.audit_log.utils.operations import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('audit_log', '0008_table_logged'),
     ]

educommon/audit_log/models.py

@@ -66,15 +66,10 @@ if TYPE_CHECKING:
 
 
 class Table(ReadOnlyMixin, BaseModel):
+    """Модель для хранения информации о таблицах, отслеживаемых системой аудита."""
 
-    name = models.CharField(
-        max_length=250,
-        verbose_name='Имя таблицы'
-    )
-    schema = models.CharField(
-        max_length=250,
-        verbose_name='Схема таблицы'
-    )
+    name = models.CharField(max_length=250, verbose_name='Имя таблицы')
+    schema = models.CharField(max_length=250, verbose_name='Схема таблицы')
     logged = models.BooleanField(
         default=True,
         verbose_name='Отслеживаемость таблицы',
@@ -87,6 +82,18 @@ class Table(ReadOnlyMixin, BaseModel):
 
 
 class AuditLog(ReadOnlyMixin, BaseModel):
+    """Модель для хранения записей журнала изменений.
+
+    Каждая запись описывает изменение конкретного объекта определённой модели,
+    с указанием пользователя, действия, IP-адреса и зафиксированных данных.
+
+    Поля:
+        - table: ссылка на таблицу, в которой произошло изменение;
+        - data: сериализованные значения объекта до изменения;
+        - changes: изменения (только изменённые поля);
+        - operation: тип действия (создание, изменение, удаление);
+        - user_id, user_type_id, ip, time: информация об авторе действия.
+    """
 
     OPERATION_CREATE = 1
     OPERATION_UPDATE = 2
@@ -94,7 +101,7 @@ class AuditLog(ReadOnlyMixin, BaseModel):
     OPERATION_CHOICES = (
         (OPERATION_CREATE, 'Создание'),
         (OPERATION_UPDATE, 'Изменение'),
-        (OPERATION_DELETE, 'Удаление')
+        (OPERATION_DELETE, 'Удаление'),
     )
 
     user_id = models.IntegerField(
@@ -107,36 +114,17 @@ class AuditLog(ReadOnlyMixin, BaseModel):
         db_index=True,
         verbose_name='Тип пользователя',
     )
-    ip = models.GenericIPAddressField(
-        null=True,
-        verbose_name='IP адрес'
-    )
-    time = models.DateTimeField(
-        auto_now_add=True,
-        db_index=True,
-        verbose_name='Дата, время'
-    )
+    ip = models.GenericIPAddressField(null=True, verbose_name='IP адрес')
+    time = models.DateTimeField(auto_now_add=True, db_index=True, verbose_name='Дата, время')
     table = models.ForeignKey(
         Table,
         verbose_name='Таблица',
         on_delete=models.CASCADE,
     )
-    object_id = models.IntegerField(
-        db_index=True,
-        verbose_name='Объект модели'
-    )
-    data = HStoreField(
-        null=True,
-        verbose_name='Объект'
-    )
-    changes = HStoreField(
-        null=True,
-        verbose_name='Изменения'
-    )
-    operation = models.SmallIntegerField(
-        choices=OPERATION_CHOICES,
-        verbose_name='Действие'
-    )
+    object_id = models.IntegerField(db_index=True, verbose_name='Объект модели')
+    data = HStoreField(null=True, verbose_name='Объект')
+    changes = HStoreField(null=True, verbose_name='Изменения')
+    operation = models.SmallIntegerField(choices=OPERATION_CHOICES, verbose_name='Действие')
 
     @property
     def transformed_data(self) -> Dict[str, Any]:
@@ -153,6 +141,7 @@ class AuditLog(ReadOnlyMixin, BaseModel):
         return True
 
     def get_read_only_error_message(self, delete):
+        """Возвращает сообщение об ошибке при попытке изменить или удалить запись."""
         action_text = 'удалить' if delete else 'изменить'
         result = 'Нельзя {} запись лога.'.format(action_text)
         return result
@@ -170,10 +159,7 @@ class AuditLog(ReadOnlyMixin, BaseModel):
         """
         model = self.model
         if model:
-            result = {
-                field.get_attname_column()[1]: field
-                for field in model._meta.fields
-            }
+            result = {field.get_attname_column()[1]: field for field in model._meta.fields}
             return result
 
     @property
@@ -248,10 +234,7 @@ class AuditLog(ReadOnlyMixin, BaseModel):
 
             items = value[1:-1]
             if items:
-                return [
-                    base_field.to_python(item)
-                    for item in items.split(',')
-                ]
+                return [base_field.to_python(item) for item in items.split(',')]
 
     class Meta:
         verbose_name = 'Запись журнала изменений'
@@ -290,10 +273,13 @@ class PostgreSQLError(BaseModel):
 
 class LoggableModelMixin(models.Model):
     """Делает модель логируемой."""
+
     need_to_log = True
 
     class Meta:
         abstract = True
+
+
 # -----------------------------------------------------------------------------
 # Передача параметров контекста журналирования изменений в задания Celery.
 
@@ -341,13 +327,21 @@ def _set_audit_log_context_for_task(kwargs, **_):
 
 @task_postrun.connect(dispatch_uid=_package_name + 'unset')
 def _unset_audit_log_context_for_task(task, kwargs, **_):
+    """Очищает параметры журнала изменений после выполнения Celery-задания."""
     if hasattr(thread_data, 'audit_log_params'):
         del thread_data.audit_log_params
 
 
 @receiver(connection_created, dispatch_uid=_package_name + 'send')
 def _send_audit_log_context_to_db(**kwargs):
+    """Передаёт параметры контекста журнала изменений в БД при подключении.
+
+    Используется для установки параметров в PostgreSQL через set_config,
+    чтобы аудит знал, кто инициировал изменения.
+    """
     if hasattr(thread_data, 'audit_log_params'):
         for name, value in thread_data.audit_log_params.items():
             set_db_param('audit_log.' + name, value)
+
+
 # -----------------------------------------------------------------------------

educommon/audit_log/permissions.py

@@ -8,15 +8,17 @@ PERM__AUDIT_LOG__ERRORS__DELETE = PERM_GROUP__AUDIT_LOG_ERRORS + '/delete'
 
 
 permissions = (
-    (PERM__AUDIT_LOG__VIEW,
-     'Просмотр',
-     'Разрешает просмотр журнала изменений.'),
-    (PERM__AUDIT_LOG__ERRORS__VIEW,
-     'Просмотр журнала ошибок PostgreSQL',
-     'Разрешает просмотр журнала ошибок PostgreSQL.'),
-    (PERM__AUDIT_LOG__ERRORS__DELETE,
-     'Удаление записей журнала ошибок PostgreSQL',
-     'Разрешает удаление записей из журнала ошибок PostgreSQL.'),
+    (PERM__AUDIT_LOG__VIEW, 'Просмотр', 'Разрешает просмотр журнала изменений.'),
+    (
+        PERM__AUDIT_LOG__ERRORS__VIEW,
+        'Просмотр журнала ошибок PostgreSQL',
+        'Разрешает просмотр журнала ошибок PostgreSQL.',
+    ),
+    (
+        PERM__AUDIT_LOG__ERRORS__DELETE,
+        'Удаление записей журнала ошибок PostgreSQL',
+        'Разрешает удаление записей из журнала ошибок PostgreSQL.',
+    ),
 )
 
 

educommon/audit_log/proxies.py

@@ -1,5 +1,10 @@
 import os
 
+from abc import (
+    ABCMeta,
+    abstractmethod,
+)
+
 from django.conf import (
     settings,
 )
@@ -36,8 +41,12 @@ from educommon.audit_log.models import (
 )
 
 
-class LogProxy(AuditLog):
-    """Прокси-модель для отображения."""
+class LogProxyMeta(type(AuditLog), ABCMeta):
+    """Метакласс для устранения конфликта при наследовании от AuditLog и использовании ABCMeta"""
+
+
+class LogProxy(AuditLog, metaclass=LogProxyMeta):
+    """Абстрактный класс прокси-модели для отображения."""
 
     class Meta:
         proxy = True
@@ -53,16 +62,22 @@ class LogProxy(AuditLog):
             except ContentType.DoesNotExist:
                 result = 'Model:{}, id:{}'.format(user_type_id, user_id)
             else:
-                try:
-                    result = model.objects.get(id=user_id).person.fullname
-                except model.DoesNotExist:
-                    result = '{}({})'.format(
-                        model._meta.verbose_name, user_id
-                    )
+                result = self.user_fullname or f'{model._meta.verbose_name}({user_id})'
         else:
             result = ''
+
         return result
 
+    @property
+    @abstractmethod
+    def user_fullname(self) -> str:
+        """Полное имя пользователя."""
+
+    @property
+    @abstractmethod
+    def user_organization(self) -> str:
+        """Название организации, к которой привязан пользователь."""
+
     @property
     def model_fullname(self):
         """Отображаемое и системное имя модели."""
@@ -113,7 +128,7 @@ class LogProxy(AuditLog):
             {
                 'name': self.get_field_string(key),
                 'old': self.convert_field_value(key, data.get(key, '')),
-                'new': self.convert_field_value(key, new_data.get(key, ''))
+                'new': self.convert_field_value(key, new_data.get(key, '')),
             }
             for key in keys
         ]
@@ -132,10 +147,12 @@ class LogProxy(AuditLog):
             field = self.fields.get(column_name)
             if field and field.verbose_name:
                 name = force_str(field.verbose_name)
+
         return name
 
     def convert_field_value(self, column_name, value):
         """Возвращает значение поля."""
+
         def get_choice(choices, choice_id):
             if choice_id:
                 choice_id = int(choice_id)
@@ -153,18 +170,14 @@ class LogProxy(AuditLog):
                             related = get_related(field)
                             model = related.parent_model
                             field_name = related.relation.field_name
-                            qs = model._default_manager.filter(
-                                **{field_name: value}
-                            )[:1]
+                            qs = model._default_manager.filter(**{field_name: value})[:1]
                             if qs:
                                 value = '{{{}}} {}'.format(
                                     qs[0].id,
                                     self._get_object_verbose_name(qs[0]),
                                 )
                     elif isinstance(field, BooleanField):
-                        value_map = {
-                            't': 'Да', 'f': 'Нет'
-                        }
+                        value_map = {'t': 'Да', 'f': 'Нет'}
                         value = value_map.get(value, value)
                     elif isinstance(field, IntegerField) and field.choices:
                         value = get_choice(field.choices, value)
@@ -173,11 +186,8 @@ class LogProxy(AuditLog):
         return force_str(value)
 
     @property
-    def object_string(self):
-        """Отображаемое имя экземпляра модели.
-
-        :rtype str
-        """
+    def object_string(self) -> str:
+        """Отображаемое имя экземпляра модели."""
         instance = self.instance
         if instance:
             return self._get_object_verbose_name(instance)
@@ -190,10 +200,7 @@ class LogProxy(AuditLog):
 
         if self.model:
             result = self.model()
-            fields_dict = {
-                field.name: field for field in
-                self.model._meta.fields
-            }
+            fields_dict = {field.name: field for field in self.model._meta.fields}
             for key, value in self.data.items():
                 field = fields_dict.get(key)
                 converted_value = value
@@ -210,15 +217,13 @@ class LogProxy(AuditLog):
                         elif isinstance(field, FloatField):
                             converted_value = float(value)
                         elif isinstance(field, FileField):
-                            file_path = os.path.join(
-                                settings.MEDIA_ROOT,
-                                converted_value
-                            )
+                            file_path = os.path.join(settings.MEDIA_ROOT, converted_value)
                             if not os.path.exists(file_path):
                                 converted_value = None
                     except (ValueError, TypeError):
                         pass
                 setattr(result, key, converted_value)
+
         return result
 
     @staticmethod

educommon/audit_log/ui.py

@@ -21,7 +21,12 @@ class ViewChangeWindow(BaseWindow):
     """Окно просмотра изменений."""
 
     def _init_components(self):
-        super(ViewChangeWindow, self)._init_components()
+        """Метод создаёт визуальные компоненты.
+
+        Метод отражает поля модели, но не определяет расположение компонентов в окне.
+        """
+        super()._init_components()
+
         self.grid = ExtObjectGrid(region='center')
         self.grid.add_column(data_index='name', header='Поле')
         self.grid.add_column(data_index='old', header='Старое значение')
@@ -30,38 +35,30 @@ class ViewChangeWindow(BaseWindow):
 
         self.user_field = ExtStringField(label='Пользователь')
         self.unit_field = ExtStringField(label='Учреждение')
-        self.top_region = ExtContainer(
-            region='north', layout='hbox', height=32
-        )
+        self.top_region = ExtContainer(region='north', layout='hbox', height=32)
 
     def _do_layout(self):
-        super(ViewChangeWindow, self)._do_layout()
+        """Метод располагает уже созданные визуальные компоненты на окне."""
+        super()._do_layout()
 
         self.layout = 'border'
         self.width, self.height = 750, 400
 
         self.grid.cls = 'word-wrap-grid'
 
-        self.top_region.items.extend((
-            formed(self.user_field, flex=1, style=dict(padding='5px')),
-            formed(self.unit_field, flex=1, style=dict(padding='5px'))
-        ))
+        self.top_region.items.extend(
+            (
+                formed(self.user_field, flex=1, style=dict(padding='5px')),
+                formed(self.unit_field, flex=1, style=dict(padding='5px')),
+            )
+        )
         self.items.extend((self.top_region, self.grid))
 
     def set_params(self, params):
+        """Метод принимает словарь, содержащий параметры окна, передаваемые в окно слоем экшнов."""
         self.grid.action_data = params['grid_action']
         log_record = params['object']
-        self.title = '{}: {}'.format(
-            log_record.get_operation_display(),
-            log_record.model_name
-        )
+        self.title = '{}: {}'.format(log_record.get_operation_display(), log_record.model_name)
         if log_record.user:
-            self.user_field.value = '{} / {}'.format(
-                log_record.user.person.fullname,
-                log_record.user.person.user.username
-            )
-            unit = getattr(log_record.user, 'unit', None)
-            if unit:
-                self.unit_field.value = unit.short_name
-            else:
-                self.unit_field.value = ''
+            self.user_field.value = f'{log_record.user_fullname} / {log_record.user.username}'
+            self.unit_field.value = log_record.user_organization