oarepo-runtime 1.10.2__py3-none-any.whl → 2.0.0.dev3__py3-none-any.whl

oarepo_runtime/services/config/service.py

@@ -1,117 +0,0 @@
-import inspect
-import re
-from typing import List, Type
-
-from flask import current_app
-from invenio_records_permissions import BasePermissionPolicy
-
-from oarepo_runtime.utils.functools import class_property
-
-
-class PermissionsPresetsConfigMixin:
-    components = tuple()
-    PERMISSIONS_PRESETS_CONFIG_KEY = None
-    # PERMISSIONS_PRESETS = []         # noqa (omitted here because of the order of mixins)
-
-    @class_property
-    def permission_policy_cls(cls):
-        """
-        Returns a class that contains all permissions from the presets.
-
-        Needs to be a class property as invenio-vocabularies, unlike other invenio records,
-        do not instantiate the service configuration class, but use it as a class.
-        """
-        presets = cls._get_preset_classes()
-
-        permissions = {}
-        for preset_class in presets:
-            for permission_name, permission_needs in cls._get_permissions_from_preset(
-                preset_class
-            ):
-                target = permissions.setdefault(permission_name, [])
-                for need in permission_needs:
-                    if need not in target:
-                        target.append(need)
-
-        return type(f"{cls.__name__}Permissions", tuple(presets), permissions)
-
-    @staticmethod
-    def _get_permissions_from_preset(preset_class):
-        for permission_name, permission_needs in inspect.getmembers(preset_class):
-            if not permission_name.startswith("can_"):
-                continue
-            if not isinstance(permission_needs, (list, tuple)):
-                continue
-            yield permission_name, permission_needs
-
-    @classmethod
-    def _get_preset_classes(cls) -> List[Type[BasePermissionPolicy]]:
-        """
-        Returns a list of permission presets classes to be used for this service.
-
-        The list is read from the configuration, if it exists, otherwise it returns
-        the default value from the class attribute PERMISSIONS_PRESETS.
-        """
-        registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
-        preset_classes = []
-        for x in cls._get_permissions_presets():
-            if isinstance(x, str):
-                preset_classes.append(registered_preset_classes[x])
-            else:
-                preset_classes.append(x)
-
-        if hasattr(cls, "base_permission_policy_cls"):
-            preset_classes.insert(0, cls.base_permission_policy_cls)
-        return preset_classes
-
-    @classmethod
-    def _get_permissions_presets(cls):
-        """
-        Returns a list of names of permissions presets to be used for this service.
-
-        The list is read from the configuration, if it exists, otherwise it returns
-        the default value from the class attribute PERMISSIONS_PRESETS.
-        """
-        config_key = cls._get_presents_config_key()
-        if config_key in current_app.config:
-            return current_app.config[config_key]
-        return (
-            cls.PERMISSIONS_PRESETS
-        )  # noqa (omitted here because of the order of mixins)
-
-    @classmethod
-    def _get_presents_config_key(cls):
-        """
-        Returns the name of the configuration key that contains the list of
-        permissions presets to be used for this service.
-
-        The key is read from the class attribute PERMISSIONS_PRESETS_CONFIG_KEY.
-        If it is not set, the key is generated from the name of the service
-        configuration class (MyServiceConfig becomes MY_SERVICE_PERMISSIONS_PRESETS).
-        """
-        if cls.PERMISSIONS_PRESETS_CONFIG_KEY:
-            return cls.PERMISSIONS_PRESETS_CONFIG_KEY
-
-        # use the base class of the service config file (e.g. MyServiceConfig),
-        # remove the "Config" part and convert it to snake uppercase.
-        # add "_PERMISSIONS_PRESETS" at the end.
-        name = cls.__name__
-        if name.endswith("Config"):
-            name = name[:-6]
-        name = re.sub(r"(?<!^)(?=[A-Z])", "_", name).upper()
-        return f"{name}_PERMISSIONS_PRESETS"
-
-class SearchAllConfigMixin:
-    @property
-    def search_all(self):
-        from invenio_rdm_records.services.search_params import MyDraftsParam
-        if hasattr(self, "search_drafts"):
-            class AllSearchOptions(self.search_drafts):
-                @class_property
-                def params_interpreters_cls(cls):
-                    param_interpreters = [*super().params_interpreters_cls]
-                    param_interpreters.remove(MyDraftsParam)
-                    return param_interpreters
-            return AllSearchOptions
-        else:
-            return self.search

oarepo_runtime/services/custom_fields/__init__.py

