oarepo-runtime 1.8.0__tar.gz → 1.9.1__tar.gz

{oarepo_runtime-1.8.0/oarepo_runtime.egg-info → oarepo_runtime-1.9.1}/PKG-INFO

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

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1}/oarepo_runtime/datastreams/types.py

@@ -155,11 +155,11 @@ class StreamEntry:
     def __str__(self):
         ret = [
             f"Entry #{self.seq}: id {self.id or 'not yet set'}, filtered: {self.filtered}, deleted: {self.deleted}",
-            f"Content:",
+            "Content:",
             textwrap.indent(
                 json.dumps(self.entry, ensure_ascii=False, indent=4), "    "
             ),
-            f"Context:",
+            "Context:",
             textwrap.indent(
                 json.dumps(self.context, ensure_ascii=False, indent=4), "    "
             ),
@@ -236,16 +236,20 @@ class DataStreamCallback:
         self.log_error_entry = log_error_entry
 
     def batch_started(self, batch):
-        log.info("Batch started: %s", batch)
+        log.info("Batch started: %s", batch.seq)
+        if log.isEnabledFor(logging.DEBUG):
+            log.debug("Content: %s", batch)
 
-    def batch_finished(self, batch):
-        log.info("Batch finished: %s", batch)
+    def batch_finished(self, batch: StreamBatch):
+        log.info("Batch finished: %s", batch.seq)
+        if log.isEnabledFor(logging.DEBUG):
+            log.debug("Content: %s", batch)
         for err in batch.errors:
-            log.error("Failed batch: %s: %s", err, batch)
+            log.error("Failed batch: %s: %s", err, batch.seq)
         if self.log_error_entry:
             for entry in batch.entries:
                 if entry.errors:
-                    log.error("Failed entry: %s", entry)
+                    log.error("Failed entry: %s in batch %s", entry, batch.seq)
 
     def reader_error(self, reader, exception):
         log.error("Reader error: %s: %s", reader, exception)

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1}/oarepo_runtime/records/systemfields/__init__.py

@@ -4,6 +4,7 @@ from .icu import (
     ICUSearchField,
     ICUSortField,
     ICUSuggestField,
+    TermIndexField,
 )
 from .mapping import MappingSystemFieldMixin, SystemFieldDumperExt
 from .selectors import (
@@ -29,4 +30,5 @@ __all__ = (
     "FirstItemSelector",
     "FilteredSelector",
     "MultiSelector",
+    "TermIndexField",
 )

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1}/oarepo_runtime/records/systemfields/icu.py

@@ -1,3 +1,4 @@
+from abc import abstractmethod, abstractproperty
 from functools import cached_property
 from typing import Dict
 
@@ -8,17 +9,16 @@ from oarepo_runtime.records.relations.lookup import lookup_key
 from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
 
 
-class ICUField(MappingSystemFieldMixin, SystemField):
+class ICUBase(MappingSystemFieldMixin, SystemField):
     """
-    A system field that acts as an opensearch "proxy" to another field.
-    It creates a top-level mapping field with the same name and copies
-    content of {another field}.language into {mapping field}.language.
-
-    The language accessor can be modified by overriding get_values method.
+    Base class for ICU system fields.
+    It provides the basic functionality for ICU fields, such as
+    getting the attribute name and handling the key.
     """
 
-    def __init__(self, *, source_field, key=None):
-        super().__init__(key)
+    def __init__(self, source_field=None, key=None):
+        super().__init__(key=key)
+        self._attr_name = key or self.__class__.__name__.lower()
         self.source_field = source_field
 
     @cached_property
@@ -51,19 +51,57 @@ class ICUField(MappingSystemFieldMixin, SystemField):
                         ret.append(l.value["value"])
         return ret
 
+    @abstractproperty
+    def mapping(self):
+        """
+        The mapping for the field. It should return a dictionary with the
+        mapping for the field, based on the current configuration of the application.
+        """
+        raise NotImplementedError("Subclasses must implement the mapping property.")
+
+    @abstractmethod
     def search_dump(self, data, record):
-        ret = {}
-        for lang in self.languages:
-            ret[lang] = self.get_values(data, lang)
-        data[self.attr_name] = ret
+        """
+        Dump custom field. This method should be implemented by subclasses
+        to provide the functionality for dumping the field data into the
+        OpenSearch data structure.
+        """
+        raise NotImplementedError("Subclasses must implement the search_dump method.")
 
     def search_load(self, data, record_cls):
+        """
+        Just remove the field from the data on load.
+        """
         data.pop(self.attr_name, None)
 
     def __get__(self, instance, owner):
         return self
 
 
+class ICUField(ICUBase):
+    """
+    A system field that acts as an opensearch "proxy" to another field.
+    It creates a top-level mapping field with the same name and copies
+    content of {another field}.language into {mapping field}.language.
+
+    The language accessor can be modified by overriding get_values method.
+    """
+
+    def __init__(self, *, source_field, key=None):
+        super().__init__(source_field=source_field, key=key)
+
+    def search_dump(self, data, record):
+        ret = {}
+        for lang in self.languages:
+            r = self.get_values(data, lang)
+            if r:
+                # if the language is not empty, add it to the result
+                # otherwise do not add it at all to safe transport
+                ret[lang] = r
+        if ret:
+            data[self.attr_name] = ret
+
+
 class ICUSortField(ICUField):
     """
     A field that adds icu sorting field
@@ -190,11 +228,15 @@ class ICUSearchAnalyzerMixin:
 
 class ICUSearchField(ICUSearchAnalyzerMixin, ICUField):
     """
