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

educommon/report/constructor/models.py

@@ -59,9 +59,7 @@ class ReportTemplate(CascadeDeleteMixin, BaseModel):
         choices=FORMAT_CHOICES,
         default=USER_DEFINED,
     )
-    include_available_units = models.BooleanField(
-        'Отображать данные по дочерним организациям', default=False
-    )
+    include_available_units = models.BooleanField('Отображать данные по дочерним организациям', default=False)
 
     class Meta:
         verbose_name = 'Отчет'
@@ -78,26 +76,23 @@ class ReportTemplate(CascadeDeleteMixin, BaseModel):
                 query = query.exclude(pk=self.pk)
 
             if query.exists():
-                errors['title'].append(
-                    'Шаблон отчета с подобным именем уже существует.'
-                )
+                errors['title'].append('Шаблон отчета с подобным именем уже существует.')
         # ---------------------------------------------------------------------
-        super(ReportTemplate, self).simple_clean(errors)
+        super().simple_clean(errors)
 
     @cached_property
     def data_source(self):
         if self.data_source_name not in registry:
             raise ValidationError(
-                'В шаблоне отчета указан несуществующий источник данных ({}).'
-                .format(self.data_source_name)
+                'В шаблоне отчета указан несуществующий источник данных ({}).'.format(self.data_source_name)
             )
-        data_source = registry.get(
-            self.data_source_name
-        ).get_data_source_descriptor()
+        data_source = registry.get(self.data_source_name).get_data_source_descriptor()
         return data_source
 
     def __str__(self):
         return 'Шаблон отчета: {}'.format(self.title)
+
+
 # -----------------------------------------------------------------------------
 
 
@@ -129,63 +124,38 @@ class ReportColumn(BaseModel):
     title = models.CharField(
         'Отображаемое имя',
         max_length=300,
-        null=True, blank=True,
-    )
-    by_value = models.PositiveSmallIntegerField(
-        'Промежуточный итог',
-        choices=constants.BY_VALUE_CHOICES,
+        null=True,
         blank=True,
-        null=True
     )
