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

educommon/audit_log/utils/__init__.py

@@ -1,3 +1,4 @@
+# TODO - EDUSCHL-23454
 import os
 from contextlib import (
     closing,
@@ -72,11 +73,7 @@ def configure(force_update_triggers: bool = False):
     params['need_to_update_triggers'] = force_update_triggers or changed_table
     params['lock_id'] = PG_LOCK_ID
 
-    execute_sql_file(
-        settings.DEFAULT_DB_ALIAS,
-        os.path.join(SQL_FILES_DIR, 'configure_audit_log.sql'),
-        params
-    )
+    execute_sql_file(settings.DEFAULT_DB_ALIAS, os.path.join(SQL_FILES_DIR, 'configure_audit_log.sql'), params)
 
 
 def get_all_table_names(db_alias: str, schema: str) -> Set[str]:
@@ -97,11 +94,7 @@ def get_all_table_names(db_alias: str, schema: str) -> Set[str]:
 
 def get_need_to_log_table_names() -> Set[str]:
     """Возвращает перечень наименований таблиц моделей, которые отмечены как отслеживаемые."""
-    table_names = {
-        model._meta.db_table
-        for model in apps.get_models()
-        if getattr(model, 'need_to_log', False)
-    }
+    table_names = {model._meta.db_table for model in apps.get_models() if getattr(model, 'need_to_log', False)}
 
     return table_names
 
@@ -114,9 +107,7 @@ def update_or_create_tables(need_to_log_table_names: Iterable[str]) -> bool:
     Table = apps.get_model('audit_log', 'Table')
 
     need_to_log_table_names = set(need_to_log_table_names)
-    existed_table_names = set(
-        Table.objects.filter(schema='public').values_list('name', flat=True)
-    )
+    existed_table_names = set(Table.objects.filter(schema='public').values_list('name', flat=True))
 
     to_create_table_names = need_to_log_table_names - existed_table_names
     to_disable_table_names = existed_table_names - need_to_log_table_names
@@ -141,10 +132,7 @@ def update_or_create_tables(need_to_log_table_names: Iterable[str]) -> bool:
 
     # Создание записей таблиц, которые теперь отслеживаемые
     Table.objects.bulk_create(
-        objs=[
-            Table(name=table, schema='public')
-            for table in to_create_table_names
-        ],
+        objs=[Table(name=table, schema='public') for table in to_create_table_names],
     )
 
     if to_create_table_names or enabled_count or disabled_count:
@@ -229,10 +217,8 @@ def is_initialized(database_alias):
     # Проверка наличия таблицы postgresql_errors
     with closing(connections[database_alias].cursor()) as cursor:
         cursor.execute(
-            'select 1 '
-            'from information_schema.tables '
-            'where table_schema = %s and table_name = %s',
-            ('audit', 'postgresql_errors')
+            'select 1 from information_schema.tables where table_schema = %s and table_name = %s',
+            ('audit', 'postgresql_errors'),
         )
         if cursor.fetchone() is None:
             return False
@@ -251,12 +237,12 @@ def is_initialized(database_alias):
     for function_name in function_names:
         with closing(connections[database_alias].cursor()) as cursor:
             cursor.execute(
-                "select 1 "
-                "from pg_proc proc "
-                "inner join pg_namespace ns on ns.oid = proc.pronamespace "
-                "where proc.proname = %s and ns.nspname = %s "
-                "limit 1",
-                [function_name, 'audit']
+                'select 1 '
+                'from pg_proc proc '
+                'inner join pg_namespace ns on ns.oid = proc.pronamespace '
+                'where proc.proname = %s and ns.nspname = %s '
+                'limit 1',
+                [function_name, 'audit'],
             )
             if cursor.fetchone() is None:
                 return False
@@ -304,7 +290,7 @@ def get_db_connection_params():
         dbname=target_db_conf['NAME'],
         port=target_db_conf['PORT'],
         user=target_db_conf['USER'],
-        password=target_db_conf['PASSWORD']
+        password=target_db_conf['PASSWORD'],
     )
 
 
@@ -355,40 +341,18 @@ def make_hstore_filter(field, value):
     :param str value: значение, по которому фильтруется queryset.
     Если строка, то разбивается на отдельные слова.
     """
-    result = reduce(
-        and_,
-        (Q(**{'%s__values__icontains' % field: x}) for x in value.split(' '))
-    )
+    result = reduce(and_, (Q(**{f'{field}__values__icontains': x}) for x in value.split(' ')))
     return result
 
 
-def make_name_filter(field, value):
-    """Создает lookup фильтра по фамилии/имени/отчеству пользователя.
+class ModelRegistry:
+    """Реестр моделей Django по имени таблицы.
 
-    :param str field: название поля ('firstname', 'surname', 'patronymic').
-    :param str value: значение, по которому фильтруется queryset.
+    Позволяет получать класс модели по имени таблицы из базы данных.
+    Использует кэшируемое свойство для построения соответствия
+    между именами таблиц и их моделями, включая автоматически
+    создаваемые модели, но исключая proxy-модели.
     """