@@ -1,80 +0,0 @@
-from typing import List
-
-from flask import current_app
-from invenio_records.systemfields import DictField, SystemField
-from invenio_records_resources.services.custom_fields import BaseCF
-
-from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
-
-
-class CustomFieldsMixin(MappingSystemFieldMixin):
-    def __init__(self, config_key, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        self.config_key = config_key
-
-    @property
-    def mapping(self):
-        custom_fields: List[BaseCF] = current_app.config[self.config_key]
-        return {cf.name: cf.mapping for cf in custom_fields}
-
-    @property
-    def mapping_settings(self):
-        return {}
-
-    def search_dump(self, data, record):
-        custom_fields = current_app.config.get(self.config_key, {})
-
-        for cf in custom_fields:
-            cf.dump(data, cf_key=self.key)
-        return data
-
-    def search_load(self, data, record_cls):
-        custom_fields = current_app.config.get(self.config_key, {})
-
-        for cf in custom_fields:
-            cf.load(data, cf_key=self.key)
-        return data
-
-
-class CustomFields(CustomFieldsMixin, DictField):
-    @property
-    def mapping(self):
-        return {self.key: {"type": "object", "properties": super().mapping}}
-
-
-class InlinedCustomFields(CustomFieldsMixin, SystemField):
-
-    def __get__(self, record, owner=None):
-        """Getting the attribute value."""
-        if record is None:
-            return self
-        return self.get_dictkey(record)
-
-    def __set__(self, record, value):
-        """Setting a new value."""
-        self.set_dictkey(record, value)
-
-
-class InlinedCustomFieldsSchemaMixin:
-    CUSTOM_FIELDS_VAR = None
-    CUSTOM_FIELDS_FIELD_PROPERTY = "field"
-
-    def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-
-        if self.CUSTOM_FIELDS_VAR is None:
-            raise AttributeError(
-                "CUSTOM_FIELDS_VAR field must be set to the name of config variable containing an array of custom fields"
-            )
-        custom_fields = current_app.config.get(self.CUSTOM_FIELDS_VAR, [])
-        if not isinstance(custom_fields, (list, tuple)):
-            raise AttributeError("CUSTOM_FIELDS_VAR must be a list or tuple")
-        for cf in custom_fields:
-            self.declared_fields[cf.name] = getattr(
-                cf, self.CUSTOM_FIELDS_FIELD_PROPERTY
-            )
-        self._init_fields()
-
-
-class InlinedUICustomFieldsSchemaMixin(InlinedCustomFieldsSchemaMixin):
-    CUSTOM_FIELDS_FIELD_PROPERTY = "ui_field"

oarepo_runtime/services/custom_fields/mappings.py

@@ -1,188 +0,0 @@
-import inspect
-from typing import Iterable
-
-import click
-import deepmerge
-from invenio_records_resources.proxies import current_service_registry
-from invenio_records_resources.services.custom_fields.mappings import (
-    Mapping as InvenioMapping,
-)
-from invenio_records_resources.services.records.config import RecordServiceConfig
-from invenio_records_resources.services.records.service import RecordService
-from invenio_search.engine import search
-from deepmerge import always_merger
-from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
-import json
-
-from pathlib import Path
-
-from oarepo_runtime.utils.index import prefixed_index
-
-
-class Mapping(InvenioMapping):
-    @classmethod
-    def properties_for_fields(
-        cls, given_fields_names, available_fields, field_name="custom_fields"
-    ):
-        """Prepare search mapping properties for each field."""
-
-        properties = {}
-        for field in cls._get_fields(given_fields_names, available_fields):
-            if field_name:
-                properties[f"{field_name}.{field.name}"] = field.mapping
-            else:
-                properties[field.name] = field.mapping
-
-        return properties
-
-    @classmethod
-    def settings_for_fields(
-        cls, given_fields_names, available_fields, field_name="custom_fields"
-    ):
-        """Prepare mapping settings for each field."""
-
-        settings = {}
-        for field in cls._get_fields(given_fields_names, available_fields):
-            if not hasattr(field, "mapping_settings"):
-                continue
-            settings = deepmerge.always_merger.merge(settings, field.mapping_settings)
-
-        return settings
-
-    @classmethod
-    def _get_fields(cls, given_fields_names, available_fields):
-        fields = []
-        if given_fields_names:  # create only specified fields
-            given_fields_names = set(given_fields_names)
-            for a_field in available_fields:
-                if a_field.name in given_fields_names:
-                    fields.append(a_field)
-                    given_fields_names.remove(a_field.name)
-                if len(given_fields_names) == 0:
-                    break
-        else:  # create all fields
-            fields = available_fields
-        return fields
-
-
-# pieces taken from https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/cli.py
-# as cf initialization is not supported directly in plain invenio
-def prepare_cf_indices():
-    service: RecordService
-    for service in current_service_registry._services.values():
-        config: RecordServiceConfig = service.config
-        record_class = getattr(config, "record_cls", None)
-        if record_class:
-            prepare_cf_index(record_class, config)
-            parent_class = getattr(record_class, "parent_record_cls", None)
-            prepare_parent_mapping(parent_class, config)
-            prepare_cf_index(parent_class, config, path=["parent", "properties"])
-
-
-def prepare_cf_index(record_class, config, path=[]):
-    if not record_class:
-        return
-
-    for fld in get_mapping_fields(record_class):
-        # get mapping
-        mapping = fld.mapping
-        settings = fld.mapping_settings
-        dynamic_templates = fld.dynamic_templates
-
-        for pth in reversed(path):
-            mapping = {pth: mapping}
-
-        # upload mapping
-        try:
-            record_index = prefixed_index(config.record_cls.index)
-            update_index(record_index, settings, mapping)
-
-            if hasattr(config, "draft_cls"):
-                draft_index = prefixed_index(config.draft_cls.index)
-                update_index(draft_index, settings, mapping, dynamic_templates)
-
-        except search.RequestError as e:
-            click.secho("An error occurred while creating custom fields.", fg="red")
-            click.secho(e.info["error"]["reason"], fg="red")
-
-
-def prepare_parent_mapping(parent_class, config):
-    if not parent_class:
-        return
-
-    if not config.record_cls.index._name:
-        return
-
-    script_dir = str(Path(__file__).resolve().parent)
-    path_parts = script_dir.split('/')
-    path_parts = path_parts[:-2]
-    base_path = '/'.join(path_parts)
-    mapping_path = f"{base_path}/records/mappings/rdm_parent_mapping.json"
-
-    with open(mapping_path, 'r') as f:
-        rdm_parent = json.load(f)
-
-    parent_mapping = {
-        "parent": {
-            "type": "object",
-            "properties": {
-                "created": {
-                    "type": "date",
-                    "format": "strict_date_time||strict_date_time_no_millis||basic_date_time||basic_date_time_no_millis||basic_date||strict_date||strict_date_hour_minute_second||strict_date_hour_minute_second_fraction",
-                },
-                "id": {"type": "keyword", "ignore_above": 1024},
-                "pid": {
-                    "properties": {
-                        "obj_type": {"type": "keyword", "ignore_above": 1024},
-                        "pid_type": {"type": "keyword", "ignore_above": 1024},
-                        "pk": {"type": "long"},
-                        "status": {"type": "keyword", "ignore_above": 1024},
-                    }
-                },
-                "updated": {
-                    "type": "date",
-                    "format": "strict_date_time||strict_date_time_no_millis||basic_date_time||basic_date_time_no_millis||basic_date||strict_date||strict_date_hour_minute_second||strict_date_hour_minute_second_fraction",
-                },
-                "uuid": {"type": "keyword", "ignore_above": 1024},
-                "version_id": {"type": "long"},
-            },
-        }
-    }
-    parent_mapping_merged = always_merger.merge(parent_mapping, {
-        "parent": {
-            "properties": rdm_parent
-        }
-    })
-    # upload mapping
-    try:
-        record_index = prefixed_index(config.record_cls.index)
-        update_index(record_index, {}, parent_mapping_merged)
-
-        if hasattr(config, "draft_cls"):
-            draft_index = prefixed_index(config.draft_cls.index) # draft index isn't used; this was a bug a suppose
-            update_index(draft_index, {}, parent_mapping_merged)
-
-    except search.RequestError as e:
-        click.secho("An error occurred while creating parent mapping.", fg="red")
-        click.secho(e.info["error"]["reason"], fg="red")
-
-
-def update_index(record_index, settings, mapping, dynamic_templates=None):
-    if settings:
-        record_index.close()
-        record_index.put_settings(body=settings)
-        record_index.open()
-    body = {}
-    if mapping:
-        body["properties"] = mapping
-    if dynamic_templates:
-        body["dynamic_templates"] = dynamic_templates
-    if body:
-        record_index.put_mapping(body=body)
-
-
-def get_mapping_fields(record_class) -> Iterable[MappingSystemFieldMixin]:
-    for cfg_name, cfg_value in inspect.getmembers(
-        record_class, lambda x: isinstance(x, MappingSystemFieldMixin)
-    ):
-        yield cfg_value

oarepo_runtime/services/entity/config.py

@@ -1,14 +0,0 @@
-from invenio_records_resources.services.base.config import ServiceConfig
-
-from ..results import ArrayRecordItem, ArrayRecordList
-from .schema import KeywordEntitySchema
-
-
-class EntityServiceConfig(ServiceConfig):
-    links_item = {}
-    result_item_cls = ArrayRecordItem
-    result_list_cls = ArrayRecordList
-
-
-class KeywordEntityServiceConfig(EntityServiceConfig):
-    schema = KeywordEntitySchema

oarepo_runtime/services/entity/schema.py

@@ -1,9 +0,0 @@
-from marshmallow import Schema, fields
-
-
-#
-# The default record schema
-#
-class KeywordEntitySchema(Schema):
-    keyword = fields.Str()
-    id = fields.Str()

oarepo_runtime/services/entity/service.py

@@ -1,48 +0,0 @@
-import abc
-from typing import Iterable
-
-from invenio_records_resources.services.base.links import LinksTemplate
-from invenio_records_resources.services.base.service import Service
-from invenio_records_resources.services.records.schema import ServiceSchemaWrapper
-
-
-class EntityService(Service):
-    @property
-    def links_item_tpl(self):
-        """Item links template."""
-        return LinksTemplate(
-            self.config.links_item,
-        )
-
-    @property
-    def schema(self):
-        """Returns the data schema instance."""
-        return ServiceSchemaWrapper(self, schema=self.config.schema)
-
-    @abc.abstractmethod
-    def read(self, identity, id_, **kwargs):
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    def read_many(self, identity, ids: Iterable[str], fields=None, **kwargs):
-        raise NotImplementedError()
-
-
-class KeywordEntityService(EntityService):
-
-    def read(self, identity, id_, **kwargs):
-        result = {"keyword": self.config.keyword, "id": id_}
-        return self.result_item(
-            self, identity, record=result, links_tpl=self.links_item_tpl
-        )
-
-    def read_many(self, identity, ids: Iterable[str], fields=None, **kwargs):
-        if not ids:
-            return []
-        results = [{"keyword": self.config.keyword, "id": id} for id in ids]
-        return self.result_list(
-            self,
-            identity,
-            results=results,
-            links_item_tpl=self.links_item_tpl,
-        )

oarepo_runtime/services/expansions/expandable_fields.py

@@ -1,21 +0,0 @@
-from invenio_records.dictutils import dict_lookup, dict_set
-from invenio_records_resources.services.records.results import ExpandableField
-
-
-class ReferencedRecordExpandableField(ExpandableField):
-    def __init__(self, field_name, keys, service, pid_field="id"):
-        super().__init__(field_name)
-        self.keys = keys
-        self.pid_field = pid_field
-        self.service = service
-
-    def get_value_service(self, value):
-        if self.pid_field is None:
-            return value, self.service
-        return dict_lookup(value, self.pid_field), self.service
-
-    def pick(self, identity, resolved_rec):
-        ret = {}
-        for key in self.keys:
-            dict_set(ret, key, dict_lookup(resolved_rec, key))
-        return ret

oarepo_runtime/services/expansions/service.py

@@ -1,4 +0,0 @@
-class ExpandableFieldsServiceMixin:
-    @property
-    def expandable_fields(self):
-        return getattr(self.config, "expandable_fields", [])

oarepo_runtime/services/facets/__init__.py

@@ -1,33 +0,0 @@
-from .base import LabelledValuesTermsFacet
-from .date import (
-    AutoDateHistogramFacet,
-    DateFacet,
-    DateIntervalFacet,
-    DateTimeFacet,
-    EDTFIntervalFacet,
-    TimeFacet,
-)
-from .enum import EnumTermsFacet
-from .facet_groups_names import facet_groups_names
-from .max_facet import MaxFacet
-from .nested_facet import NestedLabeledFacet
-from .params import FilteredFacetsParam, GroupedFacetsParam
-from .year_histogram import YearAutoHistogramFacet
-from .multilingual_facet import MultilingualFacet
-__all__ = [
-    "LabelledValuesTermsFacet",
-    "DateFacet",
-    "TimeFacet",
-    "DateTimeFacet",
-    "AutoDateHistogramFacet",
-    "EDTFIntervalFacet",
-    "DateIntervalFacet",
-    "EnumTermsFacet",
-    "facet_groups_names",
-    "MaxFacet",
-    "NestedLabeledFacet",
-    "GroupedFacetsParam",
-    "FilteredFacetsParam",
-    "YearAutoHistogramFacet",
-    "MultilingualFacet"
-]

oarepo_runtime/services/facets/base.py

@@ -1,12 +0,0 @@
-from invenio_records_resources.services.records.facets import TermsFacet
-
-
-class LabelledValuesTermsFacet(TermsFacet):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **{"value_labels": self.value_labels, **kwargs})
-
-    def localized_value_labels(self, values, locale):
-        return {val: val for val in values}
-
-    def value_labels(self, values):
-        return {val: val for val in values}