-    A field that adds stemming-aware search field
+    A field that adds stemming-aware search field for multilingual data (
+        e.g. data that contains {"cs": "...", "en": "..."}
+        or [{"lang": "cs", "value": "..."}, ...]
+    )
     """
 
-    def __init__(self, source_field, key=None):
+    def __init__(self, source_field, key=None, boost=1):
         super().__init__(source_field=source_field, key=key)
+        self.boost = boost
 
     @property
     def mapping(self):
@@ -207,22 +249,22 @@ class ICUSearchField(ICUSearchAnalyzerMixin, ICUField):
                         "search",
                         {
                             "type": "text",
-                            "boost": 1,
+                            "boost": 1 * self.boost,
                             "fields": {
                                 "stemmed": {
                                     "type": "text",
                                     "analyzer": f"stemming_analyzer_{lang}",
-                                    "boost": 0.5,
+                                    "boost": 0.5 * self.boost,
                                 },
                                 "lowercase": {
                                     "type": "text",
-                                    "boost": 0.8,
+                                    "boost": 0.8 * self.boost,
                                     "analyzer": "lowercase_analyzer",
                                 },
                                 "ascii_folded": {
                                     "type": "text",
                                     "analyzer": "ascii_folding_analyzer",
-                                    "boost": 0.3,
+                                    "boost": 0.3 * self.boost,
                                 },
                             },
                         },
@@ -236,7 +278,25 @@ class ICUSearchField(ICUSearchAnalyzerMixin, ICUField):
         return super().get_values(data, language=language)
 
 
-class FulltextIndexField(ICUSearchAnalyzerMixin, ICUField):
+class SingleLanguageSearchField(ICUSearchAnalyzerMixin, ICUBase):
+    """
+    A base class for single-language search fields - that is, data contain a text
+    value in a pre-defined, single language.
+    """
+
+    def __init__(self, *, source_field, key=None, language=None, boost=1):
+        super().__init__(source_field=source_field, key=key)
+        self.language = language
+        self.boost = boost
+
+    def search_dump(self, data, record):
+        """Dump custom field."""
+        ret = self.get_values(data, language=self.language)
+        if ret:
+            data[self.attr_name] = ret
+
+
+class FulltextIndexField(SingleLanguageSearchField):
     """
     A system field that makes the field searchable in OpenSearch,
     regardless if it is indexed/analyzed, embedded in Nested or not.
@@ -250,10 +310,6 @@ class FulltextIndexField(ICUSearchAnalyzerMixin, ICUField):
     It defaults to the BABEL_DEFAULT_LOCALE if not provided.
     """
 
-    def __init__(self, *, source_field, key=None, language=None):
-        super().__init__(source_field=source_field, key=key)
-        self.language = language
-
     @property
     def mapping(self):
         language = self.language or current_app.config.get("BABEL_DEFAULT_LOCALE", "en")
@@ -263,28 +319,53 @@ class FulltextIndexField(ICUSearchAnalyzerMixin, ICUField):
         if not mapping_settings:
             mapping_settings = {
                 "type": "text",
-                "boost": 1,
+                "boost": 1 * self.boost,
                 "fields": {
                     "stemmed": {
                         "type": "text",
                         "analyzer": f"stemming_analyzer_{language}",
-                        "boost": 0.5,
+                        "boost": 0.5 * self.boost,
+                    },
+                    "lowercase": {
+                        "type": "text",
+                        "boost": 0.8 * self.boost,
+                        "analyzer": "lowercase_analyzer",
                     },
                     "ascii_folded": {
                         "type": "text",
                         "analyzer": "ascii_folding_analyzer",
-                        "boost": 0.3,
+                        "boost": 0.3 * self.boost,
                     },
                 },
             }
 
         return {self.attr_name: mapping_settings}
 
-    def search_dump(self, data, record):
-        """Dump custom field."""
-        data[self.attr_name] = self.get_values(data, language=self.language)
-
-    @classmethod
-    def search_load(cls, data, record_cls):
+    def search_load(self, data, record_cls):
         """Load custom field."""
-        data.pop(cls.attr_name, None)
+        data.pop(self.attr_name, None)
+
+
+class TermIndexField(SingleLanguageSearchField):
+    """
+    A system field that makes the field searchable in OpenSearch,
+    regardless if it is indexed/analyzed, embedded in Nested or not.
+
+    It creates a top-level mapping field and copies
+    content of {source_field} into it. It also provides the correct mapping
+    for the field based on the current configuration of the application.
+
+    Unlike the ICU, this field is a single-language and the language should
+    be provided when initializing the field.
+    It defaults to the BABEL_DEFAULT_LOCALE if not provided.
+    """
+
+    @property
+    def mapping(self):
+        mapping_settings = {
+            "type": "keyword",
+            "boost": 1 * self.boost,
+            "ignore_above": 256,
+        }
+
+        return {self.attr_name: mapping_settings}

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1}/oarepo_runtime/records/systemfields/mapping.py

@@ -16,12 +16,10 @@ class MappingSystemFieldMixin:
     def dynamic_templates(self):
         return []
 
-    @classmethod
-    def search_dump(cls, data, record):
+    def search_dump(self, data, record):
         """Dump custom field."""
 
-    @classmethod
-    def search_load(cls, data, record_cls):
+    def search_load(self, data, record_cls):
         """Load custom field."""
 
 

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1/oarepo_runtime.egg-info}/PKG-INFO

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

{oarepo_runtime-1.8.0 → oarepo_runtime-1.9.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.8.0
+version = 1.9.1
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md