oarepo-runtime 1.5.88__py3-none-any.whl → 1.5.90__py3-none-any.whl

oarepo_runtime/services/components.py

@@ -1,17 +1,29 @@
+from __future__ import annotations
+
 import inspect
 from collections import defaultdict
+from dataclasses import dataclass, field
 from typing import Type
 
 from flask import current_app
 from invenio_accounts.models import User
+from invenio_drafts_resources.services.records.config import (
+    RecordServiceConfig as DraftsRecordServiceConfig,
+)
+from invenio_rdm_records.services.config import RDMRecordServiceConfig
 from invenio_records import Record
+from invenio_records_resources.services import FileServiceConfig
+from invenio_records_resources.services.records.config import (
+    RecordServiceConfig as RecordsRecordServiceConfig,
+)
 
-from oarepo_runtime.services.custom_fields import CustomFieldsMixin, CustomFields, InlinedCustomFields
+from oarepo_runtime.services.custom_fields import (
+    CustomFields,
+    CustomFieldsMixin,
+    InlinedCustomFields,
+)
 from oarepo_runtime.services.generators import RecordOwners
-from invenio_rdm_records.services.config import RDMRecordServiceConfig
-from invenio_drafts_resources.services.records.config import RecordServiceConfig as DraftsRecordServiceConfig
-from invenio_records_resources.services.records.config import RecordServiceConfig as RecordsRecordServiceConfig
-from invenio_records_resources.services import  FileServiceConfig
+
 try:
     from invenio_drafts_resources.services.records.uow import ParentRecordCommitOp
 except ImportError:
@@ -62,18 +74,23 @@ class DateIssuedComponent(ServiceComponent):
         if "dateIssued" not in record["metadata"]:
             record["metadata"]["dateIssued"] = datetime.today().strftime("%Y-%m-%d")
 
+
 class CFRegistry:
     def __init__(self):
         self.custom_field_names = defaultdict(list)
 
     def lookup(self, record_type: Type[Record]):
         if record_type not in self.custom_field_names:
-            for fld in inspect.getmembers(record_type, lambda x: isinstance(x, CustomFieldsMixin)):
+            for fld in inspect.getmembers(
+                record_type, lambda x: isinstance(x, CustomFieldsMixin)
+            ):
                 self.custom_field_names[record_type].append(fld[1])
         return self.custom_field_names[record_type]
 
+
 cf_registry = CFRegistry()
 
+
 class CustomFieldsComponent(ServiceComponent):
     def create(self, identity, data=None, record=None, **kwargs):
         """Create a new record."""
@@ -90,16 +107,16 @@ class CustomFieldsComponent(ServiceComponent):
             elif isinstance(cf, InlinedCustomFields):
                 config = current_app.config.get(cf.config_key, {})
                 for c in config:
-                    record[c.name] =data.get(c.name)
+                    record[c.name] = data.get(c.name)
 
-def process_service_configs(service_config):
 
+def process_service_configs(service_config, *additional_components):
     processed_components = []
     target_classes = {
         RDMRecordServiceConfig,
         DraftsRecordServiceConfig,
         RecordsRecordServiceConfig,
-        FileServiceConfig
+        FileServiceConfig,
     }
 
     for end_index, cls in enumerate(type(service_config).mro()):
@@ -110,19 +127,150 @@ def process_service_configs(service_config):
     # there are two service_config instances in the MRO (Method Resolution Order) output.
     start_index = 2 if hasattr(service_config, "build") else 1
 
-    service_configs = type(service_config).mro()[start_index:end_index + 1]
+    service_configs = type(service_config).mro()[start_index : end_index + 1]
     for config in service_configs:
-
         if hasattr(config, "build"):
             config = config.build(current_app)
 
-        if hasattr(config, 'components'):
+        if hasattr(config, "components"):
             component_property = config.components
             if isinstance(component_property, list):
                 processed_components.extend(component_property)
             elif isinstance(component_property, tuple):
-                processed_components.extend(list (component_property))
+                processed_components.extend(list(component_property))
             else:
                 raise ValueError(f"{config} component's definition is not supported")
 
