edu-rdm-integration 2.2.1__tar.gz → 3.0.0__tar.gz

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/CHANGELOG.md

@@ -28,6 +28,16 @@
 
 ### Удалено
 
+## 3.0.0 - 2024-04-02
+Расширены возможности кастомизации поведения метода `BaseExportDataFunctionHelper.prepare_record`.
+
+### Добавлено
+
+- [EDUCLLG-8325](https://jira.bars.group/browse/EDUCLLG-8325)
+  MAJOR Добавлена возможность отдельно указывать, как формировать строковое
+    представление полей в зависимости от их типа и обязательности. **Требуется добавить
+    параметр `required_fields` в метод `prepare_record` helper-а функции**.
+
 ## [2.2.1] - 2024-03-28
  Исправление наследования Meta в моделях EduRdmCollectDataCommandProgress и EduRdmExportDataCommandProgress
 

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edu-rdm-integration
-Version: 2.2.1
+Version: 3.0.0
 Summary: Интеграция с Региональной витриной данных
 Home-page: 
 Download-URL: 
@@ -293,6 +293,16 @@ Requires-Dist: uploader-client<1,>=0.2.1
 
 ### Удалено
 
+## 3.0.0 - 2024-04-02
+Расширены возможности кастомизации поведения метода `BaseExportDataFunctionHelper.prepare_record`.
+
+### Добавлено
+
+- [EDUCLLG-8325](https://jira.bars.group/browse/EDUCLLG-8325)
+  MAJOR Добавлена возможность отдельно указывать, как формировать строковое
+    представление полей в зависимости от их типа и обязательности. **Требуется добавить
+    параметр `required_fields` в метод `prepare_record` helper-а функции**.
+
 ## [2.2.1] - 2024-03-28
  Исправление наследования Meta в моделях EduRdmCollectDataCommandProgress и EduRdmExportDataCommandProgress
 

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/setup.py

@@ -17,7 +17,7 @@ from setuptools import (
 
 PROJECT = 'edu_rdm_integration'
 
-VERSION = '2.2.1'
+VERSION = '3.0.0'
 
 current_dir_path = Path().resolve()
 

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/src/edu_rdm_integration/export_data/base/functions.py

@@ -155,16 +155,18 @@ class BaseExportDataFunction(
         Формирование списка строковых значений полей.
         """
         ordered_fields = self.first_entity.entity.get_ordered_fields()
-        primary_key_fields = self.first_entity.entity.get_primary_key_fields()
-        foreign_key_fields = self.first_entity.entity.get_foreign_key_fields()
-        hashable_fields = self.first_entity.entity.get_hashable_fields()
-        ignore_prefix_fields = self.first_entity.entity.get_ignore_prefix_key_fields()
+        primary_key_fields = set(self.first_entity.entity.get_primary_key_fields())
+        foreign_key_fields = set(self.first_entity.entity.get_foreign_key_fields())
+        required_fields = set(self.first_entity.entity.get_required_fields())
+        hashable_fields = set(self.first_entity.entity.get_hashable_fields())
+        ignore_prefix_fields = set(self.first_entity.entity.get_ignore_prefix_key_fields())
 
         field_values = self.helper.prepare_record(
             entity_instance=entity_instance,
             ordered_fields=ordered_fields,
             primary_key_fields=primary_key_fields,
             foreign_key_fields=foreign_key_fields,
+            required_fields=required_fields,
             hashable_fields=hashable_fields,
             ignore_prefix_fields=ignore_prefix_fields,
         )

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/src/edu_rdm_integration/export_data/base/helpers.py

@@ -2,11 +2,11 @@ from datetime import (
     date,
     datetime,
 )
-from itertools import (
-    chain,
-)
 from typing import (
+    Any,
     List,
+    Set,
+    Tuple,
     Type,
 )
 
@@ -55,36 +55,58 @@ class BaseExportDataFunctionHelper(WebEduFunctionHelper):
 
     cryptographer = HashData(hash_algorithm=HASH_ALGORITHM)
 
+    @classmethod
+    def _prepare_str_field(cls, field_value: str, *, required: bool) -> str:
+        # Очистка строковых полей от управляющих символов
+        return str_without_control_chars(field_value)
+
+    @classmethod
+    def _prepare_datetime_field(cls, field_value: datetime, *, required: bool) -> str:
+        # Дату/время передаём в формате: YYYY-MM-DD hh:mm:ss
+        return field_value.strftime(EXPORT_DATETIME_FORMAT)
+
+    @classmethod
+    def _prepare_date_field(cls, field_value: date, *, required: bool) -> str:
+        return field_value.strftime(DATE_FORMAT)
+
+    @classmethod
+    def _prepare_common_field(cls, field_value: Any, *, required: bool) -> str:
+        return str(field_value if field_value is not None else '')
+
+    @classmethod
+    def _surround_with_quotes(cls, field_value: str, *, required: bool) -> str:
+        return f'"{field_value}"'
+
     @classmethod
     def prepare_record(
         cls,
         entity_instance,
-        ordered_fields,
-        primary_key_fields,
-        foreign_key_fields,
-        hashable_fields,
-        ignore_prefix_fields,
+        ordered_fields: Tuple[str, ...],
+        primary_key_fields: Set[str],
+        foreign_key_fields: Set[str],
+        required_fields: Set[str],
+        hashable_fields: Set[str],
+        ignore_prefix_fields: Set[str],
     ) -> List[str]:
         """
         Формирование списка строковых значений полей.
         """
         field_values = []
-        key_fields = set(chain(primary_key_fields, foreign_key_fields))
-        add_prefix_fields = key_fields - set(ignore_prefix_fields)
+        key_fields = primary_key_fields.union(foreign_key_fields)
+        add_prefix_fields = key_fields.difference(ignore_prefix_fields)
 
         for field in ordered_fields:
+            required = field in required_fields
             field_value = getattr(entity_instance, field)
 
             if isinstance(field_value, str):
-                # Очистка строковых полей от управляющих символов
-                field_value = str_without_control_chars(field_value)
+                field_value = cls._prepare_str_field(field_value, required=required)
             elif isinstance(field_value, datetime):
-                # Дату/время передаём в формате: YYYY-MM-DD hh:mm:ss
-                field_value = field_value.strftime(EXPORT_DATETIME_FORMAT)
+                field_value = cls._prepare_datetime_field(field_value, required=required)
             elif isinstance(field_value, date):
-                field_value = field_value.strftime(DATE_FORMAT)
+                field_value = cls._prepare_date_field(field_value, required=required)
             else:
-                field_value = str(field_value if field_value is not None else '')
+                field_value = cls._prepare_common_field(field_value, required=required)
 
             if field_value and field in add_prefix_fields:
                 field_value = f'{settings.RDM_EXPORT_ENTITY_ID_PREFIX}-{field_value}'
@@ -95,9 +117,11 @@ class BaseExportDataFunctionHelper(WebEduFunctionHelper):
             # Экранирование двойных кавычек
             field_value = field_value.replace('"', '""')
 
+            field_value = cls._surround_with_quotes(field_value, required=required)
+
             field_values.append(field_value)
 
-        return [f'"{v}"' for v in field_values]
+        return field_values
 
     def _prepare_cache_class(self) -> Type[BaseExportDataFunctionCacheStorage]:
         """

{edu-rdm-integration-2.2.1 → edu-rdm-integration-3.0.0}/src/edu_rdm_integration.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edu-rdm-integration
-Version: 2.2.1
+Version: 3.0.0
 Summary: Интеграция с Региональной витриной данных
 Home-page: 
 Download-URL: 
@@ -293,6 +293,16 @@ Requires-Dist: uploader-client<1,>=0.2.1
 
 ### Удалено
 
+## 3.0.0 - 2024-04-02
+Расширены возможности кастомизации поведения метода `BaseExportDataFunctionHelper.prepare_record`.
+
+### Добавлено
+
+- [EDUCLLG-8325](https://jira.bars.group/browse/EDUCLLG-8325)
+  MAJOR Добавлена возможность отдельно указывать, как формировать строковое
+    представление полей в зависимости от их типа и обязательности. **Требуется добавить
+    параметр `required_fields` в метод `prepare_record` helper-а функции**.
+
 ## [2.2.1] - 2024-03-28
  Исправление наследования Meta в моделях EduRdmCollectDataCommandProgress и EduRdmExportDataCommandProgress