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

educommon/contingent/contingent_plugin/actions.py

@@ -8,24 +8,13 @@ from educommon.contingent.contingent_plugin.models import (
 
 
 class ContingentModelChangedPack(ObjectPack):
+    """Пак для отображения изменённых объектов контингента."""
 
     title = 'Измененные объекты контингента'
     model = ContingentModelChanged
 
-    columns = [
-        {
-            'data_index': 'content_type',
-            'header': 'Тип'
-        },
-        {
-            'data_index': 'content_object',
-            'header': 'Объект'
-        }
-    ]
+    columns = [{'data_index': 'content_type', 'header': 'Тип'}, {'data_index': 'content_object', 'header': 'Объект'}]
 
     def extend_menu(self, menu):
-        return menu.SubMenu(
-            'Администрирование', menu.Item(
-                self.title, self.list_window_action
-            )
-        )
+        """Добавляет пункт в подменю 'Администрирование'."""
+        return menu.SubMenu('Администрирование', menu.Item(self.title, self.list_window_action))

educommon/contingent/contingent_plugin/apps.py

@@ -14,6 +14,10 @@ _VERSION = VERSION[:2]
 
 
 class ContingentPluginAppConfig(AppConfig):
+    """Конфигурация плагина контингента.
+
+    Отвечает за регистрацию представлений связанных моделей при старте приложения.
+    """
 
     name = __package__
 
@@ -27,10 +31,12 @@ class ContingentPluginAppConfig(AppConfig):
         )
 
         model_views = import_module(self.name + '.model_views')
-        registries['related_objects'].register(
-            *model_views.related_model_views
-        )
+        registries['related_objects'].register(*model_views.related_model_views)
 
     def ready(self):
-        super(ContingentPluginAppConfig, self).ready()
+        """Вызывается при готовности приложения.
+
+        Производит регистрацию представлений связанных моделей.
+        """
+        super().ready()
         self._register_related_objects_views()

educommon/contingent/contingent_plugin/migrations/0001_initial.py

@@ -12,7 +12,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
@@ -23,10 +22,7 @@ class Migration(migrations.Migration):
     # первым в списке выполняемых миграций. Начиная с версии 1.10 данный
     # способ не подходит ввиду ввода проверки на корректность плана миграций
     if VERSION < (1, 10):
