oarepo-runtime 1.10.3__py3-none-any.whl → 2.0.0.dev4__py3-none-any.whl

oarepo_runtime/services/schema/oneofschema.py

@@ -1,192 +0,0 @@
-import typing
-
-from marshmallow import Schema, ValidationError
-
-
-class OneOfSchema(Schema):
-    """
-    This is a special kind of schema that actually multiplexes other schemas
-    based on object type. When serializing values, it uses get_obj_type() method
-    to get object type name. Then it uses `type_schemas` name-to-Schema mapping
-    to get schema for that particular object type, serializes object using that
-    schema and adds an extra "type" field with name of object type.
-    Deserialization is reverse.
-
-    Example:
-
-        class Foo(object):
-            def __init__(self, foo):
-                self.foo = foo
-
-        class Bar(object):
-            def __init__(self, bar):
-                self.bar = bar
-
-        class FooSchema(marshmallow.Schema):
-            foo = marshmallow.fields.String(required=True)
-
-            @marshmallow.post_load
-            def make_foo(self, data, **kwargs):
-                return Foo(**data)
-
-        class BarSchema(marshmallow.Schema):
-            bar = marshmallow.fields.Integer(required=True)
-
-            @marshmallow.post_load
-            def make_bar(self, data, **kwargs):
-                return Bar(**data)
-
-        class MyUberSchema(marshmallow.OneOfSchema):
-            type_schemas = {
-                'foo': FooSchema,
-                'bar': BarSchema,
-            }
-
-            def get_obj_type(self, obj):
-                if isinstance(obj, Foo):
-                    return 'foo'
-                elif isinstance(obj, Bar):
-                    return 'bar'
-                else:
-                    raise Exception('Unknown object type: %s' % repr(obj))
-
-        MyUberSchema().dump([Foo(foo='hello'), Bar(bar=123)], many=True)
-        # => [{'type': 'foo', 'foo': 'hello'}, {'type': 'bar', 'bar': 123}]
-
-    You can control type field name added to serialized object representation by
-    setting `type_field` class property.
-    """
-
-    type_field = "type"
-    type_field_remove = True
-    type_schemas: typing.Mapping[str, typing.Union[typing.Type[Schema], Schema]] = {}
-
-    def get_obj_type(self, obj):
-        """Returns name of the schema during dump() calls, given the object
-        being dumped."""
-        return obj.__class__.__name__
-
-    def get_data_type(self, data):
-        """Returns name of the schema during load() calls, given the data being
-        loaded. Defaults to looking up `type_field` in the data."""
-        data_type = data.get(self.type_field)
-        if self.type_field in data and self.type_field_remove:
-            data.pop(self.type_field)
-        return data_type
-
-    def dump(self, obj, *, many=None, **kwargs):
-        errors = {}
-        result_data = []
-        result_errors = {}
-        many = self.many if many is None else bool(many)
-        if not many:
-            result = result_data = self._dump(obj, **kwargs)
-        else:
-            for idx, o in enumerate(obj):
-                try:
-                    result = self._dump(o, **kwargs)
-                    result_data.append(result)
-                except ValidationError as error:
-                    result_errors[idx] = error.normalized_messages()
-                    result_data.append(error.valid_data)
-
-        result = result_data
-        errors = result_errors
-
-        if not errors:
-            return result
-        else:
-            exc = ValidationError(errors, data=obj, valid_data=result)
-            raise exc
-
-    def _dump(self, obj, *, update_fields=True, **kwargs):
-        obj_type = self.get_obj_type(obj)
-        if obj_type is None:
-            return (
-                None,
-                {"_schema": "Unknown object class: %s" % obj.__class__.__name__},
-            )
-
-        type_schema = self.type_schemas.get(obj_type)
-        if not type_schema:
-            return None, {"_schema": "Unsupported object type: %s" % obj_type}
-
-        schema = type_schema if isinstance(type_schema, Schema) else type_schema()
-
-        schema.context.update(getattr(self, "context", {}))
-
-        result = schema.dump(obj, many=False, **kwargs)
-        if result is not None:
-            result[self.type_field] = obj_type
-        return result
-
-    def load(self, data, *, many=None, partial=None, unknown=None, **kwargs):
-        errors = {}
-        result_data = []
-        result_errors = {}
-        many = self.many if many is None else bool(many)
-        if partial is None:
-            partial = self.partial
-        if not many:
-            try:
-                result_data = self._load(
-                    data, partial=partial, unknown=unknown, **kwargs
-                )
-            except ValidationError as error:
-                result_errors = error.normalized_messages()
-                result_data = error.valid_data
-        else:
-            for idx, item in enumerate(data):
-                try:
-                    result = self._load(item, partial=partial, **kwargs)
-                    result_data.append(result)
-                except ValidationError as error:
-                    result_errors[idx] = error.normalized_messages()
-                    result_data.append(error.valid_data)
-
-        result = result_data
-        errors = result_errors
-
-        if not errors:
-            return result
-        else:
-            exc = ValidationError(errors, data=data, valid_data=result)
-            raise exc
-
-    def _load(self, data, *, partial=None, unknown=None, **kwargs):
-        if not isinstance(data, dict):
-            raise ValidationError({"_schema": "Invalid data type: %s" % data})
-
-        data = dict(data)
-        unknown = unknown or self.unknown
-        data_type = self.get_data_type(data)
-
-        if data_type is None:
-            raise ValidationError(
-                {self.type_field: ["Missing data for required field."]}
-            )
-
-        try:
-            type_schema = self.type_schemas.get(data_type)
-        except TypeError as error:
-            # data_type could be unhashable
-            raise ValidationError(
-                {self.type_field: ["Invalid value: %s" % data_type]}
-            ) from error
-        if not type_schema:
-            raise ValidationError(
-                {self.type_field: ["Unsupported value: %s" % data_type]}
-            )
-
-        schema = type_schema if isinstance(type_schema, Schema) else type_schema()
-
-        schema.context.update(getattr(self, "context", {}))
-
-        return schema.load(data, many=False, partial=partial, unknown=unknown, **kwargs)
-
-    def validate(self, data, *, many=None, partial=None):
-        try:
-            self.load(data, many=many, partial=partial)
-        except ValidationError as ve:
-            return ve.messages
-        return {}

