oarepo-runtime 1.3.19__tar.gz → 1.3.21__tar.gz

{oarepo-runtime-1.3.19/oarepo_runtime.egg-info → oarepo-runtime-1.3.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.3.19
+Version: 1.3.21
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 Provides-Extra: devs

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/cli/validate.py

@@ -3,9 +3,9 @@ import sys
 import click
 import yaml
 from flask.cli import with_appcontext
+from invenio_db import db
 from invenio_records import Record
 from invenio_records_resources.proxies import current_service_registry
-from invenio_db import db
 
 from .base import oarepo
 
@@ -17,12 +17,14 @@ except ImportError:
 import sys
 from io import StringIO
 
+
 class CheckOk(Exception):
     pass
 
+
 @oarepo.command(
     help="Validate a record. Takes one or two parameters - service name as "
-         "the first one, file name or stdin with record data as the second"
+    "the first one, file name or stdin with record data as the second"
 )
 @click.argument("service-name")
 @click.argument("record-file", required=False)
@@ -64,7 +66,6 @@ def validate(service_name, record_file, verbose):
             raise CheckOk()
     except CheckOk:
         click.secho("Pre-commit hook has been successful", fg="green")
-        pass
 
     if verbose:
         yaml.safe_dump(loaded, sys.stdout, allow_unicode=True)

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/config/service.py

@@ -1,7 +1,8 @@
-from flask import current_app
 import inspect
 from functools import cached_property
 
+from flask import current_app
+
 
 class PermissionsPresetsConfigMixin:
     components = tuple()
@@ -16,7 +17,7 @@ class PermissionsPresetsConfigMixin:
         permissions = {}
         for preset_class in presets:
             for permission_name, permission_needs in inspect.getmembers(preset_class):
-                if not permission_name.startswith('can_'):
+                if not permission_name.startswith("can_"):
                     continue
                 if not isinstance(permission_needs, (list, tuple)):
                     continue

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/datastreams/cli.py

@@ -1,3 +1,5 @@
+from pprint import pprint
+
 import click
 from flask import current_app
 from flask.cli import with_appcontext
@@ -20,8 +22,15 @@ def fixtures():
 @click.option("--include", multiple=True)
 @click.option("--exclude", multiple=True)
 @click.option("--system-fixtures/--no-system-fixtures", default=True, is_flag=True)
+@click.option("--show-error-entry/--hide-error-entry", is_flag=True)
 @with_appcontext
-def load(fixture_dir=None, include=None, exclude=None, system_fixtures=None):
+def load(
+    fixture_dir=None,
+    include=None,
+    exclude=None,
+    system_fixtures=None,
+    show_error_entry=False,
+):
     """Loads fixtures"""
     with current_app.wsgi_app.mounts["/api"].app_context():
         results: FixturesResult = load_fixtures(
@@ -30,7 +39,7 @@ def load(fixture_dir=None, include=None, exclude=None, system_fixtures=None):
             _make_list(exclude),
             system_fixtures=system_fixtures,
         )
-        _show_stats(results, "Load fixtures")
+        _show_stats(results, "Load fixtures", show_error_entry=show_error_entry)
 
 
 @fixtures.command()
@@ -51,7 +60,7 @@ def _make_list(lst):
     ]
 
 
-def _show_stats(results: FixturesResult, title: str):
+def _show_stats(results: FixturesResult, title: str, show_error_entry=False):
     print(f"{title} stats:")
     print(f"    ok records: {results.ok_count}")
     print(f"    failed records: {results.failed_count}")
@@ -64,4 +73,9 @@ def _show_stats(results: FixturesResult, title: str):
         )
         if r.failed_entries:
             for fe in r.failed_entries:
-                print(f"    {fixture} failure: {fe.errors} in {fe.entry}")
+                print(f"======== {fixture} {fe.entry.get('id', '')}")
+                if show_error_entry:
+                    pprint(fe.entry)
+                for err in fe.errors:
+                    print(err.type)
+                    print(err.message)

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/datastreams/datastreams.py

@@ -20,11 +20,19 @@ class StreamEntryError:
     info: str
 
     @classmethod
