oarepo-runtime 1.5.32__tar.gz → 1.5.34__tar.gz

{oarepo_runtime-1.5.32/oarepo_runtime.egg-info → oarepo_runtime-1.5.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.5.32
+Version: 1.5.34
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.32 → oarepo_runtime-1.5.34}/oarepo_runtime/cli/index.py

@@ -95,17 +95,6 @@ def record_or_service(model):
     return record
 
 
-def model_records_generator(model_class):
-    try:
-        for x in db.session.query(model_class.model_cls.id).filter(
-            model_class.model_cls.is_deleted.is_(False)
-        ):
-            rec_id = x[0]
-            yield model_class.get_record(rec_id)
-    except Exception as e:
-        click.secho(f"Could not index {model_class}: {e}", fg="red", file=sys.stderr)
-
-
 @index.command()
 @with_appcontext
 @click.argument("model", required=False)
@@ -119,14 +108,22 @@ def reindex(model, bulk_size, verbose):
     for service_id in services:
         click.secho(f"Preparing to index {service_id}", file=sys.stderr)
 
-        service = current_service_registry.get(service_id)
+        try:
+            service = current_service_registry.get(service_id)
+        except KeyError:
+            click.secho(f"Service {service_id} not in known services:", color="red")
+            for known_service_id, known_service in sorted(current_service_registry._services.items()):
+                click.secho(f"    {known_service_id} -> {type(known_service).__module__}.{type(known_service).__name__}", color="red")
+            sys.exit(1)
         record_class = getattr(service.config, "record_cls", None)
 
         id_generators = []
 
+        record_generator = RECORD_GENERATORS.get(service_id,  model_records_generator)
+
         if record_class and hasattr(service, "indexer"):
             try:
-                id_generators.append(model_records_generator(record_class))
+                id_generators.append(record_generator(record_class))
             except Exception as e:
                 click.secho(
                     f"Could not get record ids for {service_id}, exception {e}",
@@ -137,7 +134,7 @@ def reindex(model, bulk_size, verbose):
 
         if draft_class and hasattr(service, "indexer"):
             try:
-                id_generators.append(model_records_generator(draft_class))
+                id_generators.append(record_generator(draft_class))
             except Exception as e:
                 click.secho(
                     f"Could not get draft record ids for {service_id}, exception {e}",
@@ -151,7 +148,6 @@ def reindex(model, bulk_size, verbose):
             for bulk in generate_bulk_data(gen, service.indexer, bulk_size=bulk_size):
                 index_result = service.indexer.client.bulk(bulk)
                 count += len(bulk) // 2
-
                 for index_item_result in index_result["items"]:
                     result = index_item_result["index"]
                     if result["status"] != 200:
@@ -215,3 +211,28 @@ def dump_yaml(data):
     io = StringIO()
     yaml.dump(data, io, allow_unicode=True)
     return io.getvalue()
+
+
+def model_records_generator(model_class):
+    try:
+        for x in db.session.query(model_class.model_cls.id).filter(
+            model_class.model_cls.is_deleted.is_(False)
+        ):
+            rec_id = x[0]
+            yield model_class.get_record(rec_id)
+    except Exception as e:
+        click.secho(f"Could not index {model_class}: {e}", fg="red", file=sys.stderr)
+
+def users_record_generator(model_class):
+    from invenio_accounts.models import User
+    from invenio_users_resources.records.api import UserAggregate
+    try:
+        for x in db.session.query(User.id):
+            rec_id = x[0]
+            yield UserAggregate.get_record(rec_id)
+    except Exception as e:
+        click.secho(f"Could not index {model_class}: {e}", fg="red", file=sys.stderr)
+
+RECORD_GENERATORS = {
+    'users': users_record_generator
+}

oarepo_runtime-1.5.34/oarepo_runtime/i18n/__init__.py

@@ -0,0 +1,3 @@
+from flask_babel import get_locale, gettext, lazy_gettext
+
+__all__ = ("gettext", "lazy_gettext", "get_locale")

oarepo_runtime-1.5.34/oarepo_runtime/records/entity_resolvers/__init__.py

@@ -0,0 +1,6 @@
+from oarepo_runtime.records.entity_resolvers.proxies import DraftProxy, RecordProxy
+
+from invenio_records_resources.references import EntityResolver, RecordResolver
+from invenio_users_resources.entity_resolvers import UserResolver, GroupResolver
+
+__all__ = ["DraftProxy", "UserResolver", "GroupResolver", "RecordResolver", "EntityResolver", "RecordProxy"]

oarepo_runtime-1.5.34/oarepo_runtime/records/entity_resolvers/proxies.py

@@ -0,0 +1,48 @@
+from invenio_pidstore.errors import PIDUnregistered
+
+from invenio_records_resources.references.entity_resolvers.records import (
+    RecordProxy as InvenioRecordProxy,
+)
+
+from sqlalchemy.exc import NoResultFound
+
+
+def set_field(result, resolved_dict, field_name):
+    from_metadata = resolved_dict.get("metadata", {}).get(field_name)
+    from_data = resolved_dict.get(field_name)
+
+    if from_metadata:
+        result.setdefault("metadata", {})[field_name] = from_metadata
+    if from_data:
+        result[field_name] = from_data
+
+
+class RecordProxy(InvenioRecordProxy):
+    picked_fields = ["title", "creators", "contributors"]
+
+    def pick_resolved_fields(self, identity, resolved_dict):
+        """Select which fields to return when resolving the reference."""
+        resolved_fields = super().pick_resolved_fields(identity, resolved_dict)
+
+        for fld in self.picked_fields:
+            set_field(resolved_fields, resolved_dict, fld)
+
+        return resolved_fields
+
+    def ghost_record(self, value):
+        return {
+            **value,
+            "metadata": {
+                "title": "Deleted record",
+            },
+        }
+
+
+class DraftProxy(RecordProxy):
+    def _resolve(self):
+        pid_value = self._parse_ref_dict_id()
+        try:
+            return self.record_cls.pid.resolve(pid_value, registered_only=False)
+        except (PIDUnregistered, NoResultFound):
+            # try checking if it is a published record before failing
+            return self.record_cls.pid.resolve(pid_value)

{oarepo_runtime-1.5.32 → oarepo_runtime-1.5.34}/oarepo_runtime/services/schema/i18n.py

@@ -1,6 +1,7 @@
 from functools import lru_cache
-
+import importlib
 import langcodes
+from invenio_base.utils import obj_or_import_string
 from marshmallow import Schema, ValidationError, fields, validates
 
 """
@@ -10,39 +11,41 @@ it for each project.
 
 
 @lru_cache
-def get_i18n_schema(lang_field, value_field):
-    @validates(lang_field)
+def get_i18n_schema(lang_name, value_name, value_field="marshmallow_utils.fields.SanitizedHTML"):
+    @validates(lang_name)
     def validate_lang(self, value):
         if value != "_" and not langcodes.Language.get(value).is_valid():
             raise ValidationError("Invalid language code")
 
+    value_field_class = obj_or_import_string(value_field)
+
     return type(
-        f"I18nSchema_{lang_field}_{value_field}",
+        f"I18nSchema_{lang_name}_{value_name}",
         (Schema,),
         {
             "validate_lang": validate_lang,
-            lang_field: fields.String(required=True),
-            value_field: fields.String(required=True),
+            lang_name: fields.String(required=True),
+            value_name: value_field_class(required=True),
         },
     )
 
 
 def MultilingualField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
+    *args, lang_name="lang", value_name="value", value_field="marshmallow_utils.fields.SanitizedHTML", **kwargs
 ):
     # TODO: args are not used but oarepo-model-builder-multilingual generates them
     # should be fixed there and subsequently removed here
     return fields.List(
-        fields.Nested(get_i18n_schema(lang_field, value_field)),
+        fields.Nested(get_i18n_schema(lang_name, value_name, value_field)),
         **kwargs,
     )
 
 
 def I18nStrField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
+    *args, lang_name="lang", value_name="value", value_field="marshmallow_utils.fields.SanitizedHTML", **kwargs
 ):
     return fields.Nested(
-        get_i18n_schema(lang_field, value_field),
+        get_i18n_schema(lang_name, value_name, value_field),
         *args,
         **kwargs,
     )

oarepo_runtime-1.5.34/oarepo_runtime/services/schema/i18n_ui.py

@@ -0,0 +1,74 @@
+from functools import lru_cache
+
+from marshmallow import Schema, fields
+from marshmallow_utils.fields import SanitizedHTML
+from invenio_base.utils import obj_or_import_string
+
+@lru_cache
+def get_i18n_ui_schema(lang_name, value_name, value_field="marshmallow_utils.fields.SanitizedHTML"):
+    value_field_class = obj_or_import_string(value_field)
+    return type(
+        f"I18nUISchema_{lang_name}_{value_name}",
+        (Schema,),
+        {
+            lang_name: fields.String(required=True),
+            value_name: value_field_class(required=True),
+        },
+    )
+
+
+def MultilingualUIField(  # noqa NOSONAR
+    *args, lang_name="lang", value_name="value", value_field="marshmallow_utils.fields.SanitizedHTML", **kwargs
+):
+    return fields.List(
+        fields.Nested(get_i18n_ui_schema(lang_name, value_name, value_field)),
+        **kwargs,
+    )
+
+
+def I18nStrUIField(  # noqa NOSONAR
+    *args, lang_name="lang", value_name="value", value_field="marshmallow_utils.fields.SanitizedHTML", **kwargs
+):
+    return fields.Nested(
+        get_i18n_ui_schema(lang_name, value_name, value_field),
+        *args,
+        **kwargs,
+    )
+
+
+@lru_cache
+def get_i18n_localized_ui_schema(lang_name, value_name):
+    class I18nLocalizedUISchema(Schema):
+        def _serialize(self, value, attr=None, obj=None, **kwargs):
+            if not value:
+                return None
+            language = self.context["locale"].language
+            for v in value:
+                if language == v[lang_name]:
+                    return v[value_name]
+            return next(iter(value))[value_name]
+
+    # inherit to get a nice name for debugging
+    return type(
+        f"I18nLocalizedUISchema_{lang_name}_{value_name}",
+        (I18nLocalizedUISchema,),
+        {},
+    )
+
+
+def MultilingualLocalizedUIField(  # noqa NOSONAR
+    *args, lang_name="lang", value_name="value", **kwargs
+):
+    return fields.Nested(
+        get_i18n_localized_ui_schema(lang_name, value_name), **kwargs
+    )
+
+
+def I18nStrLocalizedUIField(  # noqa NOSONAR
+    *args, lang_name="lang", value_name="value", **kwargs
+):
+    return fields.Nested(
+        get_i18n_ui_schema(lang_name, value_name),
+        *args,
+        **kwargs,
+    )

{oarepo_runtime-1.5.32 → oarepo_runtime-1.5.34/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.5.32
+Version: 1.5.34
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.32 → oarepo_runtime-1.5.34}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.5.32
+version = 1.5.34
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md
@@ -8,7 +8,7 @@ long_description = file:README.md
 long_description_content_type = text/markdown
 
 [options]
-python = >=3.9
+python = >=3.10
 install_requires = 
 	marshmallow
 	langcodes

oarepo_runtime-1.5.32/oarepo_runtime/i18n/__init__.py

@@ -1,10 +0,0 @@
-from oarepo import __version__ as oarepo_version
-
-# compatibility setting between invenio rdm 11 and invenio rdm 12
-# can be removed when invenio rdm 11 is no longer supported
-if oarepo_version.split(".")[0] == "11":
-    from flask_babelex import get_locale, gettext, lazy_gettext
-else:
-    from flask_babel import get_locale, gettext, lazy_gettext
-
-__all__ = ("gettext", "lazy_gettext", "get_locale")

oarepo_runtime-1.5.32/oarepo_runtime/records/entity_resolvers/__init__.py

@@ -1,90 +0,0 @@
-from oarepo import __version__ as oarepo_version
-
-from oarepo_runtime.records.entity_resolvers.proxies import DraftProxy
-
-# compatibility setting between invenio rdm 11 and invenio rdm 12
-# can be removed when invenio rdm 11 is no longer supported
-if oarepo_version.split(".")[0] == "11":
-    from invenio_records_resources.references import EntityResolver, RecordResolver
-    from invenio_users_resources.resolvers import UserResolver
-
-    #copyied from newer invenio_users_resources, GroupResolver isn't in older versions
-    from flask_principal import RoleNeed
-    from invenio_accounts.models import Role
-    from invenio_records_resources.references.resolvers import (
-        EntityProxy,
-        EntityResolver,
-    )
-    from invenio_users_resources.services.groups.config import GroupsServiceConfig
-    from sqlalchemy.exc import NoResultFound
-
-    class GroupProxy(EntityProxy):
-        """Resolver proxy for a Role entity."""
-
-        def _resolve(self):
-            """Resolve the User from the proxy's reference dict, or system_identity."""
-            # Resolves to role name, not id
-            role_id = self._parse_ref_dict_id()
-            try:
-                return Role.query.filter(
-                    Role.name == role_id  # TODO to be changed to role id
-                ).one()
-            except NoResultFound:
-                return {}
-
-        def pick_resolved_fields(self, identity, resolved_dict):
-            """Select which fields to return when resolving the reference."""
-            serialized_role = {}
-
-            return serialized_role
-
-        def get_needs(self, ctx=None):
-            """Return needs based on the given roles."""
-            role_id = self._parse_ref_dict_id()
-            return [RoleNeed(role_id)]
-
-        def ghost_record(self, value):
-            """Return default representation of not resolved group.
-
-            .. note::
-
-                Only groups that are not indexed should need this. Non-indexed groups include groups that were not created by users
-                e.g. user-moderation.
-            """
-            return {}
-
-
-    class GroupResolver(EntityResolver):
-        """Group entity resolver."""
-
-        type_id = "group"
-        """Type identifier for this resolver."""
-
-        def __init__(self):
-            """Constructor."""
-            # There's a bit of a mixup of type_key and type_id. Base resolver has no
-            # type_key, but RecordResolvers have.
-            self.type_key = self.type_id
-            super().__init__(GroupsServiceConfig.service_id)
-
-        def matches_reference_dict(self, ref_dict):
-            """Check if the reference dict references a role."""
-            return self._parse_ref_dict_type(ref_dict) == self.type_id
-
-        def _reference_entity(self, entity):
-            """Create a reference dict for the given user."""
-            return {"group": str(entity.id)}
-
-        def matches_entity(self, entity):
-            """Check if the entity is a Role."""
-            return isinstance(entity, Role)
-
-        def _get_entity_proxy(self, ref_dict):
-            """Return a GroupProxy for the given reference dict."""
-            return GroupProxy(self, ref_dict)
-
-else:
-    from invenio_records_resources.references import EntityResolver, RecordResolver
-    from invenio_users_resources.entity_resolvers import UserResolver, GroupResolver
-
-__all__ = ["DraftProxy", "UserResolver", "GroupResolver", "RecordResolver", "EntityResolver"]

oarepo_runtime-1.5.32/oarepo_runtime/records/entity_resolvers/proxies.py

@@ -1,24 +0,0 @@
-from invenio_pidstore.errors import PIDUnregistered
-from oarepo import __version__ as oarepo_version
-
-# compatibility setting between invenio rdm 11 and invenio rdm 12
-# can be removed when invenio rdm 11 is no longer supported
-if oarepo_version.split(".")[0] == "11":
-    from invenio_records_resources.references.resolvers.records import RecordProxy
-else:
-    from invenio_records_resources.references.entity_resolvers.records import (
-        RecordProxy,
-    )
-
-from sqlalchemy.exc import NoResultFound
-
-
-class DraftProxy(RecordProxy):
-    def _resolve(self):
-        pid_value = self._parse_ref_dict_id()
-
-        try:
-            return self.record_cls.pid.resolve(pid_value, registered_only=False)
-        except (PIDUnregistered, NoResultFound):
-            # try checking if it is a published record before failing
-            return self.record_cls.pid.resolve(pid_value)

oarepo_runtime-1.5.32/oarepo_runtime/services/schema/i18n_ui.py

@@ -1,72 +0,0 @@
-from functools import lru_cache
-
-from marshmallow import Schema, fields
-
-
-@lru_cache
-def get_i18n_ui_schema(lang_field, value_field):
-    return type(
-        f"I18nUISchema_{lang_field}_{value_field}",
-        (Schema,),
-        {
-            lang_field: fields.String(required=True),
-            value_field: fields.String(required=True),
-        },
-    )
-
-
-def MultilingualUIField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
-):
-    return fields.List(
-        fields.Nested(get_i18n_ui_schema(lang_field, value_field)),
-        **kwargs,
-    )
-
-
-def I18nStrUIField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
-):
-    return fields.Nested(
-        get_i18n_ui_schema(lang_field, value_field),
-        *args,
-        **kwargs,
-    )
-
-
-@lru_cache
-def get_i18n_localized_ui_schema(lang_field, value_field):
-    class I18nLocalizedUISchema(Schema):
-        def _serialize(self, value, attr=None, obj=None, **kwargs):
-            if not value:
-                return None
-            language = self.context["locale"].language
-            for v in value:
-                if language == v[lang_field]:
-                    return v[value_field]
-            return next(iter(value))[value_field]
-
-    # inherit to get a nice name for debugging
-    return type(
-        f"I18nLocalizedUISchema_{lang_field}_{value_field}",
-        (I18nLocalizedUISchema,),
-        {},
-    )
-
-
-def MultilingualLocalizedUIField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
-):
-    return fields.Nested(
-        get_i18n_localized_ui_schema(lang_field, value_field), **kwargs
-    )
-
-
-def I18nStrLocalizedUIField(  # noqa NOSONAR
-    *args, lang_field="lang", value_field="value", **kwargs
-):
-    return fields.Nested(
-        get_i18n_ui_schema(lang_field, value_field),
-        *args,
-        **kwargs,
-    )