oarepo_runtime/services/schema/polymorphic.py

@@ -1,21 +0,0 @@
-from functools import cached_property
-
-import marshmallow as ma
-
-# from marshmallow_oneofschema import OneOfSchema
-from oarepo_runtime.services.schema.oneofschema import OneOfSchema
-
-
-class PolymorphicSchema(OneOfSchema):
-    type_field_remove = False
-
-    def get_obj_type(self, obj):
-        return obj[self.type_field]
-
-    @cached_property
-    def type_schemas(self):
-        ret = {}
-        for key, fld in self.fields.items():
-            if isinstance(fld, ma.fields.Nested):
-                ret[fld.attribute or key] = type(fld.schema)
-        return ret

oarepo_runtime/services/schema/rdm.py

@@ -1,146 +0,0 @@
-import re
-from functools import partial
-
-import marshmallow as ma
-from invenio_access.permissions import system_identity
-from invenio_i18n import gettext as _
-from invenio_i18n.selectors import get_locale
-from invenio_rdm_records.services.schemas.metadata import (
-    CreatorSchema,
-    record_identifiers_schemes,
-)
-from invenio_rdm_records.services.schemas.tombstone import DeletionStatusSchema
-from invenio_rdm_records.services.schemas.versions import VersionsSchema
-from invenio_records_resources.proxies import current_service_registry
-from invenio_vocabularies.contrib.awards.schema import AwardRelationSchema
-from invenio_vocabularies.contrib.funders.schema import FunderRelationSchema
-from marshmallow import fields as ma_fields
-from marshmallow import pre_load
-from marshmallow_utils.fields import (
-    IdentifierSet,
-)
-from marshmallow_utils.fields.nestedattr import NestedAttribute
-from marshmallow_utils.schemas.identifier import IdentifierSchema
-
-from .i18n import MultilingualField
-
-
-class RDMRecordMixin(ma.Schema):
-    versions = NestedAttribute(VersionsSchema, dump_only=True)
-    deletion_status = ma_fields.Nested(DeletionStatusSchema, dump_only=True)
-
-
-class MultilingualAwardSchema(AwardRelationSchema):
-    class Meta:
-        unknown = ma.RAISE
-
-    @pre_load()
-    def convert_to_multilingual(self, data, many, **kwargs):
-        if "title" in data and type(data["title"]) is str:
-            lang = get_locale()
-            data["title"] = {lang: data["title"]}
-        return data
-
-
-class FundingSchema(ma.Schema):
-    """Funding schema."""
-
-    funder = ma_fields.Nested(FunderRelationSchema, required=True)
-    award = ma_fields.Nested(MultilingualAwardSchema)
-
-
-class RecordIdentifierField(IdentifierSet):
-    def __init__(self, *args, **kwargs):
-        super().__init__(
-            ma.fields.Nested(
-                partial(IdentifierSchema, allowed_schemes=record_identifiers_schemes)
-            ),
-            *args,
-            **kwargs,
-        )
-
-
-class RelatedRecordIdentifierField(IdentifierSet):
-    def __init__(self, *args, **kwargs):
-        super().__init__(
-            ma.fields.Nested(
-                partial(IdentifierSchema, allowed_schemes=record_identifiers_schemes)
-            ),
-            *args,
-            **kwargs,
-        )
-
-
-class RDMSubjectSchema(ma.Schema):
-    """Subject ui schema."""
-
-    class Meta:
-        unknown = ma.RAISE
-
-    _id = ma.fields.String(data_key="id")
-
-    subject = MultilingualField()
-
-
-class RDMNTKCreatorsSchema(CreatorSchema):
-    """NTK version of RDM creators schema.
-
-    This version makes sure that organizations are selected from the
-    list of organizations in the system. Record will not be valid if
-    organization is not in the system.
-    """
-
-    @ma.validates_schema
-    def check_organization_or_affiliation(self, data, **kwargs):
-        """Check if organization is in the system."""
-        person_or_org = data.get("person_or_org", {})
-        if person_or_org.get("type") == "personal":
-            affiliations = data.get("affiliations", [])
-            for affiliation in affiliations:
-                if not self.from_vocabulary(affiliation):
-                    raise ma.ValidationError(
-                        _(
-                            "It is necessary to choose organization from the controlled vocabulary. "
-                            "To add organization, please go to "
-                            "https://nusl.techlib.cz/cs/migrace-nusl/navrh-novych-hesel/"
-                        ),
-                        field_name="affiliations",
-                    )
-        else:
-            # organization
-            name = person_or_org.get("name")
-            affiliations = current_service_registry.get("affiliations")
-            found = [
-                x["name"]
-                for x in affiliations.search(
-                    system_identity,
-                    q=f'name.suggest:"{escape_opensearch_query(name)}"',
-                    size=100,
-                ).hits
-            ]
-            if name not in found:
-                raise ma.ValidationError(
-                    _(
-                        "It is necessary to choose organization from the controlled vocabulary. "
-                        "To add organization, please go to "
-                        "https://nusl.techlib.cz/cs/migrace-nusl/navrh-novych-hesel/"
-                    ),
-                    field_name="person_or_org",
-                )
-        return data
-
-    def from_vocabulary(self, affiliation):
-        """Check if affiliation is from the vocabulary."""
-        if "id" not in affiliation:
-            return False
-        return True
-
-
-def escape_opensearch_query(value: str) -> str:
-    """
-    Escapes special characters in a string for safe use in OpenSearch query syntax.
-    """
-    # Escape each special character with a backslash
-    escaped = re.sub(r'([\\+\-=&|><!(){}\[\]^"~*?:/])', r"\\\1", value)
-
-    return escaped