-    total = models.PositiveSmallIntegerField(
-        'Итог',
-        choices=constants.TOTAL_CHOICES,
-        blank=True,
-        null=True
+    by_value = models.PositiveSmallIntegerField(
+        'Промежуточный итог', choices=constants.BY_VALUE_CHOICES, blank=True, null=True
     )
+    total = models.PositiveSmallIntegerField('Итог', choices=constants.TOTAL_CHOICES, blank=True, null=True)
 
     cascade_delete_for = (report_template,)
 
     class Meta:
         verbose_name = 'Столбец отчета'
         verbose_name_plural = 'Столбцы отчетов'
-        unique_together = (
-            ('report_template', 'name'),
-        )
-        ordering = (
-            'index',
-        )
+        unique_together = (('report_template', 'name'),)
+        ordering = ('index',)
 
     def _clean_aggregator_type(self, errors):
         """Проверяет на соответствие типов итогов."""
-        if not (
-            (self.by_value == self.total) or
-            (any(not bool(item) for item in (self.by_value, self.total)))
-        ):
-            errors['by_value'].append(
-                'Тип для "Промежуточный итог" и "Итог" должен совпадать.'
-            )
+        if not ((self.by_value == self.total) or (any(not bool(item) for item in (self.by_value, self.total)))):
+            errors['by_value'].append('Тип для "Промежуточный итог" и "Итог" должен совпадать.')
 
     def _clean_aggregator_data_type(self, errors):
         """Проверяет тип данных для итогов."""
         # Определяем тип данных в колонке.
-        data_source_descriptor = registry.get(
-            self.report_template.data_source_name
-        ).get_data_source_descriptor()
-        column_descriptor = data_source_descriptor.get_column_descriptor(
-            self.name
-        )
+        data_source_descriptor = registry.get(self.report_template.data_source_name).get_data_source_descriptor()
+        column_descriptor = data_source_descriptor.get_column_descriptor(self.name)
         is_num_data_type = column_descriptor.data_type == constants.CT_NUMBER
         # Определяем тип Промежуточного итога.
-        is_sum_by_value = (
-            self.by_value and self.by_value == constants.BY_VALUE_SUM
-        )
+        is_sum_by_value = self.by_value and self.by_value == constants.BY_VALUE_SUM
         # Определяем тип Итога.
         is_total_sum = self.total and self.total == constants.TOTAL_SUM
-        aggregator_info = (
-            ('by_value', is_sum_by_value),
-            ('total', is_total_sum)
-        )
+        aggregator_info = (('by_value', is_sum_by_value), ('total', is_total_sum))
         for aggregator_type, is_sum in aggregator_info:
             if is_sum and not is_num_data_type:
                 errors[aggregator_type].append(
@@ -199,10 +169,12 @@ class ReportColumn(BaseModel):
         self._clean_aggregator_type(errors)
         self._clean_aggregator_data_type(errors)
 
-        super(ReportColumn, self).simple_clean(errors)
+        super().simple_clean(errors)
 
     def __str__(self):
         return self.title
+
+
 # -----------------------------------------------------------------------------
 
 
@@ -239,7 +211,8 @@ class ReportFilterGroup(MPTTModel, BaseModel):
     )
     parent = TreeForeignKey(
         'self',
-        blank=True, null=True,
+        blank=True,
+        null=True,
         verbose_name='Родительская группа',
         related_name='nested_groups',
         on_delete=models.CASCADE,
@@ -278,10 +251,10 @@ class ReportFilterGroup(MPTTModel, BaseModel):
         report_filter = instance
 
         if (
-            not report_filter.pk or
-            not report_filter.group_id or
-            not report_filter.column_id or
-            not report_filter.group.report_template_id
+            not report_filter.pk
+            or not report_filter.group_id
+            or not report_filter.column_id
+            or not report_filter.group.report_template_id
         ):
             return
 
@@ -293,43 +266,42 @@ class ReportFilterGroup(MPTTModel, BaseModel):
         if column.report_template_id != group.report_template_id:
             errors['column'].append(
                 'Шаблон, к которому относится столбец фильтра "{}" '
-                'отличается от шаблона, к которому относится группа фильтров.'
-                .format(column.name)
+                'отличается от шаблона, к которому относится группа фильтров.'.format(column.name)
             )
         # ---------------------------------------------------------------------
 
     def simple_clean(self, errors):
-        super(ReportFilterGroup, self).simple_clean(errors)
+        super().simple_clean(errors)
         # ---------------------------------------------------------------------
         # Все столбцы в фильтрах группы должны быть в том же шаблоне, что и
         # данная группа.
 
         if (
-            self.pk and
-            self.report_template_id and
-            self.filters.exclude(
+            self.pk
+            and self.report_template_id
+            and self.filters.exclude(
                 column__report_template=self.report_template_id,
             ).exists()
         ):
-            errors['report_template'].append(
-                'В данной группе есть фильтры, ссылающиеся на столбцы из '
-                'другого шаблона.'
-            )
+            errors['report_template'].append('В данной группе есть фильтры, ссылающиеся на столбцы из другого шаблона.')
         # ---------------------------------------------------------------------
         # Шаблоны данной группы и родительской должны совпадать.
 
         if (
-            self.pk and self.report_template_id and
-            self.parent and self.parent.report_template_id and
-            self.report_template_id != self.parent.report_template_id
+            self.pk
+            and self.report_template_id
+            and self.parent
+            and self.parent.report_template_id
+            and self.report_template_id != self.parent.report_template_id
         ):
             errors['parent'].append(
-                'Шаблон данной группы фильтров ("{}") отличается от шаблона '
-                'родительской группы ("{}").'.format(
+                'Шаблон данной группы фильтров ("{}") отличается от шаблона родительской группы ("{}").'.format(
                     self.report_template.title,
                     self.parent.report_template.title,
                 )
             )
+
+
 # -----------------------------------------------------------------------------
 
 
@@ -365,13 +337,16 @@ class ReportFilter(BaseModel):
     values = ArrayField(
         models.TextField(
             'Значение',
-            blank=True, null=True,
+            blank=True,
+            null=True,
         ),
-        blank=True, null=True,
+        blank=True,
+        null=True,
     )
     comment = models.TextField(
         'Описание фильтра',
-        blank=True, null=True,
+        blank=True,
+        null=True,
     )
 
     cascade_delete_for = (group, column)
@@ -382,76 +357,52 @@ class ReportFilter(BaseModel):
         "<значение>", <без учета|с учетом> регистра`
         :return:
         """
-        template = (
-            'Поле "{col}"{invert__op:10}{operator} '
-            '"{value}", {case} регистра'
-        )
+        template = 'Поле "{col}"{invert__op:10}{operator} "{value}", {case} регистра'
         invert__op = ' не ' if self.exclude else ' '
         case = 'с учетом' if self.case_sensitive else 'без учета'
-        return template.format(col=self.column, invert__op=invert__op,
-                               operator=self.get_operator_display().lower(),
-                               value=', '.join(self.values), case=case)
+        return template.format(
+            col=self.column,
+            invert__op=invert__op,
+            operator=self.get_operator_display().lower(),
+            value=', '.join(self.values),
+            case=case,
+        )
 
     class Meta:
         verbose_name = 'Фильтр'
         verbose_name_plural = 'Фильтры'
-        unique_together = (
-            ('column', 'index'),
-        )
-        ordering = (
-            'index',
-        )
+        unique_together = (('column', 'index'),)
+        ordering = ('index',)
 
     def simple_clean(self, errors):
-        super(ReportFilter, self).simple_clean(errors)
+        super().simple_clean(errors)
         # ---------------------------------------------------------------------
         # Значение должно быть указано для всех операторов, кроме IS_NULL.
 
         if self.operator == constants.IS_NULL:
             self.values = None
 
-        elif (
-            self.operator == constants.BETWEEN and
-            (
-                not self.values or
-                len(self.values) != 2
-            )
-        ):
+        elif self.operator == constants.BETWEEN and (not self.values or len(self.values) != 2):
             errors['values'].append(
-                'Для оператора "{}" должно быть указано два значения.'
-                .format(self.get_operator_display())
+                'Для оператора "{}" должно быть указано два значения.'.format(self.get_operator_display())
             )
 
-        elif (
-            self.operator not in (constants.IN, constants.BETWEEN,) and
-            (
-                not self.values or
-                len(self.values) > 1
-            )
-        ):
-            errors['values'].append(
-                'Должно быть указано только одно значение.'
-            )
+        elif self.operator not in (
+            constants.IN,
+            constants.BETWEEN,
+        ) and (not self.values or len(self.values) > 1):
+            errors['values'].append('Должно быть указано только одно значение.')
 
         elif not self.values:
             errors['values'].append('Не указано значение для сравнения.')
         # ---------------------------------------------------------------------
 
-        if (
-            self.group and self.column and
-            self.group.report_template_id != self.column.report_template_id
-        ):
-            errors['column'].append(
-                'Группа и колонка принадлежат разным шаблонам.'
-            )
+        if self.group and self.column and self.group.report_template_id != self.column.report_template_id:
+            errors['column'].append('Группа и колонка принадлежат разным шаблонам.')
         # ---------------------------------------------------------------------
 
-        data_source_descriptor = registry.get(
-            self.group.report_template.data_source_name
-        ).get_data_source_descriptor()
-        column_descriptor = data_source_descriptor.get_column_descriptor(
-            self.column.name
-        )
+        data_source_descriptor = registry.get(self.group.report_template.data_source_name).get_data_source_descriptor()
+        column_descriptor = data_source_descriptor.get_column_descriptor(self.column.name)
         data_type = column_descriptor.data_type
         valid_operators = constants.VALID_OPERATORS[data_type]
         if self.operator and self.operator not in valid_operators:
@@ -461,6 +412,8 @@ class ReportFilter(BaseModel):
                     column_descriptor.get_full_title(),
                 )
             )
+
+
 # -----------------------------------------------------------------------------
 
 
@@ -487,11 +440,10 @@ class ReportSorting(BaseModel):
         ordering = ('index',)
 
     def __str__(self):
-        return '{col} ({direction})'.format(
-            col=self.column, direction=self.get_direction_display().lower()
-        )
+        return '{col} ({direction})'.format(col=self.column, direction=self.get_direction_display().lower())
+
+
 # -----------------------------------------------------------------------------
 
 
-post_clean.connect(ReportFilterGroup.check_filter, ReportFilter,
-                   dispatch_uid='ReportFilterGroup.check_filter')
+post_clean.connect(ReportFilterGroup.check_filter, ReportFilter, dispatch_uid='ReportFilterGroup.check_filter')

educommon/report/constructor/utils.py

@@ -72,6 +72,7 @@ def get_field(model, name):
             from educommon.report.constructor.base import (
                 ExtraField,
             )
+
             field = params['field']
             field.model = model if isclass(model) else model.__class__
             field.name = name
@@ -116,10 +117,7 @@ def get_nested_field(model, field_name):
         try:
             return get_nested_field(attr_value, nested_attr)
         except FieldDoesNotExist:
-            raise FieldDoesNotExist(
-                "{} has not field named '{}'"
-                .format(model.__name__, field_name)
-            )
+            raise FieldDoesNotExist("{} has not field named '{}'".format(model.__name__, field_name))
     else:
         return attr_value
 
@@ -174,10 +172,7 @@ def get_field_value_by_display(field, display_value):
         if display.lower() == display_value.lower():
             return value
 
-    raise ValueError(
-        'Значения "{}" нет среди вариантов выбора.'
-        .format(display_value)
-    )
+    raise ValueError('Значения "{}" нет среди вариантов выбора.'.format(display_value))
 
 
 def get_data_type(field):

educommon/report/constructor/validators.py

@@ -13,6 +13,4 @@ def validate_data_source_name(value):
     Источник данных должен быть зарегистрирован в реестре.
     """
     if value not in registry:
-        raise ValidationError(
-            'Источник данных "{}" не существует.'.format(value)
-        )
+        raise ValidationError('Источник данных "{}" не существует.'.format(value))

educommon/report/reporter.py

@@ -1,4 +1,5 @@
 "Модуль с построителями отчетов"
+
 import os
 import sys
 import uuid
@@ -42,8 +43,8 @@ def get_url(filename):
 
 
 class SimpleReporter:
-    """
-    Объект занимающийся комплексным построением отчета на основе simple_report:
+    """Объект занимающийся комплексным построением отчета на основе simple_report.
+
     1) инстанцированием и загрузкой данных провайдера
     2) инстанцированием билдера
     3) построением отчета
@@ -55,6 +56,7 @@ class SimpleReporter:
     reporter = MySimpleReporter(provider_params, builder_params)
     report_url = reporter.make_report()
     """
+
     # доступные форматы
     _available_extensions = ['.xls', '.xlsx', '.docx']
 
@@ -96,8 +98,7 @@ class SimpleReporter:
         :type default_base_name: str
         :returns: str - полный путь к шаблону
         """
-        if (self.template_file_path is not None and
-                os.path.isabs(self.template_file_path)):
+        if self.template_file_path is not None and os.path.isabs(self.template_file_path):
             return self.template_file_path
 
         report_file_path = sys.modules[self.__module__].__file__
@@ -105,27 +106,23 @@ class SimpleReporter:
         report_dir = os.path.dirname(report_file_path)
 
         rel_sub_path = ''
-        if (self.template_file_path is not None and
-                self.template_file_path.startswith('./')):
-            rel_sub_path = os.path.relpath(
-                os.path.dirname(self.template_file_path))
+        if self.template_file_path is not None and self.template_file_path.startswith('./'):
+            rel_sub_path = os.path.relpath(os.path.dirname(self.template_file_path))
 
         if self.template_file_path is None:
             base_name, _ = os.path.splitext(os.path.basename(report_dir))
         else:
-            base_name, _ = os.path.splitext(
-                os.path.basename(self.template_file_path))
+            base_name, _ = os.path.splitext(os.path.basename(self.template_file_path))
             if not base_name:
                 base_name = default_base_name
 
-        auto_report_name = '{0}{1}{2}'.format(
-            base_name, os.path.extsep, self.extension.strip('.'))
-        auto_report_path = os.path.join(
-            report_dir, rel_sub_path, auto_report_name)
+        auto_report_name = '{0}{1}{2}'.format(base_name, os.path.extsep, self.extension.strip('.'))
+        auto_report_path = os.path.join(report_dir, rel_sub_path, auto_report_name)
+
+        assert os.path.isfile(auto_report_path), "Report template '{0}' not found at {1}".format(
+            auto_report_name, auto_report_path
+        )
 
-        assert os.path.isfile(auto_report_path), (
-            "Report template '{0}' not found at {1}".format(
-                auto_report_name, auto_report_path))
         return auto_report_path
 
     def set_up_report(self):
@@ -133,8 +130,7 @@ class SimpleReporter:
         template_path = self.get_template()
 
         if self.extension == '.xls':
-            report = SpreadsheetReport(
-                template_path, wrapper=DocumentXLS, type=FileConverter.XLS)
+            report = SpreadsheetReport(template_path, wrapper=DocumentXLS, type=FileConverter.XLS)
         elif self.extension == '.xlsx':
             report = SpreadsheetReport(template_path)
         elif self.extension == '.docx':
@@ -145,8 +141,8 @@ class SimpleReporter:
         return report
 
     def set_file_and_url(self):
-        """
-        Возвращает кортеж из абс. пути отчёта и url для скачивания.
+        """Возвращает кортеж из абс. пути отчёта и url для скачивания.
+
         Не требует переопределения.
         """
         title = self.builder_params.get('title')
@@ -158,8 +154,7 @@ class SimpleReporter:
         return (out_file_path, out_file_url)
 
     def create_provider(self):
-        """
-        Кастомный метод для создания экземпляра класса провайдера.
+        """Кастомный метод для создания экземпляра класса провайдера.
 
         Используется в случае необходимости явного вызова конструктора
         провайдера, например, для композитного провайдера.
@@ -167,9 +162,7 @@ class SimpleReporter:
         """
 
     def init_provider(self, data_provider):
-        """
-        Инициализирует дата-провайдер с параметрами self.provider_params
-        """
+        """Инициализирует дата-провайдер с параметрами self.provider_params."""
         data_provider.init(**self.provider_params)
 
     def create_builder(self, data_provider, report):
@@ -179,16 +172,10 @@ class SimpleReporter:
 
         :returns: билдер с параметрами self.builder_params
         """
-        return self.builder_class(
-            data_provider,
-            adapter=self.adapter_class,
-            report=report,
-            params=self.builder_params
-        )
+        return self.builder_class(data_provider, adapter=self.adapter_class, report=report, params=self.builder_params)
 
     def get_data_provider(self):
-        """
-        Создание провайдера и взятие данных.
+        """Создание провайдера и взятие данных.
 
         :return: Provider с уже сформированным результатом
         """
@@ -205,8 +192,7 @@ class SimpleReporter:
         return data_provider
 
     def _get_report_builder(self, data_provider, report):
-        """
-        Создание билдера и построение отчета.
+        """Создание билдера и построение отчета.
 
         :param data_provider: Provider с уже сформированным результатом.
         :param report: Отчет форматов .xls, .xlsx или .docx
@@ -217,8 +203,7 @@ class SimpleReporter:
         return report_builder.build()
 
     def create_dir(self, out_file):
-        """
-        Создание директории для сохранения файла
+        """Создание директории для сохранения файла.
 
         :param out_file:  str, путь к файлу.
         :raise: OsError
@@ -232,8 +217,7 @@ class SimpleReporter:
             os.makedirs(cat)
 
     def build_report(self, report, out_file, params):
-        """
-        Построение отчета.
+        """Построение отчета.
 
         :param report: Отчет форматов .xls, .xlsx или .docx
         :param out_file: str, путь к файлу.
@@ -247,9 +231,7 @@ class SimpleReporter:
             report.build(out_file)
 
     def make_report(self):
-        """
-        Основной метод, выполняющий построение отчета
-        """
+        """Основной метод, выполняющий построение отчета."""
         # получение абс. пути отчёта
         out_file, out_url = self.set_file_and_url()
         # настройка формата отчета