edu-rdm-integration 0.6.6__py3-none-any.whl → 0.6.7__py3-none-any.whl

edu_rdm_integration/entities.py

@@ -8,15 +8,27 @@ from typing import (
     Tuple,
 )
 
+from edu_rdm_integration.enum_register.mixins import (
+    EntityEnumRegisterMixin,
+)
+from edu_rdm_integration.models import (
+    RegionalDataMartModelEnum,
+)
 from educommon.integration_entities.entities import (
     BaseEntity,
 )
 
 
 @dataclass
-class AddressEntity(BaseEntity):
+class AddressEntity(EntityEnumRegisterMixin, BaseEntity):
     """Сущность РВД 'Адреса'."""
 
+    # Параметры регистрации в модель-перечисление РВД
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+    title = 'Адреса'
+    main_model_enum = RegionalDataMartModelEnum.ADDRESS
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
     # Имена полей объявляются как константы, чтобы можно было выводить списки полей
     ID = 'id'
     USE_ADDRESS = 'use_address'
@@ -88,9 +100,16 @@ class AddressEntity(BaseEntity):
 
 
 @dataclass
-class AddressOrganisationEntity(BaseEntity):
+class AddressOrganisationEntity(EntityEnumRegisterMixin, BaseEntity):
     """Сущность РВД 'Адреса'."""
 
+    # Параметры регистрации в модель-перечисление РВД
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+    title = 'Адреса организаций'
+    main_model_enum = RegionalDataMartModelEnum.ADDRESS_ORGANISATION
+    additional_model_enums = (RegionalDataMartModelEnum.ORGANISATION, )
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
     # Имена полей объявляются как константы, чтобы можно было выводить списки полей
     ADDRESS_ID = 'address_id'
     ORGANISATION_ID = 'organisation_id'
@@ -132,9 +151,15 @@ class AddressOrganisationEntity(BaseEntity):
 
 
 @dataclass
-class TelecomEntity(BaseEntity):
+class TelecomEntity(EntityEnumRegisterMixin, BaseEntity):
     """Сущность РВД "Контактные данные"."""
 
+    # Параметры регистрации в модель-перечисление РВД
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+    title = 'Контактные данные'
+    main_model_enum = RegionalDataMartModelEnum.TELECOM
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
     # Имена полей объявляются как константы, чтобы можно было выводить списки полей
     ID = 'id'
     TYPE_CONTACT = 'type_contact'
@@ -194,11 +219,17 @@ class TelecomEntity(BaseEntity):
 
 
 @dataclass
-class OrganisationsEntity(BaseEntity):
+class OrganisationsEntity(EntityEnumRegisterMixin, BaseEntity):
     """
     Сущность РВД "Организации".
     """
 
+    # Параметры регистрации в модель-перечисление РВД
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+    title = 'Организации'
+    main_model_enum = RegionalDataMartModelEnum.ORGANISATION
+    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
     ID = 'id'
     ROSOBR_ID = 'rosobr_id'
     OGRN = 'ogrn'
@@ -209,7 +240,7 @@ class OrganisationsEntity(BaseEntity):
     OKPF = 'okpf'
     OKFS = 'okfs'
     OKOGU = 'okogu'
-    OKATO  = 'okato'
+    OKATO = 'okato'
     OKTMO = 'oktmo'
     NAME = 'name'
     PARTOF_ID = 'partof_id'

edu_rdm_integration/enum_register/mixins.py