oarepo_runtime/services/schema/rdm_ui.py

@@ -1,156 +0,0 @@
-import marshmallow as ma
-from idutils import to_url
-from oarepo_vocabularies.services.ui_schema import VocabularyI18nStrUIField
-
-from oarepo_runtime.services.schema.marshmallow import DictOnlySchema
-
-from .i18n_ui import MultilingualUIField
-
-
-class RDMIdentifierWithSchemaUISchema(ma.Schema):
-    scheme = ma.fields.String(
-        required=True,
-    )
-    identifier = ma.fields.String(required=True)
-
-    @ma.post_dump
-    def add_url(self, value, **kwargs):
-        try:
-            # ignore errors here
-            if "identifier" in value and "scheme" in value:
-                url = to_url(
-                    value["identifier"], value["scheme"].lower(), url_scheme="https"
-                )
-                if url:
-                    value["url"] = url
-        except Exception:
-            pass
-        return value
-
-
-class RDMAwardIdentifierUISchema(ma.Schema):
-    identifier = ma.fields.String()
-
-
-class RDMAwardSubjectUISchema(ma.Schema):
-    _id = ma.fields.String(data_key="id")
-
-    subject = ma.fields.String()
-
-
-class RDMAwardOrganizationUISchema(ma.Schema):
-    schema = ma.fields.String()
-
-    _id = ma.fields.String(data_key="id")
-
-    organization = ma.fields.String()
-
-
-class RDMFunderVocabularyUISchema(DictOnlySchema):
-    class Meta:
-        unknown = ma.INCLUDE
-
-    _id = ma.fields.String(data_key="id", attribute="id")
-
-    _version = ma.fields.String(data_key="@v", attribute="@v")
-
-    name = ma.fields.String()
-
-    identifiers = ma.fields.List(ma.fields.Nested(RDMIdentifierWithSchemaUISchema()))
-
-
-class RDMRoleVocabularyUISchema(DictOnlySchema):
-    class Meta:
-        unknown = ma.INCLUDE
-
-    _id = ma.fields.String(data_key="id", attribute="id")
-
-    _version = ma.fields.String(data_key="@v", attribute="@v")
-
-    title = VocabularyI18nStrUIField()
-
-
-class RDMAwardVocabularyUISchema(DictOnlySchema):
-    class Meta:
-        unknown = ma.INCLUDE
-
-    _id = ma.fields.String(data_key="id", attribute="id")
-
-    _version = ma.fields.String(data_key="@v", attribute="@v")
-
-    title = VocabularyI18nStrUIField()
-
-    number = ma.fields.String()
-
-    identifier = ma.fields.List(ma.fields.Nested(RDMAwardIdentifierUISchema()))
-
-    acronym = ma.fields.String()
-
-    program = ma.fields.String()
-
-    subjects = ma.fields.List(ma.fields.Nested(RDMAwardSubjectUISchema()))
-
-    organizations = ma.fields.List(ma.fields.Nested(RDMAwardOrganizationUISchema()))
-
-
-class RDMFundersUISchema(ma.Schema):
-    """Funding ui schema."""
-
-    class Meta:
-        unknown = ma.RAISE
-
-    funder = ma.fields.Nested(lambda: RDMFunderVocabularyUISchema())
-
-    award = ma.fields.Nested(lambda: RDMAwardVocabularyUISchema())
-
-
-class RDMPersonOrOrganizationUISchema(ma.Schema):
-    class Meta:
-        unknown = ma.INCLUDE
-
-    name = ma.fields.String()
-
-    type = ma.fields.String()
-
-    given_name = ma.fields.String()
-
-    family_name = ma.fields.String()
-
-    identifiers = ma.fields.List(ma.fields.Nested(RDMIdentifierWithSchemaUISchema()))
-
-
-class RDMAffiliationVocabularyUISchema(DictOnlySchema):
-    class Meta:
-        unknown = ma.INCLUDE
-
-    _id = ma.fields.String(data_key="id", attribute="id")
-
-    _version = ma.fields.String(data_key="@v", attribute="@v")
-
-    name = ma.fields.String()
-
-
-class RDMCreatorsUISchema(ma.Schema):
-    """Funding ui schema."""
-
-    class Meta:
-        unknown = ma.RAISE
-
-    role = ma.fields.Nested(lambda: RDMRoleVocabularyUISchema())
-
-    affiliations = ma.fields.List(
-        ma.fields.Nested(lambda: RDMAffiliationVocabularyUISchema())
-    )
-
-    person_or_org = ma.fields.Nested(RDMPersonOrOrganizationUISchema())
-
-
-class RDMSubjectUISchema(ma.Schema):
-    """Subject ui schema."""
-
-    class Meta:
-        unknown = ma.RAISE
-
-    _id = ma.fields.String(data_key="id")
-
-    subject = MultilingualUIField()