global: update ruff

invenio_global_search/components.py

@@ -1,38 +1,38 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """Components to Hook into other data models."""
 
-from __future__ import annotations
-
 from collections.abc import Callable
 
 from flask_principal import Identity
+from flask_resources import MarshmallowSerializer
 from invenio_rdm_records.records.api import RDMDraft, RDMRecord
 from invenio_rdm_records.resources.serializers.dublincore import (
     DublinCoreJSONSerializer,
 )
+from invenio_records.api import Record
 from invenio_records_global_search import current_records_global_search
 from invenio_records_lom.records import LOMRecord
 from invenio_records_lom.utils import LOMMetadata
 from invenio_records_marc21.records import Marc21Record
 from invenio_records_marc21.services.record import Marc21Metadata
 from invenio_records_resources.services.records.components import ServiceComponent
-from invenio_records_resources.services.uow import Operation
+from invenio_records_resources.services.uow import Operation, UnitOfWork
 
 from .serializers import LOMRecordJSONSerializer, Marc21RecordJSONSerializer
 
 
 def map_metadata_from_a_to_b(
-    record,
-    serializer_cls=None,
-    metadata_cls=None,
-    schema=None,
-    identity=None,
+    record: Record,
+    serializer_cls: MarshmallowSerializer = None,
+    metadata_cls: Marc21Metadata | LOMMetadata | None = None,
+    schema: str | None = None,
+    identity: Identity = None,
 ) -> None:
     """Func."""
     schema_mapping = {
@@ -72,12 +72,12 @@ class ComponentOp(Operation):
 
     def __init__(
         self,
-        record: RDMRecord,
+        record: Record,
         func: Callable = map_metadata_from_a_to_b,
-        serializer_cls=None,
-        metadata_cls=None,
-        schema=None,
-        identity=None,
+        serializer_cls: MarshmallowSerializer = None,
+        metadata_cls: Marc21Metadata | LOMMetadata | None = None,
+        schema: str | None = None,
+        identity: Identity = None,
     ) -> None:
         """Construct."""
         self._record = record
@@ -87,7 +87,7 @@ def __init__(
         self._schema = schema
         self._identity = identity
 
-    def on_post_commit(self, uow) -> None:  # noqa: ARG002
+    def on_post_commit(self, _: UnitOfWork) -> None:
         """Post commit."""
         self._func(
             self._record,
@@ -106,7 +106,7 @@ def publish(
         identity: Identity,
         data: dict | None = None,  # noqa: ARG002
         record: Marc21Record | None = None,
-        **_: dict,
+        **__: dict,
     ) -> None:
         """Create handler."""
         cmp_op = ComponentOp(
@@ -127,7 +127,7 @@ def publish(
         identity: Identity,
         data: dict | None = None,  # noqa: ARG002
         record: LOMRecord | None = None,
-        **_: dict,
+        **__: dict,
     ) -> None:
         """Create handler."""
         cmp_op = ComponentOp(
@@ -148,8 +148,8 @@ def publish(
         identity: Identity,
         data: dict | None = None,  # noqa: ARG002
         record: RDMRecord | None = None,
-        draft: RDMDraft | None = None,
-        **_: dict,
+        draft: RDMDraft | None = None,  # noqa: ARG002
+        **__: dict,
     ) -> None:
         """Create handler."""
         cmp_op = ComponentOp(

invenio_global_search/ext.py

@@ -1,31 +1,33 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """Global Search for InvenioRDM."""
 
 
+from flask import Flask
+
 from . import config
 
 
 class InvenioGlobalSearch:
     """InvenioGlobalSearch."""
 
-    def __init__(self, app):
+    def __init__(self, app: Flask) -> None:
         """Construct InvenioGlobalSearch."""
         if app:
             self.init_app(app)
 
-    def init_app(self, app):
+    def init_app(self, app: Flask) -> None:
         """Flask application initialization."""
         self.init_config(app)
         app.extensions["invenio-global-search"] = self
 
     @staticmethod
-    def init_config(app):
+    def init_config(app: Flask) -> None:
         """Initialize configuration."""
         for k in dir(config):
             if k.startswith("GLOBAL_SEARCH_"):

invenio_global_search/serializers/lom/serializer.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -16,11 +16,11 @@
 class LOMRecordJSONSerializer(MarshmallowSerializer):
     """Marshmallow based DataCite serializer for records."""
 
-    def __init__(self, **options):
-        """Constructor."""
+    def __init__(self, **kwargs: dict) -> None:
+        """Construct."""
         super().__init__(
             format_serializer_cls=JSONSerializer,
             object_schema_cls=LOMRecordSchema,
             list_schema_cls=BaseListSchema,
-            **options
+            **kwargs,
         )

invenio_global_search/serializers/marc21/serializer.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -16,11 +16,11 @@
 class Marc21RecordJSONSerializer(MarshmallowSerializer):
     """Marshmallow based DataCite serializer for records."""
 
-    def __init__(self, **options):
-        """Constructor."""
+    def __init__(self, **kwargs: dict) -> None:
+        """Construct."""
         super().__init__(
             format_serializer_cls=JSONSerializer,
             object_schema_cls=Marc21RecordSchema,
             list_schema_cls=BaseListSchema,
-            **options
+            **kwargs,
         )

invenio_global_search/serializers/rdm/__init__.py

@@ -1,17 +1,12 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """Global Search rdm searializer."""
 
-# the problem is the parent does not exists in this stage
-# from invenio_rdm_records.resources.serializers.dublincore import (
-#     DublinCoreJSONSerializer as RDMRecordJSONSerializer,
-# )
-
 from .serializer import RDMRecordJSONSerializer
 
 __all__ = ("RDMRecordJSONSerializer",)

invenio_global_search/serializers/rdm/serializer.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -16,11 +16,11 @@
 class RDMRecordJSONSerializer(MarshmallowSerializer):
     """Marshmallow based DataCite serializer for records."""
 
-    def __init__(self, **options):
-        """Constructor."""
+    def __init__(self, **kwargs: dict) -> None:
+        """Construct."""
         super().__init__(
             format_serializer_cls=JSONSerializer,
             object_schema_cls=RDMRecordSchema,
             list_schema_cls=BaseListSchema,
-            **options
+            **kwargs,
         )

pyproject.toml

@@ -1,10 +1,25 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2023-2024 Graz University of Technology.
 #
 # invenio-global-search is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 [build-system]
 requires = ["setuptools", "wheel", "babel>2.8"]
 build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+exclude = ["docs"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+  "ANN101", "ANN102",
+  "D203", "D211", "D212", "D213",
+  "FA102",
+  "PLR0913",
+  "TCH001", "TCH002", "TCH003",
+  "TID252",
+  "UP009",
+]