-    return processed_components
+    processed_components.extend(additional_components)
+    processed_components = _sort_components(processed_components)
+    return processed_components
+
+
+@dataclass
+class ComponentPlacement:
+    """Component placement in the list of components.
+
+    This is a helper class used in the component ordering algorithm.
+    """
+
+    component: Type[ServiceComponent]
+    """Component to be ordered."""
+
+    depends_on: list[ComponentPlacement] = field(default_factory=list)
+    """List of components this one depends on.
+    
+    The components must be classes of ServiceComponent or '*' to denote
+    that this component depends on all other components and should be placed last.
+    """
+
+    affects: list[ComponentPlacement] = field(default_factory=list)
+    """List of components that depend on this one.
+    
+    This is a temporary list used for evaluation of '*' dependencies
+    but does not take part in the sorting algorithm."""
+
+    def __hash__(self) -> int:
+        return id(self.component)
+
+    def __eq__(self, other: ComponentPlacement) -> bool:
+        return self.component is other.component
+
+
+def _sort_components(components):
+    """Sort components based on their dependencies while trying to
+    keep the initial order as far as possible."""
+
+    placements: list[ComponentPlacement] = _prepare_component_placement(components)
+    placements = _propagate_dependencies(placements)
+
+    ret = []
+    while placements:
+        without_dependencies = [p for p in placements if not p.depends_on]
+        if not without_dependencies:
+            raise ValueError("Circular dependency detected in components.")
+        for p in without_dependencies:
+            ret.append(p.component)
+            placements.remove(p)
+            for p2 in placements:
+                if p in p2.depends_on:
+                    p2.depends_on.remove(p)
+    return ret
+
+
+def _matching_placements(placements, dep_class_or_factory):
+    for pl in placements:
+        pl_component = pl.component
+        if not inspect.isclass(pl_component):
+            pl_component = type(pl_component(service=object()))
+        if issubclass(pl_component, dep_class_or_factory):
+            yield pl
+
+
+def _prepare_component_placement(components) -> list[ComponentPlacement]:
+    """Convert components to ComponentPlacement instances and resolve dependencies."""
+    placements = []
+    for idx, c in enumerate(components):
+        placement = ComponentPlacement(component=c)
+        placements.append(placement)
+
+    # direct dependencies
+    for idx, placement in enumerate(placements):
+        placements_without_this = placements[:idx] + placements[idx + 1 :]
+        for dep in getattr(placement.component, "depends_on", []):
+            if dep == "*":
+                continue
+            for pl in _matching_placements(placements_without_this, dep):
+                placement.depends_on.append(pl)
+                pl.affects.append(placement)
+
+        for dep in getattr(placement.component, "affects", []):
+            if dep == "*":
+                continue
+            for pl in _matching_placements(placements_without_this, dep):
+                placement.affects.append(pl)
+                pl.depends_on.append(placement)
+
+    # star dependencies
+    for idx, placement in enumerate(placements):
+        placements_without_this = placements[:idx] + placements[idx + 1 :]
+        if "*" in getattr(placement.component, "depends_on", []):
+            for pl in placements_without_this:
+                # if this placement is not in placements that pl depends on
+                # (added via direct dependencies above), add it
+                if placement not in pl.depends_on:
+                    placement.depends_on.append(pl)
+                    pl.affects.append(placement)
+
+        if "*" in getattr(placement.component, "affects", []):
+            for pl in placements_without_this:
+                # if this placement is not in placements that pl affects
+                # (added via direct dependencies above), add it
+                if placement not in pl.affects:
+                    placement.affects.append(pl)
+                    pl.depends_on.append(placement)
+    return placements
+
+
+def _propagate_dependencies(
+    placements: list[ComponentPlacement],
+) -> list[ComponentPlacement]:
+    # now propagate dependencies
+    dependency_propagated = True
+    while dependency_propagated:
+        dependency_propagated = False
+        for placement in placements:
+            for dep in placement.depends_on:
+                for dep_of_dep in dep.depends_on:
+                    if dep_of_dep not in placement.depends_on:
+                        placement.depends_on.append(dep_of_dep)
+                        dep_of_dep.affects.append(placement)
+                        dependency_propagated = True
+
+            for dep in placement.affects:
+                for dep_of_dep in dep.affects:
+                    if dep_of_dep not in placement.affects:
+                        placement.affects.append(dep_of_dep)
+                        dep_of_dep.depends_on.append(placement)
+                        dependency_propagated = True
+
+    return placements

oarepo_runtime/services/schema/validation.py

@@ -2,6 +2,7 @@ import functools
 import re
 from datetime import datetime
 from idutils import normalize_pid
+from isbnlib import canonical, mask
 
 from marshmallow.exceptions import ValidationError
 from marshmallow_utils.fields.edtfdatestring import EDTFValidator
@@ -11,6 +12,11 @@ from invenio_i18n import gettext as _
 
 def validate_identifier(value):
     try:
+        if value["scheme"].lower() == "isbn":
+            canonical_isbn = canonical(value["identifier"])
+            value["identifier"] = mask(canonical_isbn)
+            return value["identifier"]
+
         original_identifier = (value["identifier"] or '').strip()
         normalized_identifier = normalize_pid(
             value["identifier"], value["scheme"].lower()
@@ -57,4 +63,4 @@ class CachedMultilayerEDTFValidator(EDTFValidator):
             datetime.strptime(value, "%Y-%m-%d")
             return value
         except:
-            return super().__call__(value)
+            return super().__call__(value)

{oarepo_runtime-1.5.88.dist-info → oarepo_runtime-1.5.90.dist-info}/METADATA

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

{oarepo_runtime-1.5.88.dist-info → oarepo_runtime-1.5.90.dist-info}/RECORD

@@ -73,7 +73,7 @@ oarepo_runtime/resources/file_resource.py,sha256=Ta3bFce7l0xwqkkOMOEu9mxbB8BbKj5
 oarepo_runtime/resources/json_serializer.py,sha256=82_-xQEtxKaPakv8R1oBAFbGnxskF_Ve4tcfcy4PetI,963
 oarepo_runtime/resources/localized_ui_json_serializer.py,sha256=3V9cJaG_e1PMXKVX_wKfBp1LmbeForwHyBNYdyha4uQ,1878
 oarepo_runtime/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime/services/components.py,sha256=rCdK3amTM2PAihiRFnaoN_Xkm35W-PreAPjm-gAJFww,4902
+oarepo_runtime/services/components.py,sha256=ZLGaOiaGJfKC_LNvYq4F061CP-sMG29FK4lUypY__Ws,10191
 oarepo_runtime/services/generators.py,sha256=j87HitHA_w2awsz0C5IAAJ0qjg9JMtvdO3dvh6FQyfg,250
 oarepo_runtime/services/results.py,sha256=Ap2mUJHl3V4BSduTrBWPuco0inQVq0QsuCbVhez48uY,5705
 oarepo_runtime/services/search.py,sha256=9xGTN5Yg6eTdptQ9qjO_umbacf9ooMuHYGXWYfla4-M,6227
@@ -121,7 +121,7 @@ oarepo_runtime/services/schema/oneofschema.py,sha256=GnWH4Or_G5M0NgSmCoqMI6PBrJg
 oarepo_runtime/services/schema/polymorphic.py,sha256=bAbUoTIeDBiJPYPhpLEKKZekEdkHlpqkmNxk1hN3PDw,564
 oarepo_runtime/services/schema/rdm.py,sha256=4gi44LIMWS9kWcZfEoHaJSq585qfZfMuUYM5IvL1nQo,531
 oarepo_runtime/services/schema/ui.py,sha256=xQgW-zLyZoHldGw47uVtXQj-5LexVNKTholyq4MiBZo,3777
-oarepo_runtime/services/schema/validation.py,sha256=g2lpFwgQygWdLgq5bRvLAjVqXVOJpfVJ7umDp5xEGRU,1849
+oarepo_runtime/services/schema/validation.py,sha256=VFOKSxQLHwFb7bW8BJAFXWe_iTAZFOfqOnb2Ko_Yxxc,2085
 oarepo_runtime/translations/default_translations.py,sha256=060GBlA1ghWxfeumo6NqxCCZDb-6OezOuF6pr-_GEOQ,104
 oarepo_runtime/translations/messages.pot,sha256=jyC7mRH5P9uwVVqz9ycvn-T8gcohr62x__O0sC6g2w4,1846
 oarepo_runtime/translations/cs/LC_MESSAGES/messages.mo,sha256=cSTRnVoi8DxfrXD-ImHYUmxdnNQMnxIn2yFRTObwRzI,801
@@ -135,9 +135,9 @@ tests/marshmallow_to_json/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 tests/marshmallow_to_json/test_datacite_ui_schema.py,sha256=82iLj8nW45lZOUewpWbLX3mpSkpa9lxo-vK-Qtv_1bU,48552
 tests/marshmallow_to_json/test_simple_schema.py,sha256=izZN9p0v6kovtSZ6AdxBYmK_c6ZOti2_z_wPT_zXIr0,1500
 tests/pkg_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime-1.5.88.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-1.5.88.dist-info/METADATA,sha256=FtYVZcPcE9i3_AG_61zkkHPUNueJDHR6-7da2B8nd_c,4720
-oarepo_runtime-1.5.88.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-oarepo_runtime-1.5.88.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
-oarepo_runtime-1.5.88.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
-oarepo_runtime-1.5.88.dist-info/RECORD,,
+oarepo_runtime-1.5.90.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-1.5.90.dist-info/METADATA,sha256=MjXQ_JQCvfx_q854xrRa73nGe0K-tYLLp-02yGZRwPI,4720
+oarepo_runtime-1.5.90.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+oarepo_runtime-1.5.90.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
+oarepo_runtime-1.5.90.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
+oarepo_runtime-1.5.90.dist-info/RECORD,,