oarepo_runtime/services/facets/date.py

@@ -1,72 +0,0 @@
-import re
-
-from invenio_records_resources.services.records.facets.facets import LabelledFacetMixin
-from invenio_search.engine import dsl
-
-from oarepo_runtime.services.schema.ui import (
-    LocalizedDate,
-    LocalizedDateTime,
-    LocalizedEDTF,
-    LocalizedEDTFInterval,
-    LocalizedTime,
-)
-
-from .base import LabelledValuesTermsFacet
-
-
-class DateFacet(LabelledValuesTermsFacet):
-    def localized_value_labels(self, values, locale):
-        return {val: LocalizedDate(locale=locale).format_value(val) for val in values}
-
-
-class TimeFacet(LabelledValuesTermsFacet):
-    def localized_value_labels(self, values, locale):
-        return {val: LocalizedTime(locale=locale).format_value(val) for val in values}
-
-
-class DateTimeFacet(LabelledValuesTermsFacet):
-    def localized_value_labels(self, values, locale):
-        return {
-            val: LocalizedDateTime(locale=locale).format_value(val) for val in values
-        }
-
-
-class EDTFFacet(LabelledValuesTermsFacet):
-    def localized_value_labels(self, values, locale):
-        return {
-            val: LocalizedEDTF(locale=locale).format_value(convert_to_edtf(val))
-            for val in values
-        }
-
-
-class AutoDateHistogramFacet(dsl.DateHistogramFacet):
-    agg_type = "auto_date_histogram"
-
-    def __init__(self, **kwargs):
-        # skip DateHistogramFacet constructor
-        super(dsl.DateHistogramFacet, self).__init__(**kwargs)
-
-
-class EDTFIntervalFacet(LabelledFacetMixin, AutoDateHistogramFacet):
-    # auto_date_histogram
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-    def localized_value_labels(self, values, locale):
-        return {
-            val: LocalizedEDTFInterval(locale=locale).format_value(convert_to_edtf(val))
-            for val in values
-        }
-
-
-class DateIntervalFacet(EDTFIntervalFacet):
-    pass
-
-
-def convert_to_edtf(val):
-    if "/" in val:
-        # interval
-        return "/".join(convert_to_edtf(x) for x in val.split("/"))
-    val = re.sub(r"T.*", "", val)  # replace T12:00:00.000Z with nothing
-    print(val)
-    return val