-        run_before = [
-            (app_name.split('.')[-1], '__first__')
-            for app_name in settings.PROJECT_APPS
-        ]
+        run_before = [(app_name.split('.')[-1], '__first__') for app_name in settings.PROJECT_APPS]
 
     operations = [
         migrations.CreateModel(
@@ -34,7 +30,10 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('object_id', models.PositiveIntegerField()),
-                ('content_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType')),
+                (
+                    'content_type',
+                    models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType'),
+                ),
             ],
         ),
         migrations.AlterUniqueTogether(

educommon/contingent/contingent_plugin/migrations/0002_add_contingent_model_deleted.py

@@ -6,7 +6,6 @@ from django.db import (
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('contenttypes', '0002_remove_content_type_name'),
         ('contingent_plugin', '0001_initial'),
@@ -16,17 +15,13 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='ContingentModelDeleted',
             fields=[
-                ('id',
-                 models.AutoField(auto_created=True,
-                                  primary_key=True,
-                                  serialize=False,
-                                  verbose_name='ID')),
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('object_id', models.PositiveIntegerField()),
-                ('data',
-                 models.TextField(verbose_name='Данные об удалённом объекте')),
-                ('content_type',
-                 models.ForeignKey(on_delete=django.db.models.deletion.CASCADE,
-                                   to='contenttypes.ContentType')),
+                ('data', models.TextField(verbose_name='Данные об удалённом объекте')),
+                (
+                    'content_type',
+                    models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType'),
+                ),
             ],
         ),
         migrations.AlterUniqueTogether(

educommon/contingent/contingent_plugin/model_views.py

@@ -9,21 +9,11 @@ related_model_views = (
     HtmlTableView(
         model='contingent_plugin.ContingentModelChanged',
         description=Text('Измененная модель'),
-        columns=(
-            dict(
-                header=Text('Идентификатор объекта'),
-                data=AttrValue('object_id')
-            ),
-        )
+        columns=(dict(header=Text('Идентификатор объекта'), data=AttrValue('object_id')),),
     ),
     HtmlTableView(
         model='contingent_plugin.ContingentModelDeleted',
         description=Text('Удаленная модель'),
-        columns=(
-            dict(
-                header=Text('Идентификатор объекта'),
-                data=AttrValue('object_id')
-            ),
-        )
+        columns=(dict(header=Text('Идентификатор объекта'), data=AttrValue('object_id')),),
     ),
 )

educommon/contingent/contingent_plugin/models.py

@@ -13,7 +13,6 @@ from m3_django_compat.models import (
 
 
 class ContingentModelChanged(models.Model):
-
     """Данные об измененных моделях."""
 
     content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
@@ -54,14 +53,10 @@ if VERSION >= (1, 10):
         value = False
         index = 0
         for ind, migration_tuple in enumerate(plan):
-            if (migration_tuple[0].name == '0001_initial') and (
-                migration_tuple[0].app_label == 'contingent_plugin'
-            ):
+            if (migration_tuple[0].name == '0001_initial') and (migration_tuple[0].app_label == 'contingent_plugin'):
                 value = migration_tuple
 
-            if (
-                migration_tuple[0].name == '0002_remove_content_type_name'
-            ) and (
+            if (migration_tuple[0].name == '0002_remove_content_type_name') and (
                 migration_tuple[0].app_label == 'contenttypes'
             ):
                 index = ind

educommon/contingent/contingent_plugin/observer.py

@@ -15,10 +15,7 @@ from educommon.utils.storage import (
 )
 
 
-class ContingentFieldsObserver(
-    OriginalObjectMixin,
-    ModelObserverBase
-):
+class ContingentFieldsObserver(OriginalObjectMixin, ModelObserverBase):
     """Фиксирует изменения в полях моделей.
 
     Ссылки на измененные объекты сохраняются в модели
@@ -39,7 +36,7 @@ class ContingentFieldsObserver(
     """
 
     def __init__(self, model_fields=None):
-        super(ContingentFieldsObserver, self).__init__()
+        super().__init__()
 
         self.model_fields = model_fields
 
@@ -50,7 +47,7 @@ class ContingentFieldsObserver(
         """Проверяет наличие указаных полей model_fields в моделях."""
         for (app_label, model_name), fields in model_fields.items():
             model = get_model(app_label, model_name)
-            for field_name in (fields(model) if callable(fields) else fields):
+            for field_name in fields(model) if callable(fields) else fields:
                 model._meta.get_field(field_name)
 
         self.__checked = True
@@ -58,7 +55,9 @@ class ContingentFieldsObserver(
         return True
 
     def _is_observable(self, model):
+        """Проверяет, указана ли модель в конфигурации наблюдаемых полей."""
         key = model._meta.app_label, model.__name__
+
         return key in self.model_fields
 
     def observe(self, model):
@@ -73,6 +72,7 @@ class ContingentFieldsObserver(
         """
         key = model._meta.app_label, model.__name__
         fields = self.model_fields.get(key, ())
+
         return fields(model) if callable(fields) else fields
 
     def _has_changes(self, original, instance):
@@ -102,15 +102,14 @@ class ContingentFieldsObserver(
         ContentType = get_model('contenttypes', 'ContentType')
         content_type = ContentType.objects.get_for_model(instance)
 
-        ContingentModelChanged = get_model(
-            'contingent_plugin', 'ContingentModelChanged'
-        )
+        ContingentModelChanged = get_model('contingent_plugin', 'ContingentModelChanged')
         ContingentModelChanged.objects.get_or_create(
             content_type=content_type,
             object_id=instance.pk,
         )
 
     def post_save(self, context, instance, sender, *args, **kwargs):
+        """Обработчик сигнала post_save для наблюдаемых моделей."""
         if not self.__checked:
             assert self._is_model_fields_valid(self.model_fields)
 
@@ -118,9 +117,7 @@ class ContingentFieldsObserver(
             self._fix_changed_object(instance)
 
 
-class PreDeletionDataSavingObserver(
-    OriginalObjectMixin, ModelOnlyObserverMixin, ModelObserverBase
-):
+class PreDeletionDataSavingObserver(OriginalObjectMixin, ModelOnlyObserverMixin, ModelObserverBase):
     """Класс для перехвата и сохранения объекта модели перед удалением."""
 
     def __init__(self, storage, observables=None):
@@ -136,10 +133,14 @@ class PreDeletionDataSavingObserver(
         assert isinstance(storage, AbstractInstanceStorage)
         self._storage = storage
 
-        super(PreDeletionDataSavingObserver, self).__init__()
+        super().__init__()
         if observables:
             for model in observables:
                 self.observe(model)
 
     def pre_delete(self, instance, context, **kwargs):
+        """Сохраняет данные объекта перед его удалением.
+
+        Вызывается автоматически перед удалением объекта модели.
+        """
         self._storage.save(instance, context=context, **kwargs)

educommon/contingent/contingent_plugin/plugin_meta.py

@@ -1,4 +1,2 @@
 def connect_plugin(settings, plugin_settings):
-    settings['INSTALLED_APPS'].append(
-        __package__ + '.apps.ContingentPluginAppConfig'
-    )
+    settings['INSTALLED_APPS'].append(__package__ + '.apps.ContingentPluginAppConfig')

educommon/contingent/contingent_plugin/storage.py

@@ -7,13 +7,10 @@ from educommon.utils.storage import (
 )
 
 
-ContingentModelDeleted = get_model(
-    'contingent_plugin', 'ContingentModelDeleted')
+ContingentModelDeleted = get_model('contingent_plugin', 'ContingentModelDeleted')
 
 
-class ContingentDeletedInstancesDataStorage(
-    AbstractInstanceDataStorage
-):
+class ContingentDeletedInstancesDataStorage(AbstractInstanceDataStorage):
     """Класс для сохранения данных объекта модели для Контингента.
 
     Предполагается использование объекта этого класса вместе с классом
@@ -40,15 +37,18 @@ class ContingentDeletedInstancesDataStorage(
         :rtype: ContentType
         """
         ContentType = get_model('contenttypes', 'ContentType')
+
         return ContentType.objects.get_for_model(instance)
 
     def _is_instance_already_saved(self, instance, **kwargs):
+        """Проверяет, сохранён ли уже объект как удалённый."""
         return ContingentModelDeleted.objects.filter(
             content_type=self._get_instance_content_type(instance),
             object_id=instance.pk,
         ).exists()
 
     def _save_instance_data(self, instance, **kwargs):
+        """Сохраняет данные удаляемого объекта в модель ContingentModelDeleted."""
         instance_data = self._get_instance_data(instance)
         if instance_data is not None:
             ContingentModelDeleted.objects.get_or_create(
@@ -67,6 +67,7 @@ class ContingentDeletedInstancesDataStorage(
         pass
 
     def save(self, instance, **kwargs):
-        super(ContingentDeletedInstancesDataStorage, self).save(
-            instance, **kwargs)
+        """Сохраняет данные и вызывает удаление зависимостей после сохранения."""
+        super().save(instance, **kwargs)
+
         self.delete_some_objects_after_saving(instance, **kwargs)

educommon/contingent/contingent_plugin/utils.py

@@ -73,8 +73,7 @@ def get_params_from_deleted_model(model, object_id):
     :raise: ApplicationLogicException
     """
     obj = ContingentModelDeleted.objects.filter(
-        content_type=ContentType.objects.get_for_model(model),
-        object_id=object_id
+        content_type=ContentType.objects.get_for_model(model), object_id=object_id
     ).first()
 
     if not obj:
@@ -102,6 +101,7 @@ def get_param_value_from_deleted_model(model, object_id, param_name):
     """
     params = get_params_from_deleted_model(model, object_id)
     param_value = params.get(param_name)
+
     return param_value
 
 
@@ -130,10 +130,10 @@ def get_new_param_tuples(params_tuples, model):
     result_tuples = []
     for params_tuple in params_tuples:
         param_name = params_tuple[0]
-        new_function = partial(
-            get_param_value_from_deleted_model, model, param_name=param_name)
+        new_function = partial(get_param_value_from_deleted_model, model, param_name=param_name)
         param_tuple = (param_name, ('object_id', new_function), None, None)
         result_tuples.append(param_tuple)
+
     return tuple(result_tuples)
 
 
@@ -152,11 +152,11 @@ def get_original_and_deleted_instances_info(model, query_config):
     :rtype: Tuple[Tuple[QuerySet, tuple], Tuple[QuerySet, tuple]]
     """
     model_content_type = ContentType.objects.get_for_model(model)
-    new_query = ContingentModelDeleted.objects.filter(
-        content_type=model_content_type)
+    new_query = ContingentModelDeleted.objects.filter(content_type=model_content_type)
 
     _, params_tuples = query_config
     new_param_tuples = get_new_param_tuples(params_tuples, model)
 
     deleted_objects_query_config = new_query, new_param_tuples
+
     return query_config, deleted_objects_query_config

educommon/django/db/fields.py

@@ -1,4 +1,5 @@
 """Кастомные поля моделей Django"""
+
 from datetime import (
     datetime,
     timedelta,
@@ -61,188 +62,173 @@ class SingleErrorDecimalField(fields.DecimalField):
 
     @cached_property
     def validators(self):
-        """
-        Переопрелеление стандартного валидатора Decimal.
+        """Переопрелеление стандартного валидатора Decimal.
 
         :return: Список валидаторов.
         """
         validators = super(SingleErrorDecimalField, self).validators
+
         validators.pop()
-        validators.append(
-            simple.SingleErrorDecimalValidator(
-                self.max_digits, self.decimal_places
-            )
-        )
+        validators.append(simple.SingleErrorDecimalValidator(self.max_digits, self.decimal_places))
+
         return validators
 
 
 class FIOField(fields.CharField, IMaskRegexField):
+    """Поле для ввода ФИО с маской и валидацией.
+
+    Разрешены только буквы, пробелы и дефисы.
+    """
+
     _mask_re = r'^[а-яА-ЯёЁa-zA-Z\s-]*$'
 
-    default_validators = [
-        simple.FIOValidator()
-    ]
+    default_validators = [simple.FIOValidator()]
 
 
 class RangedDateField(fields.DateField):
     """Поле, реализующее валидаторы по умолчанию для границ периода"""
 
-    def __init__(self, minimum_date=datetime(1917, 1, 1).date(),
-                 maximum_date=None, **kwargs):
-        super(RangedDateField, self).__init__(**kwargs)
-        self.validators.append(simple.date_range_validator(
-            minimum=minimum_date, maximum=maximum_date))
+    def __init__(self, minimum_date=datetime(1, 1, 1).date(), maximum_date=None, **kwargs):
+        super().__init__(**kwargs)
+        self.validators.append(simple.date_range_validator(minimum=minimum_date, maximum=maximum_date))
 
 
 class LastNameField(FIOField):
     """Расширение поля ФИО для фамилии"""
 
     def __init__(self, verbose_name='Фамилия', max_length=30, **kwargs):
-        super(LastNameField, self).__init__(
-            verbose_name=verbose_name, max_length=max_length, **kwargs)
+        super().__init__(verbose_name=verbose_name, max_length=max_length, **kwargs)
 
 
 class FirstNameField(FIOField):
     """Расширение поля ФИО для имени"""
 
     def __init__(self, verbose_name='Имя', max_length=30, **kwargs):
-        super(FirstNameField, self).__init__(
-            verbose_name=verbose_name, max_length=max_length, **kwargs)
+        super().__init__(verbose_name=verbose_name, max_length=max_length, **kwargs)
 
 
 class MiddleNameField(FIOField):
     """Расширение поля ФИО для отчества"""
 
-    def __init__(self, verbose_name='Отчество',
-                 null=True, blank=True, max_length=30, **kwargs):
-        super(MiddleNameField, self).__init__(
-            verbose_name=verbose_name, null=null, blank=blank,
-            max_length=max_length, **kwargs)
+    def __init__(self, verbose_name='Отчество', null=True, blank=True, max_length=30, **kwargs):
+        super().__init__(verbose_name=verbose_name, null=null, blank=blank, max_length=max_length, **kwargs)
 
 
 class SNILSField(fields.CharField, IMaskRegexField):
+    """Поле модели для ввода СНИЛС с маской и валидацией."""
 
     _mask_re = r'^[-\s\d]{0,14}$'
 
-    default_validators = [
-        simple.SNILSValidator()
-    ]
+    default_validators = [simple.SNILSValidator()]
 
-    def __init__(
-        self, verbose_name='СНИЛС', **kwargs
-    ):
+    def __init__(self, verbose_name='СНИЛС', **kwargs):
         kwargs.setdefault('max_length', 14)
-        super(SNILSField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class BirthDateField(RangedDateField):
-    def __init__(self, minimum_date=datetime(1917, 1, 1).date(),
-                 maximum_date=date_difference_as_callable(timedelta(days=1)),
-                 verbose_name='Дата рождения', **kwargs):
-        super(BirthDateField, self).__init__(
-            minimum_date=minimum_date, maximum_date=maximum_date,
-            verbose_name=verbose_name, **kwargs)
+    """Поле даты рождения с ограничением по минимальной и максимальной дате."""
+
+    def __init__(
+        self,
+        minimum_date=datetime(1, 1, 1).date(),
+        maximum_date=date_difference_as_callable(timedelta(days=1)),
+        verbose_name='Дата рождения',
+        **kwargs,
+    ):
+        super().__init__(minimum_date=minimum_date, maximum_date=maximum_date, verbose_name=verbose_name, **kwargs)
 
 
 class DocumentSeriesField(fields.CharField, IMaskRegexField):
+    """Поле серии документа с маской и соответствующим валидатором."""
+
     _mask_re = r'^[a-zA-Zа-яА-ЯёЁ\d\s|\-|\.|\,|\\|\/]*$'
 
-    default_validators = [
-        simple.DocumentSeriesValidator()
-    ]
+    default_validators = [simple.DocumentSeriesValidator()]
 
-    def __init__(
-        self, verbose_name='Серия документа', **kwargs
-    ):
-        super(DocumentSeriesField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+    def __init__(self, verbose_name='Серия документа', **kwargs):
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class DocumentNumberField(fields.CharField, IMaskRegexField):
+    """Поле номера документа с маской и соответствующим валидатором."""
+
     _mask_re = r'^[a-zA-Zа-яА-ЯёЁ\d\s|\-|\.|\,|\\|\/]*$'
 
-    default_validators = [
-        simple.DocumentNumberValidator()
-    ]
+    default_validators = [simple.DocumentNumberValidator()]
 
-    def __init__(
-        self, verbose_name='Номер документа', **kwargs
-    ):
-        super(DocumentNumberField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+    def __init__(self, verbose_name='Номер документа', **kwargs):
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class PassportSeriesField(DocumentSeriesField):
+    """Поле серии паспорта с числовой маской и ограничением по длине."""
+
     _mask_re = r'^\d{0,4}$'
 
-    default_validators = [
-        simple.PassportSeriesValidator()
-    ]
+    default_validators = [simple.PassportSeriesValidator()]
 
-    def __init__(
-        self, verbose_name='Серия паспорта', **kwargs
-    ):
+    def __init__(self, verbose_name='Серия паспорта', **kwargs):
         kwargs.setdefault('max_length', 4)
-        super(PassportSeriesField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class PassportNumberField(DocumentNumberField):
+    """Поле номера паспорта с числовой маской и ограничением по длине."""
+
     _mask_re = r'^\d{0,6}$'
 
-    default_validators = [
-        simple.PassportNumberValidator()
-    ]
+    default_validators = [simple.PassportNumberValidator()]
 
-    def __init__(
-        self, verbose_name='Номер паспорта', **kwargs
-    ):
+    def __init__(self, verbose_name='Номер паспорта', **kwargs):
         kwargs.setdefault('max_length', 6)
-        super(PassportNumberField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class INNField(fields.CharField, IMaskRegexField):
+    """Поле ИНН с маской и встроенной валидацией."""
+
     _mask_re = r'^\d{0,12}$'
 
-    default_validators = [
-        simple.inn_validator
-    ]
+    default_validators = [simple.inn_validator]
 
     def __init__(self, verbose_name='ИНН', **kwargs):
         kwargs.setdefault('max_length', 12)
-        super(INNField, self).__init__(verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)
 
 
 class KPPField(fields.CharField, IMaskRegexField):
+    """Поле КПП с маской, без дублирования ошибок превышения длины."""
+
     _mask_re = r'^\d{0,9}$'
 
-    default_validators = [
-        simple.kpp_validator
-    ]
+    default_validators = [simple.kpp_validator]
 
     def __init__(self, verbose_name='КПП', **kwargs):
         kwargs.setdefault('max_length', 9)
-        super(KPPField, self).__init__(
-            verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)
+
         # из за стандартного валидатора дублируются сообщения об ошибке
         # привышения длинны поля
         try:
-            self.validators.remove(
-                validators.MaxLengthValidator(self.max_length)
-            )
+            self.validators.remove(validators.MaxLengthValidator(self.max_length))
         except ValueError:
             pass
 
 
 class OGRNField(fields.CharField, IMaskRegexField):
+    """Поле ОГРН с маской и встроенной валидацией."""
+
     _mask_re = r'^\d{0,15}$'
 
-    default_validators = [
-        simple.ogrn_validator
-    ]
+    default_validators = [simple.ogrn_validator]
 
     def __init__(self, verbose_name='ОГРН', **kwargs):
         kwargs.setdefault('max_length', 15)
-        super(OGRNField, self).__init__(verbose_name=verbose_name, **kwargs)
+
+        super().__init__(verbose_name=verbose_name, **kwargs)

educommon/django/db/migration/__init__.py

@@ -7,8 +7,7 @@ from operator import (
 )
 
 
-def date_difference_as_callable(
-        diff, date_fn=datetime.date.today, operator_=sub):
+def date_difference_as_callable(diff, date_fn=datetime.date.today, operator_=sub):
     """Функция, возвращающая callable-объект, не принимающий аргументов и
     возвращающий дату.
     Используется для валидации дат, когда нужно проверить не точную дату, а
@@ -24,13 +23,10 @@ def date_difference_as_callable(
     :return:
     :rtype: Callable[[], datetime.date]
     """
-    return partial(
-        _get_time_difference_from_callable,
-        operator_=operator_, date_fn=date_fn, diff=diff)
+    return partial(_get_time_difference_from_callable, operator_=operator_, date_fn=date_fn, diff=diff)
 
 
-def _get_time_difference_from_callable(
-        operator_, date_fn, diff):
+def _get_time_difference_from_callable(operator_, date_fn, diff):
     """Вспомогательная функция для сериализации валидатора при генерации
     файла-миграции. Нужен для того, чтобы при генерации миграции функция
     date_fn не разворачивалась в точное значение, а оставалась функцией.