@@ -0,0 +1,87 @@
+from typing import (
+    Any,
+    Dict,
+    Tuple,
+)
+
+from django.db import (
+    models,
+)
+from django.utils.decorators import (
+    classproperty,
+)
+
+from edu_rdm_integration.models import (
+    RegionalDataMartEntityEnum,
+    RegionalDataMartModelEnum,
+)
+from edu_rdm_integration.utils import (
+    camel_to_underscore,
+)
+from m3_db_utils.mixins import (
+    BaseEnumRegisterMixin,
+)
+from m3_db_utils.models import (
+    ModelEnumValue,
+)
+
+
+class EntityEnumRegisterMixin(BaseEnumRegisterMixin):
+    """Миксин, для регистрации сущности в RegionalDataMartEntityEnum."""
+
+    enum = RegionalDataMartEntityEnum
+    """Модель-перечисление в которую регистрируется сущность."""
+
+    main_model_enum: ModelEnumValue
+    """Значение RegionalDataMartModelEnum, 
+    основной модели РВД для формирования сущности."""
+
+    additional_model_enums: Tuple[ModelEnumValue] = ()
+    """Перечень дополнительных значений RegionalDataMartModelEnum, 
+    которые участвуют в формировании записей сущностей"""
+
+    title: str
+    """Расшифровка сущности модели-перечисления"""
+
+    @classproperty
+    def key(cls) -> str:
+        return camel_to_underscore(cls.__name__.rsplit('Entity', 1)[0], upper=True)
+
+    @classmethod
+    def get_register_params(cls) -> Dict[str, Any]:
+        register_params = super().get_register_params()
+        register_params['main_model_enum'] = cls.main_model_enum
+        register_params['entity'] = cls
+        register_params['additional_model_enums'] = cls.additional_model_enums
+
+        return register_params
+
+
+class ModelEnumRegisterMixin(BaseEnumRegisterMixin):
+    """Миксин, для регистрации модели в RegionalDataMartModelEnum."""
+
+    enum = RegionalDataMartModelEnum
+    """Модель-перечисление в которую регистрируется модель."""
+
+    creating_trigger_models: Tuple[models.Model] = ()
+    """Перечень моделей по которым генерируются логи."""
+
+    loggable_models: Tuple[models.Model] = ()
+    """Перечень моделей по которым собираются логи."""
+
+    @classproperty
+    def key(cls) -> str:
+        return camel_to_underscore(cls.__name__).upper()
+
+    @classproperty
+    def title(cls):
+        return cls._meta.verbose_name
+
+    @classmethod
+    def get_register_params(cls) -> Dict[str, Any]:
+        register_params = super().get_register_params()
+        register_params['model'] = cls
+        register_params['creating_trigger_models'] = cls.creating_trigger_models
+        register_params['loggable_models'] = cls.loggable_models
+
+        return register_params

edu_rdm_integration/enum_register/register.py

@@ -0,0 +1,82 @@
+import inspect
+import sys
+from importlib import (
+    import_module,
+)
+from operator import (
+    attrgetter,
+)
+from typing import (
+    Iterable,
+    Type,
+)
+
+from django.apps import (
+    apps,
+)
+from django.db import (
+    models,
+)
+
+from edu_rdm_integration.enum_register.mixins import (
+    EntityEnumRegisterMixin,
+    ModelEnumRegisterMixin,
+)
+from edu_rdm_integration.models import (
+    BaseEntityModel,
+)
+from educommon.integration_entities.entities import (
+    BaseEntity,
+)
+from m3_db_utils.mixins import (
+    BaseEnumRegisterMixin,
+)
+
+
+def register_classes(classes: Iterable[Type[BaseEnumRegisterMixin]]) -> None:
+    """Вызывает метод регистрации в модель-перечисление
+    у переданных классов.
+
+    Args:
+        classes: Классы, поддерживающие интерфейс регистрации.
+    """
+    classes = sorted(classes, key=attrgetter('order_number'))
+
+    for enum_class in classes:
+        enum_class.register()
+
+
+def is_register_model(model: models.Model) -> bool:
+    """Проверяет, является ли класс регистрируемой моделью."""
+    return issubclass(model, ModelEnumRegisterMixin)
+
+
+def is_register_entity(class_) -> bool:
+    """Проверяет, является ли класс регистрируемой сущностью."""
+    return (
+        inspect.isclass(class_) and
+        issubclass(class_, BaseEntity) and
+        issubclass(class_, EntityEnumRegisterMixin)
+    )
+
+
+def register_models() -> None:
+    """Регистрирует модели в RegionalDataMartModelEnum."""
+    register_classes([
+        m for m in apps.get_models() if is_register_model(m)
+    ])
+
+
+def register_entities(import_path: str) -> None:
+    """Находит регистрируемые сущности в модуле по переданному пути и
+    регистрирует в RegionalDataMartEntityEnum.
+
+    Args:
+        import_path: Путь до пакета, хранящего классы сущностей;
+    """
+    import_module(import_path)
+    entities_module = sys.modules[import_path]
+
+    register_classes([
+        c[1] for c in inspect.getmembers(entities_module, is_register_entity)
+    ])

edu_rdm_integration/utils.py