-    def from_exception(cls, exc: Exception, limit=5):
+    def from_exception(cls, exc: Exception, limit=5, message=None):
         # can not use format_exception here as the signature is different for python 3.9 and python 3.10
         stack = traceback.format_exc(limit=limit)
+        if message:
+            formatted_exception = message
+        elif hasattr(exc, "format_exception"):
+            formatted_exception = exc.format_exception()
+        else:
+            formatted_exception = str(exc)
         return cls(
-            type=getattr(exc, "type", type(exc).__name__), message=str(exc), info=stack
+            type=getattr(exc, "type", type(exc).__name__),
+            message=formatted_exception,
+            info=stack,
         )
 
     @property
@@ -141,9 +149,11 @@ class DataStream(AbstractDataStream):
             written_entry = self.write(transformed_entry)
             if written_entry.errors:
                 self._error_callback(written_entry)
+                _failed += 1
+                failed_entries.append(written_entry)
             else:
                 self._success_callback(written_entry)
-            _written += 1
+                _written += 1
 
         return DataStreamResult(
             ok_count=_written,
@@ -182,7 +192,6 @@ class DataStream(AbstractDataStream):
             try:
                 writer.write(stream_entry)
             except WriterError as err:
-                log.error("Error in writer: %s: %s", err, repr(stream_entry.entry))
                 stream_entry.errors.append(StreamEntryError.from_exception(err))
             except Exception as err:
                 log.error(

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/datastreams/writers/service.py

@@ -4,8 +4,9 @@ from invenio_records.systemfields.relations.errors import InvalidRelationValue
 from invenio_records_resources.proxies import current_service_registry
 from marshmallow import ValidationError
 
-from ..errors import WriterError
+from ..datastreams import StreamEntryError
 from . import BaseWriter, StreamEntry
+from .validation_errors import format_validation_error
 
 
 class ServiceWriter(BaseWriter):
@@ -58,12 +59,17 @@ class ServiceWriter(BaseWriter):
             stream_entry.entry = entry.data
 
         except ValidationError as err:
-            raise WriterError([{"ValidationError": err.messages}]) from err
+            stream_entry.errors.append(
+                StreamEntryError.from_exception(
+                    err, message=format_validation_error(err.messages)
+                )
+            )
         except InvalidRelationValue as err:
-            # TODO: Check if we can get the error message easier
-            raise WriterError([{"InvalidRelationValue": err.args[0]}]) from err
+            stream_entry.errors.append(
+                StreamEntryError.from_exception(err, message=err.args[0])
+            )
         except Exception as err:
-            raise WriterError([{"Unknown error": str(err)}]) from err
+            stream_entry.errors.append(StreamEntryError.from_exception(err))
 
     def try_update(self, entry_id, stream_entry, **service_kwargs):
         if entry_id:

oarepo-runtime-1.3.21/oarepo_runtime/datastreams/writers/validation_errors.py

@@ -0,0 +1,20 @@
+def format_validation_error(err_messages):
+    msg = {}
+    for err, path in flatten_errors(err_messages, ""):
+        if path.endswith("._schema") and err == "Unknown field.":
+            continue
+        path = path.replace(".value.", ".")
+        msg[path] = err
+    return msg
+
+
+def flatten_errors(err_data, path):
+    if isinstance(err_data, (list, tuple)):
+        for err in err_data:
+            yield from flatten_errors(err, path)
+    elif isinstance(err_data, dict):
+        for k, v in err_data.items():
+            subpath = f"{path}.{k}" if path else k
+            yield from flatten_errors(v, subpath)
+    else:
+        yield str(err_data), path

oarepo-runtime-1.3.21/oarepo_runtime/drafts/systemfields/has_draftcheck.py

@@ -0,0 +1,47 @@
+from invenio_records.dictutils import dict_set
+from invenio_records.systemfields import SystemField
+from sqlalchemy.orm.exc import NoResultFound
+
+from oarepo_runtime.cf import CustomFieldsMixin
+
+
+# taken from https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/records/systemfields/has_draftcheck.py
+class HasDraftCheckField(CustomFieldsMixin, SystemField):
+    """PID status field which checks against an expected status."""
+
+    def __init__(self, draft_cls=None, key=None, **kwargs):
+        """Initialize the PIDField.
+
+        It stores the `record.has_draft` value in the secondary storage
+        system's record or defaults to `False` if the `draft_cls` is not passed
+        e.g Draft records.
+
+        :param key: Attribute name of the HasDraftCheckField.
+        :param draft_cls: The draft class to use for querying.
+        """
+        super().__init__(key=key, **kwargs)
+        self.draft_cls = draft_cls
+
+    #
+    # Data descriptor methods (i.e. attribute access)
+    #
+    def __get__(self, record, owner=None):
+        if record is None:
+            return self  # returns the field itself.
+
+        # If not draft_cls is passed return False
+        if self.draft_cls is None:
+            return False
+
+        try:
+            self.draft_cls.get_record(record.id)
+            return True
+        except NoResultFound:
+            return False
+
+    def pre_dump(self, record, data, **kwargs):
+        dict_set(data, self.key, record.has_draft)
+    """
+    def post_load(self, record, data, **kwargs):
+        record.pop(self.key, None)
+    """

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/ext.py

@@ -40,3 +40,6 @@ class OARepoRuntime(object):
 
             elif k.startswith("DATASTREAMS_"):
                 app.config.setdefault(k, getattr(ext_config, k))
+
+            elif k == "HAS_DRAFT_CUSTOM_FIELD":
+                app.config.setdefault(k, getattr(ext_config, k))

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/ext_config.py

@@ -11,6 +11,7 @@ from oarepo_runtime.datastreams.readers.service import ServiceReader
 from oarepo_runtime.datastreams.readers.yaml import YamlReader
 from oarepo_runtime.datastreams.writers.service import ServiceWriter
 from oarepo_runtime.datastreams.writers.yaml import YamlWriter
+from invenio_records_resources.services.custom_fields import BooleanCF
 
 OAREPO_PERMISSIONS_PRESETS = {
     "read_only": ReadOnlyPermissionPolicy,
@@ -53,3 +54,5 @@ DATASTREAMS_TRANSFORMERS = {}
 DEFAULT_DATASTREAMS_EXCLUDES = []
 
 DATASTREAMS_CONFIG_GENERATOR = default_config_generator
+
+HAS_DRAFT_CUSTOM_FIELD = [BooleanCF("has_draft")]

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.3.19
+Version: 1.3.21
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 Provides-Extra: devs

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime.egg-info/SOURCES.txt

@@ -43,7 +43,11 @@ oarepo_runtime/datastreams/readers/service.py
 oarepo_runtime/datastreams/readers/yaml.py
 oarepo_runtime/datastreams/writers/__init__.py
 oarepo_runtime/datastreams/writers/service.py
+oarepo_runtime/datastreams/writers/validation_errors.py
 oarepo_runtime/datastreams/writers/yaml.py
+oarepo_runtime/drafts/__init__.py
+oarepo_runtime/drafts/systemfields/__init__.py
+oarepo_runtime/drafts/systemfields/has_draftcheck.py
 oarepo_runtime/expansions/__init__.py
 oarepo_runtime/expansions/expandable_fields.py
 oarepo_runtime/expansions/service.py

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime.egg-info/requires.txt

@@ -21,3 +21,5 @@ invenio-app
 invenio-search[opensearch2]
 oarepo<12,>=11.0
 uritemplate>=4.1.1
+oarepo-model-builder
+oarepo-model-builder-tests

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.3.19
+version = 1.3.21
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md
@@ -33,6 +33,8 @@ tests =
 	invenio-search[opensearch2]
 	oarepo>=11.0,<12
 	uritemplate>=4.1.1
+	oarepo-model-builder
+	oarepo-model-builder-tests
 
 [options.package_data]
 * = *.json, *.rst, *.md, *.json5, *.jinja2

{oarepo-runtime-1.3.19 → oarepo-runtime-1.3.21}/oarepo_runtime/facets/max_facet.py

@@ -1,5 +1,5 @@
-from opensearch_dsl import Facet
 from invenio_records_resources.services.records.facets.facets import LabelledFacetMixin
+from opensearch_dsl import Facet
 
 
 class MaxFacet(LabelledFacetMixin, Facet):