-    ContentType = apps.get_model('contenttypes', 'ContentType')
-    Employee = apps.get_model('employee', 'Employee')
-    SysAdmin = apps.get_model('sysadmin', 'SysAdmin')
-
-    result = None
-    for model in (Employee, SysAdmin):
-        type_id = ContentType.objects.get_for_model(model).id
-        user_ids = list(
-            model.objects.filter(
-                **{'person__{}__icontains'.format(field): value}
-            ).values_list('id', flat=True)
-        )
-        qobj = Q(user_id__in=user_ids, user_type_id=type_id)
-        if result:
-            result |= qobj
-        else:
-            result = qobj
-    return result
-
-
-class ModelRegistry:
 
     @cached_property
     def table_model(self):
@@ -415,16 +379,9 @@ def get_model_choices(excluded=None):
     table_class = apps.get_model('audit_log', 'Table')
     if excluded:
         total_exclude += tuple(excluded)
-    tables = (
-        table
-        for table in table_class.objects.iterator()
-        if (table.schema, table.name) not in total_exclude
-    )
+    tables = (table for table in table_class.objects.iterator() if (table.schema, table.name) not in total_exclude)
 
-    result = sorted(
-        ((table.id, get_table_name(table)) for table in tables),
-        key=lambda x: x[1]
-    )
+    result = sorted(((table.id, get_table_name(table)) for table in tables), key=lambda x: x[1])
 
     return tuple(result)
 
@@ -435,12 +392,7 @@ def _get_m2m_model_fields(model):
     :return Два поля типа ForeignKey или None, если таблица не
             соответствует автоматически созданной.
     """
-    result = [
-        field
-        for field
-        in model._meta.get_fields()
-        if isinstance(field, related.ForeignKey)
-    ]
+    result = [field for field in model._meta.get_fields() if isinstance(field, related.ForeignKey)]
     if len(result) == 2:
         return result
 
@@ -454,16 +406,10 @@ def get_table_name(table):
         if model._meta.auto_created:
             fields = _get_m2m_model_fields(model)
             if fields:
-                names = [
-                    get_related(f).parent_model._meta.verbose_name
-                    for f in fields
-                ]
+                names = [get_related(f).parent_model._meta.verbose_name for f in fields]
                 verbose_name = 'Связь {}, {}'.format(names[0], names[1])
 
-        return '{} - {}'.format(
-            verbose_name,
-            class_name
-        )
+        return f'{verbose_name} - {class_name}'
     else:
         return table.name
 
@@ -479,7 +425,7 @@ def get_audit_log_context(request):
     result = {}
 
     current_user = ioc.get('get_current_user')(request)
-    if current_user:
+    if current_user and current_user.is_authenticated:
         ContentType = apps.get_model('contenttypes', 'ContentType')
 
         result['user_id'] = current_user.id

educommon/audit_log/utils/operations.py

@@ -32,6 +32,7 @@ class ReinstallAuditLog(Operation):
 
     @staticmethod
     def _read_sql(filename):
+        """Читает SQL-файл и экранирует знаки процента."""
         sql_file_path = os.path.join(SQL_FILES_DIR, filename)
         with codecs.open(sql_file_path, 'r', 'utf-8') as sql_file:
             sql = sql_file.read().replace('%', '%%')
@@ -39,17 +40,30 @@ class ReinstallAuditLog(Operation):
 
     @property
     def _install_sql(self):
+        """Генерирует SQL-скрипт для установки схемы audit_log.
+
+        Подставляет параметры подключения к БД и lock_id
+        в шаблон SQL-файла install_audit_log.sql.
+        """
         params = get_db_connection_params()
         params['lock_id'] = PG_LOCK_ID
         return self._read_sql('install_audit_log.sql').format(**params)
 
     def state_forwards(self, app_label, state):
+        """Не изменяет состояние проекта в памяти.
+
+        Метод требуется по контракту абстрактного базового класса Operation.
+        """
         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):
+        """Применяет SQL-скрипт установки audit_log, если используется основная БД."""
         if schema_editor.connection.alias == settings.DEFAULT_DB_ALIAS:
             schema_editor.execute(self._install_sql)
 
     def database_backwards(self, app_label, schema_editor, from_state, to_state):
+        """Откат миграции не реализован (no-op).
+
+        Метод присутствует, чтобы соответствовать контракту Django.
+        """
         return None

educommon/auth/__init__.py

@@ -1,4 +1 @@
 """Средства аутентификации и авторизации."""
-from __future__ import (
-    absolute_import,
-)

educommon/auth/rbac/__init__.py

@@ -3,12 +3,10 @@
 .. note::
    RBAC - Role Based Access Control.
 """
+
 from django import (
     VERSION as _django_version,
 )
 
 
-assert _django_version >= (1, 8), (
-    "{} app doesn't support Django {}.{}."
-    .format(__name__, *_django_version[:2])
-)
+assert _django_version >= (1, 8), "{} app doesn't support Django {}.{}.".format(__name__, *_django_version[:2])