@@ -165,3 +165,42 @@ def split_interval_by_delta(start_date: datetime, end_date: datetime, days_delta
     intervals = [*zip(iter_interval, iter_interval)]
 
     return intervals
+
+
+def camel_to_underscore(name: str, upper=False) -> str:
+    """Переводит строку из верблюжьего в змеиный регистр.
+    По умолчанию строка приводится к нижнему регистру.
+    Несколько заглавных букв не будут разъединены, кроме последней.
+
+    Args:
+        name: форматируемая строка;
+        upper: флаг перевода в верхний регистр;
+
+    Returns:
+        Строка, приведенная к змеиному регистру.
+
+    >>> camel_to_underscore('ОдинДваТри')
+    'один_два_три'
+    >>> camel_to_underscore('Один_два_три')
+    'один_два_три'
+    >>> camel_to_underscore('Один_Два_Три')
+    'один_два_три'
+    >>> camel_to_underscore('__ОдинДваТри__')
+    '__один_два_три__'
+    >>> camel_to_underscore('__ОдинДВАТри__')
+    '__один_два_три__'
+    """
+    output = []
+    for i, c in enumerate(name):
+        if i > 0:
+            pc = name[i - 1]
+            if c.isupper() and not pc.isupper() and pc != '_':
+                output.append('_')
+            elif i > 3 and not c.isupper():
+                previous = name[i - 3:i]
+                if previous.isalpha() and previous.isupper():
+                    output.insert(len(output) - 1, '_')
+
+        output.append(c.upper() if upper else c.lower())
+
+    return ''.join(output)

{edu_rdm_integration-0.6.6.dist-info → edu_rdm_integration-0.6.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edu-rdm-integration
-Version: 0.6.6
+Version: 0.6.7
 Summary: Интеграция с Региональной витриной данных
 Home-page: 
 Download-URL: 
@@ -30,7 +30,7 @@ Requires-Dist: transliterate <2
 Requires-Dist: Django <2.3,>=1.11
 Requires-Dist: educommon <4,>=3.0.0
 Requires-Dist: function-tools <1,>=0.5.0
-Requires-Dist: m3-db-utils <1,>=0.3.6
+Requires-Dist: m3-db-utils <1,>=0.3.8
 Requires-Dist: uploader-client <1,>=0.1.12
 
 # Проект "Интеграция с Региональной витриной данных (РВД)"
@@ -290,6 +290,18 @@ Requires-Dist: uploader-client <1,>=0.1.12
 ### Удалено
 
 
+## [0.6.7] - 2023-11-01
+
+Добавлен миксин EntityEnumRegisterMixin для регистрации сущностей в RegionalDataMartEntityEnum. 
+Миксин ModelEnumRegisterMixin для регистрации моделей в RegionalDataMartModelEnum.
+Добавлены методы для запуска регистрации моделей и сущностей.
+
+### Добавлено
+
+- [EDUCLLG-7632](https://jira.bars.group/browse/EDUCLLG-7632)
+  PATCH - Добавлен функционал регистрации моделей и сущностей в моделях-перечислениях.
+
+
 ## [0.6.6] - 2023-10-16
 
 Добавлен базовый класс для тестирования Функций сбора, добавлена явная зависимость Django.

{edu_rdm_integration-0.6.6.dist-info → edu_rdm_integration-0.6.7.dist-info}/RECORD

@@ -2,13 +2,13 @@ edu_rdm_integration/__init__.py,sha256=fVCvQ7QGI_iCyAeE8dMapyY8gOM617ye5GQqAVGPl
 edu_rdm_integration/app_settings.py,sha256=kideEO9SvYU8RXPB-8hTVosL4bAspPHNHtyz-R0F7v4,1822
 edu_rdm_integration/apps.py,sha256=Xcqck44MEvDFY6NryDTkkejI92Q_8Jgqv1oTHa87igg,2458
 edu_rdm_integration/consts.py,sha256=chOsPOOY4_JLzN-8idg-VjbLWSlp6r3maFWqnvUsapg,806
-edu_rdm_integration/entities.py,sha256=mI48GExfRrQZsyg8leGJDaiy8Cmf3vlkIttNq2OYJZI,9117
+edu_rdm_integration/entities.py,sha256=H_B3bF4uwM_xebhGZvgfxIOFHkzVb_7w8SaG3Bl3YUo,11200
 edu_rdm_integration/enums.py,sha256=fnDPz6pwOYWS6vp65IAExbpDzn2q9U3_9GGyuf4B468,4876
 edu_rdm_integration/mapping.py,sha256=bwa2fJCbV4YjQcAgRrgT3hgM6dJhr_uBtQgx3L3F2Ck,473
 edu_rdm_integration/models.py,sha256=eUlR0DUIXcvr2yy_b0GZA6Jv__X9_iWyUsJhDMKwFDk,24976
 edu_rdm_integration/signals.py,sha256=3eRlpkDcFCF6TN80-QM8yBYLcyozzcmoPjz6r4_ApWg,73
 edu_rdm_integration/storages.py,sha256=o5WqUG7SnkeuMt-z8spUi-IraivST-7KHzfY-M3v7FA,6807
-edu_rdm_integration/utils.py,sha256=CgFrW1mEQim3wcCX6q9o9mvIm79ASQ92HojXyuN3dc0,5558
+edu_rdm_integration/utils.py,sha256=vjme0N6tEXnHt6SaqjavZshjwc-mVv4X3Pz37a5YgTw,7092
 edu_rdm_integration/adapters/__init__.py,sha256=cU0swn4Ny5ZQz5buWRcWsT1mpWuUFJaUlHf2l7TtEBo,83
 edu_rdm_integration/adapters/apps.py,sha256=TyJTkSPs2qAHJ11fqbwLGk3Ea7ujtqWwbxqmvYNQxG8,363
 edu_rdm_integration/adapters/caches.py,sha256=OxSqeXySUN42LxEeHBLtC1ZBt-7aicbRbmP1EJYTvV4,1505
@@ -69,6 +69,9 @@ edu_rdm_integration/collect_data/non_calculated/base/runners.py,sha256=03pWh9LgF
 edu_rdm_integration/collect_data/non_calculated/base/strings.py,sha256=-k9dex8A7hCpkzUkudVkKRAbNRuuqog2hYl2xmibl8I,181
 edu_rdm_integration/collect_data/non_calculated/base/tests.py,sha256=MoRY-a75Ow-7EjeQYxkXWunwqTGuBMaUyEkEV2oy05I,59
 edu_rdm_integration/collect_data/non_calculated/base/validators.py,sha256=0YvnfrfK1iFcZVSB-M-Xv82tIjYxEU_BwLofAEuGVW4,973
+edu_rdm_integration/enum_register/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+edu_rdm_integration/enum_register/mixins.py,sha256=fcq1pz4it0JJbgSMj4xEu8ALVQgy2zRLsWFtSmj-iEc,2881
+edu_rdm_integration/enum_register/register.py,sha256=X7vCZZyzdwaFYBM-yfSkE11RWwBfTCLUKLVv_sDtYAg,2281
 edu_rdm_integration/export_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 edu_rdm_integration/export_data/consts.py,sha256=Z6Uho8oViMc0t1tyQFZfrPFBwPx6KnhUf_iZ0qgob8o,16
 edu_rdm_integration/export_data/export.py,sha256=xr3_oTnufS_NMgJLPIeL87fNkt7zOVA5rM44sB3QvEw,14946
@@ -129,9 +132,9 @@ edu_rdm_integration/management/commands/export_entities_data.py,sha256=Mas1zwsH-
 edu_rdm_integration/migrations/0001_initial.py,sha256=toNuYoHZePe5wJ6AKEW9oPOdt2OefmxDEDDJGYQIrFk,18719
 edu_rdm_integration/migrations/0002_init_data_uploadstatus.py,sha256=kht966YNuDbC3qTGrcWswJPsVuAtNO59Ck15G2eS2bU,944
 edu_rdm_integration/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-edu_rdm_integration-0.6.6.dist-info/LICENSE,sha256=uw43Gjjj-1vXWCItfSrNDpbejnOwZMrNerUh8oWbq8Q,3458
-edu_rdm_integration-0.6.6.dist-info/METADATA,sha256=9__jYHSUtU3cPZY65i-5ckdPpZUVpRZ725spfS1EqJA,37636
-edu_rdm_integration-0.6.6.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-edu_rdm_integration-0.6.6.dist-info/namespace_packages.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-edu_rdm_integration-0.6.6.dist-info/top_level.txt,sha256=nRJV0O14UtNE-jGIYG03sohgFnZClvf57H5m6VBXe9Y,20
-edu_rdm_integration-0.6.6.dist-info/RECORD,,
+edu_rdm_integration-0.6.7.dist-info/LICENSE,sha256=uw43Gjjj-1vXWCItfSrNDpbejnOwZMrNerUh8oWbq8Q,3458
+edu_rdm_integration-0.6.7.dist-info/METADATA,sha256=6um_otgQ2Z06f_7Dw4GKMB8qz8CsKXKtlYACvsvVetw,38265
+edu_rdm_integration-0.6.7.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+edu_rdm_integration-0.6.7.dist-info/namespace_packages.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+edu_rdm_integration-0.6.7.dist-info/top_level.txt,sha256=nRJV0O14UtNE-jGIYG03sohgFnZClvf57H5m6VBXe9Y,20
+edu_rdm_integration-0.6.7.dist-info/RECORD,,