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

oarepo_runtime/services/schema/i18n_ui.py

@@ -1,4 +1,23 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Functionality for handling multilingual UI schemas using Marshmallow.
+
+It includes dynamic schema generation based on
+the provided language and value names, as well as specialized fields for
+working with multilingual data and localized user interfaces.
+"""
+
+from __future__ import annotations
+
 from functools import lru_cache
+from typing import Any
 
 from invenio_base.utils import obj_or_import_string
 from marshmallow import Schema, fields
@@ -6,9 +25,20 @@ from marshmallow import Schema, fields
 
 @lru_cache
 def get_i18n_ui_schema(
-    lang_name, value_name, value_field="marshmallow_utils.fields.SanitizedHTML"
-):
+    lang_name: str,
+    value_name: str,
+    value_field: str = "marshmallow_utils.fields.SanitizedHTML",
+) -> type[Schema]:
+    """Dynamically creates and returns I18n Schema class.
+
+    Add custom serialization logic based on the provided `lang_name` and `value_name`.
+    """
     value_field_class = obj_or_import_string(value_field)
+    if value_field_class is None:
+        raise ValueError(
+            f"Invalid value field class provided: '{value_field}'. "
+            "Expected a valid import string for a Marshmallow field class."
+        )
     return type(
         f"I18nUISchema_{lang_name}_{value_name}",
         (Schema,),
@@ -20,12 +50,13 @@ def get_i18n_ui_schema(
 
 
 def MultilingualUIField(  # noqa NOSONAR
-    *args,
-    lang_name="lang",
-    value_name="value",
-    value_field="marshmallow_utils.fields.SanitizedHTML",
-    **kwargs,
+    *args: Any,
+    lang_name: str = "lang",
+    value_name: str = "value",
+    value_field: str = "marshmallow_utils.fields.SanitizedHTML",
+    **kwargs: Any,
 ):
+    _ = args
     return fields.List(
         fields.Nested(get_i18n_ui_schema(lang_name, value_name, value_field)),
         **kwargs,
@@ -33,12 +64,12 @@ def MultilingualUIField(  # noqa NOSONAR
 
 
 def I18nStrUIField(  # noqa NOSONAR
-    *args,
-    lang_name="lang",
-    value_name="value",
-    value_field="marshmallow_utils.fields.SanitizedHTML",
-    **kwargs,
-):
+    *args: Any,
+    lang_name: str = "lang",
+    value_name: str = "value",
+    value_field: str = "marshmallow_utils.fields.SanitizedHTML",
+    **kwargs: Any,
+) -> fields.Field:
     return fields.Nested(
         get_i18n_ui_schema(lang_name, value_name, value_field),
         *args,
@@ -47,16 +78,22 @@ def I18nStrUIField(  # noqa NOSONAR
 
 
 @lru_cache
-def get_i18n_localized_ui_schema(lang_name, value_name):
+def get_i18n_localized_ui_schema(lang_name: str, value_name: str) -> type[Schema]:
+    """Dynamically creates and returns Localized I18n Schema class.
+
+    Add custom serialization logic based on the provided `lang_name` and `value_name`.
+    """
+
     class I18nLocalizedUISchema(Schema):
-        def _serialize(self, value, attr=None, obj=None, **kwargs):
-            if not value:
+        def _serialize(self, obj: Any, *, many: bool | None = None) -> Any:
+            _ = many
+            if not obj:
                 return None
             language = self.context["locale"].language
-            for v in value:
+            for v in obj:
                 if language == v[lang_name]:
                     return v[value_name]
-            return next(iter(value))[value_name]
+            return next(iter(obj))[value_name]
 
     # inherit to get a nice name for debugging
     return type(
@@ -67,16 +104,16 @@ def get_i18n_localized_ui_schema(lang_name, value_name):
 
 
 def MultilingualLocalizedUIField(  # noqa NOSONAR
-    *args, lang_name="lang", value_name="value", **kwargs
-):
-    return fields.Nested(get_i18n_localized_ui_schema(lang_name, value_name), **kwargs)
+    *args: Any, lang_name: str = "lang", value_name: str = "value", **kwargs: Any
+) -> fields.Field:
+    return fields.Nested(get_i18n_localized_ui_schema(lang_name, value_name), *args, **kwargs)
 
 
 def I18nStrLocalizedUIField(  # noqa NOSONAR
-    *args, lang_name="lang", value_name="value", **kwargs
-):
+    *args: Any, lang_name: str = "lang", value_name: str = "value", **kwargs: Any
+) -> fields.Field:
+    _ = args
     return fields.Nested(
         get_i18n_ui_schema(lang_name, value_name),
-        *args,
         **kwargs,
     )

{oarepo_runtime-1.10.2.dist-info → oarepo_runtime-2.0.0.dev3.dist-info}/METADATA

@@ -1,29 +1,17 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 1.10.2
+Version: 2.0.0.dev3
 Summary: A set of runtime extensions of Invenio repository
-Description-Content-Type: text/markdown
+License-Expression: MIT
 License-File: LICENSE
-Requires-Dist: marshmallow
-Requires-Dist: langcodes
-Requires-Dist: pyyaml
-Requires-Dist: openpyxl
-Requires-Dist: flask-babelex
-Requires-Dist: deepmerge
-Requires-Dist: tqdm
-Requires-Dist: deprecated
-Requires-Dist: idutils
+Requires-Python: <3.14,>=3.13
+Requires-Dist: langcodes>=3.5.0
+Requires-Dist: oarepo[rdm,tests]<14,>=13
 Provides-Extra: dev
-Requires-Dist: pytest>=7.1.2; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: autoflake; extra == "dev"
-Requires-Dist: oarepo-tools; extra == "dev"
+Requires-Dist: pytest>=7.1.2; extra == 'dev'
 Provides-Extra: tests
-Requires-Dist: pytest>=7.1.2; extra == "tests"
-Requires-Dist: pytest-oarepo; extra == "tests"
-Requires-Dist: psutil; extra == "tests"
-Dynamic: license-file
+Requires-Dist: pytest>=7.1.2; extra == 'tests'
+Description-Content-Type: text/markdown
 
 # OARepo runtime
 
@@ -172,4 +160,4 @@ Will print/write to file a json with the following format:
 ```
 ```json
 
-```
+```

oarepo_runtime-2.0.0.dev3.dist-info/RECORD

@@ -0,0 +1,30 @@
+oarepo_runtime/__init__.py,sha256=hLYRfE2IAzqCkcxlBoCopCZceljM89PTrpiN7k5FHv8,685
+oarepo_runtime/api.py,sha256=h3iwvDtL1AFYOQqKd6HJj1cnbxM_gy1IWt4gFcSzzSc,3826
+oarepo_runtime/config.py,sha256=auPBzCMXIcYdA1Tee5srMtfu0D5lDd38sn4BO5wGVJ4,2540
+oarepo_runtime/ext.py,sha256=AMb5pMnCSbqIpPyP99YUKlf9vopz_b2ZW-RnvfsEVlk,3254
+oarepo_runtime/proxies.py,sha256=PXaRiBh5qs5-h8M81cJOgtqypFQcYUSjiSn2TLSujRw,648
+oarepo_runtime/cli/__init__.py,sha256=iPs1a4blP7750rwEXobzK3YHgsfGxoVTZxwWMslAlTY,350
+oarepo_runtime/cli/search.py,sha256=yqYHZauXsDBPpN4odYsPOWNQ9xWmAofQ407EAyqx6CY,1137
+oarepo_runtime/records/__init__.py,sha256=AbWzmVCY7MhrpdEeI0e3lKzeugPMUSo8T08-NBVeig4,339
+oarepo_runtime/records/drafts.py,sha256=CS-dUkrylNwscgBGfDyhwGBRCzwsyT6AA3Mhu40ShbY,1607
+oarepo_runtime/records/mapping.py,sha256=SJbSzerT1645a93-3-Fgz_i3anzFNlrZqbjjwW2ctKs,2660
+oarepo_runtime/records/pid_providers.py,sha256=pVXVeYmAsXy-IEdM2zHZ7UWkAnzXg1gtssfLc9QZbPA,1717
+oarepo_runtime/records/systemfields/__init__.py,sha256=g-u408qyNnsbUTpDtVVwlcyiJaO68GTjDN0W9rXs9pk,524
+oarepo_runtime/records/systemfields/mapping.py,sha256=66OQavKewJEUMkghymOxvskIO0LUSP2E-MbHryeT5Nk,1968
+oarepo_runtime/records/systemfields/publication_status.py,sha256=vYIwueI37Auh84IptSxeF9KYC32EGmBe3-Rk1DWXMF8,1957
+oarepo_runtime/services/__init__.py,sha256=OGtBgEeaDTyk2RPDNXuKbU9_7egFBZr42SM0gN5FrF4,341
+oarepo_runtime/services/results.py,sha256=fk-Enx_LwZLbw81yZ7CXVTku86vd3_fjprnb8l5sFHk,6657
+oarepo_runtime/services/config/__init__.py,sha256=SX1kfIGk8HkohdLQrNpRQUTltksEyDcCa-kFXxrX4e8,711
+oarepo_runtime/services/config/link_conditions.py,sha256=raqf4yaBNLqNYgBxVNblo8MRJneVIFkwVNW7IW3AVYI,4309
+oarepo_runtime/services/config/permissions.py,sha256=x5k61LGnpXyJfXVoCTq2tTVTtPckmBcBtcBJx4UN9EA,3056
+oarepo_runtime/services/records/__init__.py,sha256=c0n4vcMcJhSUWsKz0iyV4TTlGG8oLlJp0YEN0QGCZ8U,428
+oarepo_runtime/services/records/links.py,sha256=lqvnXabquL4DqWV93cdUYNUVYHx7T5Q0EXXuWAHM33A,1078
+oarepo_runtime/services/records/mapping.py,sha256=y3oeToKEnaRYpMV3q2-2cXNzyzyL3XXGvY26BifybpE,1332
+oarepo_runtime/services/schema/__init__.py,sha256=jgAPI_uKC6Ug4KQWnwQVg3-aNaw-eHja323AUFo5ELo,351
+oarepo_runtime/services/schema/i18n.py,sha256=9D1zOQaPKAnYzejB0vO-m2BJYnam0N0Lrq4jID7twfE,3174
+oarepo_runtime/services/schema/i18n_ui.py,sha256=DbusphhGDeaobTt4nuwNgKZ6Houlu4Sv3SuMGkdjRRY,3582
+oarepo_runtime-2.0.0.dev3.dist-info/METADATA,sha256=nLtfS-x8LURACObTJYTyGeXIzHMQ9jtSzfg_l145cHo,4430
+oarepo_runtime-2.0.0.dev3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oarepo_runtime-2.0.0.dev3.dist-info/entry_points.txt,sha256=7HqK5jumIgDVJa7ifjPKizginfIm5_R_qUVKPf_Yq-c,145
+oarepo_runtime-2.0.0.dev3.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-2.0.0.dev3.dist-info/RECORD,,

{oarepo_runtime-1.10.2.dist-info → oarepo_runtime-2.0.0.dev3.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

oarepo_runtime-2.0.0.dev3.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[invenio_base.api_apps]
+oarepo_runtime = oarepo_runtime.ext:OARepoRuntime
+
+[invenio_base.apps]
+oarepo_runtime = oarepo_runtime.ext:OARepoRuntime

oarepo_runtime/cli/assets.py

@@ -1,145 +0,0 @@
-import json
-import os
-import re
-from pathlib import Path
-
-import click
-from flask import current_app
-from flask.cli import with_appcontext
-from flask_webpackext import current_webpack
-from importlib_metadata import entry_points
-
-from .base import oarepo
-
-
-@oarepo.group()
-def assets():
-    "OARepo asset addons"
-
-
-@assets.command()
-@click.argument("output_file")
-@click.option("--repository-dir")
-@click.option("--assets-dir", default=".assets")
-@with_appcontext
-def collect(output_file, repository_dir, assets_dir):
-    aliases, asset_dirs, generated_paths = enumerate_assets()
-
-    app_and_blueprints = [current_app] + list(current_app.blueprints.values())
-
-    static_deps = []
-    instance_path = current_app.instance_path
-    if instance_path[-1] != "/":
-        instance_path += "/"
-
-    for bp in app_and_blueprints:
-        if (
-            bp.has_static_folder
-            and os.path.isdir(bp.static_folder)
-            and not bp.static_folder.startswith(instance_path)
-        ):
-            static_deps.append(bp.static_folder)
-
-    root_aliases = {}
-    asset_paths = [Path(x) for x in asset_dirs]
-    for alias, path in aliases.items():
-        for pth in asset_paths:
-            possible_path = pth / path
-            if possible_path.exists():
-                try:
-                    relative_path = str(
-                        possible_path.relative_to(repository_dir or os.getcwd())
-                    )
-                    root_aliases[alias] = "./" + relative_path
-                except ValueError:
-                    root_aliases[alias] = str(Path(assets_dir) / path)
-
-    with open(output_file, "w") as f:
-        json.dump(
-            {
-                "assets": asset_dirs,
-                "static": static_deps,
-                "@aliases": aliases,
-                "@root_aliases": root_aliases,
-                "generated": generated_paths,
-            },
-            f,
-            indent=4,
-            ensure_ascii=False,
-        )
-
-
-def enumerate_assets():
-    asset_dirs = []
-    generated_paths = []
-    aliases = {}
-    themes = current_app.config["APP_THEME"] or ["semantic-ui"]
-    project = current_webpack.project
-    if hasattr(project, 'generated_paths'):
-        generated_paths += project.generated_paths
-
-    for ep in entry_points(group="invenio_assets.webpack"):
-        webpack = ep.load()
-        for wp_theme_name, wp_theme in webpack.themes.items():
-            if wp_theme_name in themes:
-                asset_dirs.append(wp_theme.path)
-                if hasattr(wp_theme, "generated_paths"):
-                    generated_paths += list(set(wp_theme.generated_paths) - set(generated_paths))
-                aliases.update(wp_theme.aliases)
-    return aliases, asset_dirs, generated_paths
-
-
-COMPONENT_LIST_RE = re.compile(
-    r"""
-^
-\s*
-&        # start of import statement & { import "blah"; }
-\s*
-{    
-\s*
-(
-    @import\s+["'](.*?)["']
-    \s*
-    ;
-)+
-\s*
-}""",
-    re.MULTILINE | re.DOTALL | re.VERBOSE,
-)
-
-COMPONENT_RE = re.compile(
-    r"""
-\s*
-@import\s+["'](.*?)["']
-\s*
-;
-\s*
-""",
-    re.MULTILINE | re.DOTALL | re.VERBOSE,
-)
-
-
-
-@assets.command(name="less-components")
-@click.argument("output_file", default="-")
-@with_appcontext
-def less_components(output_file):
-    aliases, asset_dirs, _ = enumerate_assets()
-    asset_dirs = [Path(x) for x in asset_dirs]
-    less_component_files = []
-    for asset_dir in asset_dirs:
-        less_dir = asset_dir / "less"
-        if less_dir.exists():
-            for f in less_dir.glob("**/custom-components.less"):
-                less_component_files.append(f)
-    components = set()
-    for cmp_file in less_component_files:
-        for component_list in COMPONENT_LIST_RE.findall(cmp_file.read_text()):
-            for s in COMPONENT_RE.findall(component_list[0]):
-                components.add(Path(s).stem)
-    data = {"components": list(sorted(components))}
-    if output_file == "-":
-        print(json.dumps(data, indent=4, ensure_ascii=False))
-    else:
-        with open(output_file, "w") as f:
-            json.dump(data, f, indent=4, ensure_ascii=False)

oarepo_runtime/cli/base.py

@@ -1,25 +0,0 @@
-import json
-
-import click
-import importlib_metadata
-
-
-@click.group()
-def oarepo():
-    """OARepo commands."""
-
-
-def as_command(group, name, *args):
-    args = [group.command(name=name), *args]
-    actual = args[-1]
-    for arg in reversed(args[:-1]):
-        actual = arg(actual)
-    return actual
-
-
-@oarepo.command(name="version")
-def get_version():
-    versions = {}
-    for distro in importlib_metadata.distributions():
-        versions[distro.metadata["Name"]] = distro.version
-    print(json.dumps(versions, ensure_ascii=False, indent=4))

oarepo_runtime/cli/cf.py

@@ -1,15 +0,0 @@
-from flask.cli import with_appcontext
-
-from oarepo_runtime.cli import oarepo
-from oarepo_runtime.services.custom_fields.mappings import prepare_cf_indices
-
-
-@oarepo.group()
-def cf():
-    """Custom fields commands."""
-
-
-@cf.command(name="init", help="Prepare custom fields in indices")
-@with_appcontext
-def init():
-    prepare_cf_indices()

oarepo_runtime/cli/check.py

@@ -1,167 +0,0 @@
-import json
-import random
-import traceback
-
-import click
-import kombu.exceptions
-import opensearchpy
-import redis
-from flask import current_app
-from flask.cli import with_appcontext
-from invenio_db import db
-from invenio_files_rest.models import Location
-from invenio_pidstore.models import PersistentIdentifier
-from invenio_records_resources.proxies import current_service_registry
-from opensearchpy import TransportError
-
-from .base import oarepo
-
-
-@oarepo.command(name="check")
-@click.argument("output_file", default="-")
-@with_appcontext
-def check(output_file):
-    status = {}
-    status["db"] = check_database()
-    status["opensearch"] = check_opensearch()
-    status["files"] = check_files()
-    status["mq"] = check_message_queue()
-    status["cache"] = check_cache()
-    if output_file == "-":
-        print(
-            json.dumps(status, indent=4, ensure_ascii=False, default=lambda x: str(x))
-        )
-    else:
-        with open(output_file, "w") as f:
-            json.dump(status, f, ensure_ascii=False, default=lambda x: str(x))
-
-
-def check_database():
-    if not has_database_connection():
-        return "connection_error"
-    try:
-        db.session.begin()
-        try:
-            PersistentIdentifier.query.all()[:1]
-        except:
-            return "not_initialized"
-        alembic = current_app.extensions["invenio-db"].alembic
-        context = alembic.migration_context
-        db_heads = set(context.get_current_heads())
-        source_heads = [x.revision for x in alembic.current()]
-        for h in source_heads:
-            if h not in db_heads:
-                return "migration_pending"
-        return "ok"
-    finally:
-        db.session.rollback()
-
-
-def has_database_connection():
-    try:
-        db.session.begin()
-        db.session.execute("SELECT 1")
-        return True
-    except:
-        return False
-    finally:
-        db.session.rollback()
-
-
-def check_opensearch():
-    services = current_service_registry._services.keys()
-    checked_indexers = set()
-    for service_id in services:
-        service = current_service_registry.get(service_id)
-        record_class = getattr(service.config, "record_cls", None)
-        if not record_class:  # files??
-            continue
-        indexer = getattr(service, "indexer", None)
-        if not indexer:
-            continue
-        if id(indexer) not in checked_indexers:
-            checked_indexers.add(id(indexer))
-            try:
-                indexer.client.indices.exists("test")
-            except opensearchpy.exceptions.ConnectionError:
-                return "connection_error"
-
-
-        try:
-            index = indexer._prepare_index(indexer.record_to_index(record_class))
-        except AttributeError:
-            print(f"Warning: can not get index name for record class {record_class}")
-            continue
-
-        try:
-            service.indexer.client.indices.get(index=index)
-        except TransportError:
-            return f"index_missing:{index}"
-    return "ok"
-
-
-def check_files():
-    if not has_database_connection():
-        return "db_connection_error"
-
-    try:
-        db.session.begin()
-        # check that there is the default location and that is readable
-        default_location = Location.get_default()
-        if not default_location:
-            return "default_location_missing"
-    except:  # NOSONAR - we are not interested what the exception is
-        return "db_error"
-    finally:
-        db.session.rollback()
-
-    try:
-        import s3fs
-    except ImportError:
-        return f"s3_support_not_installed"
-
-    try:
-        info = current_app.extensions["invenio-s3"].init_s3fs_info
-        fs = s3fs.S3FileSystem(default_block_size=4096, **info)
-        fs.ls(default_location.uri.replace("s3://", ""))
-    except:  # NOSONAR - we are not interested what the exception is
-        return f"bucket_does_not_exist:{default_location.uri}"
-
-    return "ok"
-
-
-def check_message_queue():
-    try:
-        from celery import current_app
-
-        current_app.control.inspect().active()
-        return "ok"
-    except kombu.exceptions.OperationalError as e:
-        if isinstance(e.__cause__, ConnectionRefusedError):
-            return "connection_error"
-        return "mq_error"
-    except:  # NOSONAR - we are not interested what the exception is
-        return "mq_error"
-
-
-def check_cache():
-    try:
-        from invenio_cache.proxies import current_cache
-
-        rnd = str(
-            random.randint(0, 10000)  # NOSONAR - this is not a cryptographic random
-        )
-        # it is here just to make sure that what we put to the cache is what we get back
-
-        current_cache.set("oarepo_check", rnd)
-        if current_cache.get("oarepo_check") == rnd:
-            return "ok"
-        else:
-            return "cache_error"
-    except redis.exceptions.ConnectionError as e:
-        if isinstance(e.__cause__, ConnectionRefusedError):
-            return "connection_error"
-        return "cache_exception"
-    except:  # NOSONAR - we are not interested what the exception is
-        traceback.print_exc()
-        return "cache_exception"

oarepo_runtime/cli/configuration.py

@@ -1,51 +0,0 @@
-import json
-from collections.abc import Mapping, Sequence, Set
-
-import click
-from flask import current_app
-from flask.cli import with_appcontext
-from werkzeug.local import LocalProxy
-
-from .base import oarepo
-
-def remove_lazy_objects(obj):
-    if isinstance(obj, Sequence):
-        if isinstance(obj, list):
-            return [remove_lazy_objects(item) for item in obj if not isinstance(item, LocalProxy)]
-        elif isinstance(obj, tuple):
-            return tuple(remove_lazy_objects(item) for item in obj if not isinstance(item, LocalProxy))
-        elif not isinstance(obj, LocalProxy):
-            return obj # strings, bytes, bytesarray etc.
-    elif isinstance(obj, Set):
-        if isinstance(obj, frozenset):
-            return frozenset(remove_lazy_objects(item) for item in obj if not isinstance(item, LocalProxy))
-        return {remove_lazy_objects(item) for item in obj if not isinstance(item, LocalProxy)}
-    elif isinstance(obj, Mapping):
-        return {k: remove_lazy_objects(v) for k, v in obj.items() if not isinstance(v, LocalProxy)}
-    elif not isinstance(obj, LocalProxy):
-        return obj # everything else that is not localproxy
-
-@oarepo.command(name="configuration")
-@click.argument("output_file", default="-")
-@with_appcontext
-def configuration_command(output_file):
-    configuration = remove_lazy_objects(current_app.config)
-
-    try:
-        invenio_db = current_app.extensions["invenio-db"]
-        alembic_config = invenio_db.alembic.config
-        configuration["ALEMBIC_LOCATIONS"] = alembic_config.get_main_option(
-            "version_locations"
-        ).split(",")
-    except Exception as e:
-        configuration["ALEMBIC_LOCATIONS_ERROR"] = str(e)
-
-    if output_file == "-":
-        print(
-            json.dumps(
-                configuration, skipkeys=True, indent=4, ensure_ascii=False, default=lambda x: str(x)
-            )
-        )
-    else:
-        with open(output_file, "w") as f:
-            json.dump(configuration, f,skipkeys=True, ensure_ascii=False, default=lambda x: str(x))