oarepo_runtime/services/facets/enum.py

@@ -1,11 +0,0 @@
-from .base import LabelledValuesTermsFacet
-
-
-class EnumTermsFacet(LabelledValuesTermsFacet):
-    # TODO: https://github.com/oarepo/oarepo-runtime/issues/43
-    pass
-    # def value_labels(self, values):
-    # field = self._params["field"]
-    # field_path = field.replace(".", "/")
-    # field_enum = f"{field_path}.enum."
-    # return {val: lazy_gettext(f"{field_enum}{val}") for val in values}

oarepo_runtime/services/facets/facet_groups_names.py

@@ -1,17 +0,0 @@
-from typing import List
-
-from flask_principal import Identity
-from invenio_records_resources.services import SearchOptions as InvenioSearchOptions
-
-
-def facet_groups_names(
-    identity: Identity, search_options: InvenioSearchOptions, params
-) -> List[str]:
-    """
-    Default implementation for Flask-principal identity.
-    """
-
-    if hasattr(identity, "provides"):
-        return [need.value for need in identity.provides if need.method == "role"]
-
-    return []

oarepo_runtime/services/facets/max_facet.py

@@ -1,13 +0,0 @@
-from invenio_records_resources.services.records.facets.facets import LabelledFacetMixin
-from opensearch_dsl import Facet
-
-
-class MaxFacet(LabelledFacetMixin, Facet):
-    agg_type = "max"
-
-    def get_labelled_values(self, data, filter_values):
-        value = None
-        if "value_as_string" in data:
-            value = data["value_as_string"]
-
-        return {"label": str(self._label), "value": value}