folio-migration-tools 1.9.9__py3-none-any.whl → 1.10.0__py3-none-any.whl

folio_migration_tools/migration_tasks/bibs_transformer.py

@@ -1,11 +1,11 @@
 import logging
 from typing import Annotated, List
 
-import i18n
 from folio_uuid.folio_namespaces import FOLIONamespaces
 from pydantic import Field
 
 from folio_migration_tools.helper import Helper
+from folio_migration_tools.i18n_cache import i18n_t
 from folio_migration_tools.library_configuration import (
     IlsFlavour,
     LibraryConfiguration,
@@ -16,7 +16,10 @@ from folio_migration_tools.marc_rules_transformation.marc_file_processor import
 from folio_migration_tools.marc_rules_transformation.rules_mapper_bibs import (
     BibsRulesMapper,
 )
-from folio_migration_tools.migration_tasks.migration_task_base import MarcTaskConfigurationBase, MigrationTaskBase
+from folio_migration_tools.migration_tasks.migration_task_base import (
+    MarcTaskConfigurationBase,
+    MigrationTaskBase,
+)
 
 
 class BibsTransformer(MigrationTaskBase):
@@ -26,7 +29,7 @@ class BibsTransformer(MigrationTaskBase):
             Field(
                 title="ILS flavour",
                 description="The type of ILS you are migrating records from.",
-                alias="ils_flavor"
+                alias="ils_flavor",
             ),
         ]
         custom_bib_id_field: Annotated[
@@ -68,11 +71,11 @@ class BibsTransformer(MigrationTaskBase):
             Field(
                 title="Generate a MARC file for data import overlay of instances",
                 description=(
-                    "If set to true, the process will generate a file of binary MARC records that can"
-                    "be imported into FOLIO using the Data Import APIs. If set to false, only a file"
-                    "of FOLIO instance records (and optional SRS records) will be generated."
+                    "If set to true, the process will generate a file of binary MARC records that "
+                    "can be imported into FOLIO using the Data Import APIs. If set to false, only "
+                    "a file of FOLIO instance records (and optional SRS records) will be generated."  # noqa: E501
                 ),
-            )
+            ),
         ] = True
         parse_cataloged_date: Annotated[
             bool,
@@ -130,7 +133,9 @@ class BibsTransformer(MigrationTaskBase):
         self.check_source_files(
             self.folder_structure.legacy_records_folder, self.task_configuration.files
         )
-        self.mapper = BibsRulesMapper(self.folio_client, library_config, self.task_configuration, statcode_mapping)
+        self.mapper = BibsRulesMapper(
+            self.folio_client, library_config, self.task_configuration, statcode_mapping
+        )
         self.bib_ids: set = set()
         if (
             self.task_configuration.reset_hrid_settings
@@ -148,7 +153,7 @@ class BibsTransformer(MigrationTaskBase):
         self.processor.wrap_up()
         with open(self.folder_structure.migration_reports_file, "w+") as report_file:
             self.mapper.migration_report.write_migration_report(
-                i18n.t("Bibliographic records transformation report"),
+                i18n_t("Bibliographic records transformation report"),
                 report_file,
                 self.start_datetime,
             )

folio_migration_tools/migration_tasks/courses_migrator.py

@@ -77,8 +77,7 @@ class CoursesMigrator(MigrationTaskBase):
             Field(
                 title="Look up instructor",
                 description=(
-                    "Flag to indicate whether to look up instructors. "
-                    "By default is False."
+                    "Flag to indicate whether to look up instructors. By default is False."
                 ),
             ),
         ] = False
@@ -91,7 +90,7 @@ class CoursesMigrator(MigrationTaskBase):
         self,
         task_configuration: TaskConfiguration,
         library_config: LibraryConfiguration,
-        folio_client
+        folio_client,
     ):
         csv.register_dialect("tsv", delimiter="\t")
         self.task_configuration = task_configuration

folio_migration_tools/migration_tasks/holdings_csv_transformer.py

@@ -7,7 +7,6 @@ import time
 import traceback
 from typing import Annotated, List, Optional
 
-import i18n
 from folio_uuid.folio_namespaces import FOLIONamespaces
 from httpx import HTTPError
 from pydantic import Field
@@ -18,6 +17,7 @@ from folio_migration_tools.custom_exceptions import (
 )
 from folio_migration_tools.helper import Helper
 from folio_migration_tools.holdings_helper import HoldingsHelper
+from folio_migration_tools.i18n_cache import i18n_t
 from folio_migration_tools.library_configuration import (
     FileDefinition,
     HridHandling,
@@ -57,10 +57,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
             HridHandling,
             Field(
                 title="HRID handling",
-                description=(
-                    "Determining how the HRID generation "
-                    "should be handled."
-                ),
+                description=("Determining how the HRID generation should be handled."),
             ),
         ]
         files: Annotated[
@@ -96,8 +93,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
             Field(
                 title="Previously generated holdings files",
                 description=(
-                    "List of previously generated holdings files. "
-                    "By default is empty list."
+                    "List of previously generated holdings files. By default is empty list."
                 ),
             ),
         ] = []
@@ -145,8 +141,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
             Field(
                 title="Reset HRID settings",
                 description=(
-                    "At the end of the run reset "
-                    "FOLIO with the HRID settings. Default is FALSE."
+                    "At the end of the run reset FOLIO with the HRID settings. Default is FALSE."
                 ),
             ),
         ] = False
@@ -155,8 +150,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
             Field(
                 title="Update HRID settings",
                 description=(
-                    "At the end of the run update "
-                    "FOLIO with the HRID settings. Default is TRUE."
+                    "At the end of the run update FOLIO with the HRID settings. Default is TRUE."
                 ),
             ),
         ] = True
@@ -166,7 +160,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                 title="Statistical code map file name",
                 description=(
                     "Path to the file containing the mapping of statistical codes. "
-                    "The file should be in TSV format with legacy_stat_code and folio_code columns."
+                    "The file should be in TSV format with legacy_stat_code and folio_code columns."  # noqa: E501
                 ),
             ),
         ] = ""
@@ -290,7 +284,8 @@ class HoldingsCsvTransformer(MigrationTaskBase):
 
     def load_location_map(self):
         with open(
-            self.folder_structure.mapping_files_folder / self.task_configuration.location_map_file_name
+            self.folder_structure.mapping_files_folder
+            / self.task_configuration.location_map_file_name
         ) as location_map_f:
             return self.load_ref_data_map_from_file(
                 location_map_f, "Found %s rows in location map"
@@ -304,7 +299,8 @@ class HoldingsCsvTransformer(MigrationTaskBase):
 
     def load_mapped_fields(self):
         with open(
-            self.folder_structure.mapping_files_folder / self.task_configuration.holdings_map_file_name
+            self.folder_structure.mapping_files_folder
+            / self.task_configuration.holdings_map_file_name  # noqa: E501
         ) as holdings_mapper_f:
             holdings_map = json.load(holdings_mapper_f)
             logging.info("%s fields in holdings mapping file map", len(holdings_map["data"]))
@@ -332,7 +328,8 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                 print(f"\n{error_str}\nHalting")
                 sys.exit(1)
         logging.info(
-            f"processed {self.total_records:,} records in {len(self.task_configuration.files)} files"
+            f"processed {self.total_records:,} records in "
+            f"{len(self.task_configuration.files)} files"
         )
 
     def wrap_up(self):
@@ -354,14 +351,14 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                         )
                     Helper.write_to_file(holdings_file, holding)
                     self.mapper.migration_report.add_general_statistics(
-                        i18n.t("Holdings Records Written to disk")
+                        i18n_t("Holdings Records Written to disk")
                     )
             self.mapper.save_id_map_file(
                 self.folder_structure.holdings_id_map_path, self.holdings_id_map
             )
         with open(self.folder_structure.migration_reports_file, "w") as migration_report_file:
             self.mapper.migration_report.write_migration_report(
-                i18n.t("Holdings transformation report"),
+                i18n_t("Holdings transformation report"),
                 migration_report_file,
                 self.mapper.start_datetime,
             )
@@ -379,7 +376,9 @@ class HoldingsCsvTransformer(MigrationTaskBase):
         properties = holdings_schema["properties"].keys()
         logging.info(properties)
         logging.info(self.task_configuration.holdings_merge_criteria)
-        res = [mc for mc in self.task_configuration.holdings_merge_criteria if mc not in properties]
+        res = [
+            mc for mc in self.task_configuration.holdings_merge_criteria if mc not in properties
+        ]
         if any(res):
             logging.critical(
                 (
@@ -394,7 +393,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
         full_path = self.folder_structure.data_folder / "items" / file_def.file_name
         with open(full_path, encoding="utf-8-sig") as records_file:
             self.mapper.migration_report.add_general_statistics(
-                i18n.t("Number of files processed")
+                i18n_t("Number of files processed")
             )
             start = time.time()
             records_processed = 0
@@ -413,7 +412,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                 except Exception as excepion:
                     self.mapper.handle_generic_exception(idx, excepion)
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("Number of Legacy items in file")
+                    i18n_t("Number of Legacy items in file")
                 )
                 if idx > 1 and idx % 10000 == 0:
                     elapsed = idx / (time.time() - start)
@@ -482,7 +481,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                 self.holdings[bw_key] = incoming_holding
                 self.mapper.create_and_write_boundwith_part(legacy_item_id, incoming_holding["id"])
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("Unique BW Holdings created from Items")
+                    i18n_t("Unique BW Holdings created from Items")
                 )
             else:
                 self.merge_holding(bw_key, incoming_holding)
@@ -493,7 +492,7 @@ class HoldingsCsvTransformer(MigrationTaskBase):
                     legacy_item_id, self.holdings[bw_key], self.object_type
                 )
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("BW Items found tied to previously created BW Holdings")
+                    i18n_t("BW Items found tied to previously created BW Holdings")
                 )
         else:
             # Regular holding. Merge according to criteria
@@ -505,12 +504,12 @@ class HoldingsCsvTransformer(MigrationTaskBase):
             )
             if self.holdings.get(new_holding_key, None):
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("Holdings already created from Item")
+                    i18n_t("Holdings already created from Item")
                 )
                 self.merge_holding(new_holding_key, incoming_holding)
             else:
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("Unique Holdings created from Items")
+                    i18n_t("Unique Holdings created from Items")
                 )
                 self.holdings[new_holding_key] = incoming_holding
 

folio_migration_tools/migration_tasks/holdings_marc_transformer.py

@@ -3,12 +3,12 @@ import json
 import logging
 from typing import Annotated, List
 
-import i18n
 from folio_uuid.folio_namespaces import FOLIONamespaces
 from pydantic import Field
 
 from folio_migration_tools.custom_exceptions import TransformationProcessError
 from folio_migration_tools.helper import Helper
+from folio_migration_tools.i18n_cache import i18n_t
 from folio_migration_tools.library_configuration import (
     FileDefinition,
     HridHandling,
@@ -19,7 +19,7 @@ from folio_migration_tools.marc_rules_transformation.rules_mapper_holdings impor
 )
 from folio_migration_tools.migration_tasks.migration_task_base import (
     MarcTaskConfigurationBase,
-    MigrationTaskBase
+    MigrationTaskBase,
 )
 
 
@@ -38,18 +38,14 @@ class HoldingsMarcTransformer(MigrationTaskBase):
             str,
             Field(
                 title="Migration task type",
-                description=(
-                    "The type of migration task you want to perform"
-                ),
+                description=("The type of migration task you want to perform"),
             ),
         ]
         files: Annotated[
             List[FileDefinition],
             Field(
                 title="Source files",
-                description=(
-                    "List of MARC21 files with holdings records"
-                ),
+                description=("List of MARC21 files with holdings records"),
             ),
         ]
         hrid_handling: Annotated[
@@ -167,9 +163,7 @@ class HoldingsMarcTransformer(MigrationTaskBase):
             str,
             Field(
                 title="MARC Holdings Note type",
-                description=(
-                    "The name of the note type to use for MARC (MRK) statements. "
-                ),
+                description=("The name of the note type to use for MARC (MRK) statements. "),
             ),
         ] = "Original MARC holdings statements"
         include_mfhd_mrk_as_note: Annotated[
@@ -187,9 +181,7 @@ class HoldingsMarcTransformer(MigrationTaskBase):
             str,
             Field(
                 title="MARC Record (as MARC Maker Representation) note type",
-                description=(
-                    "The name of the note type to use for MFHD (MRK) note. "
-                ),
+                description=("The name of the note type to use for MFHD (MRK) note. "),
             ),
         ] = "Original MFHD Record"
         include_mfhd_mrc_as_note: Annotated[
@@ -208,9 +200,7 @@ class HoldingsMarcTransformer(MigrationTaskBase):
             str,
             Field(
                 title="MARC Record (as MARC21 decoded string) note type",
-                description=(
-                    "The name of the note type to use for MFHD (MRC) note. "
-                ),
+                description=("The name of the note type to use for MFHD (MRC) note. "),
             ),
         ] = "Original MFHD (MARC21)"
 
@@ -276,12 +266,12 @@ class HoldingsMarcTransformer(MigrationTaskBase):
                     "Rows in Bound with relationship map: %s",
                     len(self.boundwith_relationship_map_rows),
                 )
-            except FileNotFoundError:
+            except FileNotFoundError as fnfe:
                 raise TransformationProcessError(
                     "",
-                    i18n.t("Provided boundwith relationship file not found"),
+                    i18n_t("Provided boundwith relationship file not found"),
                     self.task_configuration.boundwith_relationship_file_path,
-                )
+                ) from fnfe
 
         location_map_path = (
             self.folder_structure.mapping_files_folder
@@ -302,7 +292,7 @@ class HoldingsMarcTransformer(MigrationTaskBase):
             self.library_configuration,
             self.instance_id_map,
             self.boundwith_relationship_map_rows,
-            statcode_mapping
+            statcode_mapping,
         )
         self.add_supplemental_mfhd_mappings()
         if (
@@ -330,12 +320,12 @@ class HoldingsMarcTransformer(MigrationTaskBase):
                             "Supplemental MFHD mapping rules file must contain a dictionary",
                             json.dumps(new_rules),
                         )
-            except FileNotFoundError:
+            except FileNotFoundError as fnfe:
                 raise TransformationProcessError(
                     "",
                     "Provided supplemental MFHD mapping rules file not found",
                     self.task_configuration.supplemental_mfhd_mapping_rules_file,
-                )
+                ) from fnfe
         else:
             new_rules = {}
         self.mapper.integrate_supplemental_mfhd_mappings(new_rules)
@@ -360,7 +350,7 @@ class HoldingsMarcTransformer(MigrationTaskBase):
 
         with open(self.folder_structure.migration_reports_file, "w+") as report_file:
             self.mapper.migration_report.write_migration_report(
-                i18n.t("Bibliographic records transformation report"),
+                i18n_t("Bibliographic records transformation report"),
                 report_file,
                 self.start_datetime,
             )

folio_migration_tools/migration_tasks/items_transformer.py

@@ -12,6 +12,8 @@ import i18n
 from folio_uuid.folio_namespaces import FOLIONamespaces
 from pydantic import Field
 
+from folio_migration_tools.i18n_cache import i18n_t
+
 from folio_migration_tools.custom_exceptions import (
     TransformationProcessError,
     TransformationRecordFailedError,
@@ -53,10 +55,7 @@ class ItemsTransformer(MigrationTaskBase):
             HridHandling,
             Field(
                 title="HRID handling",
-                description=(
-                    "Determining how the HRID generation "
-                    "should be handled."
-                ),
+                description=("Determining how the HRID generation should be handled."),
             ),
         ]
         files: Annotated[
@@ -91,10 +90,7 @@ class ItemsTransformer(MigrationTaskBase):
             Optional[str],
             Field(
                 title="Temporary location map file name",
-                description=(
-                    "Temporary file name for location map. "
-                    "Empty string by default."
-                ),
+                description=("Temporary file name for location map. Empty string by default."),
             ),
         ] = ""
         material_types_map_file_name: Annotated[
@@ -115,10 +111,7 @@ class ItemsTransformer(MigrationTaskBase):
             Optional[str],
             Field(
                 title="Temporary loan types map file name",
-                description=(
-                    "File name for temporary loan types map. "
-                    "Empty string by default."
-                ),
+                description=("File name for temporary loan types map. Empty string by default."),
             ),
         ] = ""
         statistical_codes_map_file_name: Annotated[
@@ -218,9 +211,8 @@ class ItemsTransformer(MigrationTaskBase):
         self.folio_keys = MappingFileMapperBase.get_mapped_folio_properties_from_map(
             self.items_map
         )
-        if (
-            any(k for k in self.folio_keys if k.startswith("statisticalCodeIds"))
-            or any(getattr(k, "statistical_code", "") for k in self.task_configuration.files)
+        if any(k for k in self.folio_keys if k.startswith("statisticalCodeIds")) or any(
+            getattr(k, "statistical_code", "") for k in self.task_configuration.files
         ):
             statcode_mapping = self.load_ref_data_mapping_file(
                 "statisticalCodeIds",
@@ -307,7 +299,7 @@ class ItemsTransformer(MigrationTaskBase):
             temporary_loan_type_mapping,
             temporary_location_mapping,
             self.library_configuration,
-            self.task_configuration
+            self.task_configuration,
         )
         if (
             self.task_configuration.reset_hrid_settings
@@ -345,7 +337,7 @@ class ItemsTransformer(MigrationTaskBase):
         records_in_file = 0
         with open(full_path, encoding="utf-8-sig") as records_file:
             self.mapper.migration_report.add_general_statistics(
-                i18n.t("Number of files processed")
+                i18n_t("Number of files processed")
             )
             start = time.time()
             for idx, record in enumerate(self.mapper.get_objects(records_file, full_path)):
@@ -363,9 +355,7 @@ class ItemsTransformer(MigrationTaskBase):
                     self.handle_notes(folio_rec)
                     if folio_rec["holdingsRecordId"] in self.boundwith_relationship_map:
                         for idx_, instance_id in enumerate(
-                            self.boundwith_relationship_map.get(
-                                folio_rec["holdingsRecordId"]
-                            )
+                            self.boundwith_relationship_map.get(folio_rec["holdingsRecordId"])
                         ):
                             if idx_ == 0:
                                 bw_id = folio_rec["holdingsRecordId"]
@@ -380,7 +370,7 @@ class ItemsTransformer(MigrationTaskBase):
                     # TODO: turn this into a asynchronous task
                     Helper.write_to_file(results_file, folio_rec)
                     self.mapper.migration_report.add_general_statistics(
-                        i18n.t("Number of records written to disk")
+                        i18n_t("Number of records written to disk")
                     )
                     self.mapper.report_folio_mapping(folio_rec, self.mapper.schema)
                 except TransformationProcessError as process_error:
@@ -399,7 +389,7 @@ class ItemsTransformer(MigrationTaskBase):
                     i18n.t("Number of Legacy items in %{container}", container=file_def),
                 )
                 self.mapper.migration_report.add_general_statistics(
-                    i18n.t("Number of Legacy items in total")
+                    i18n_t("Number of Legacy items in total")
                 )
                 self.print_progress(idx, start)
                 records_in_file = idx + 1
@@ -453,36 +443,35 @@ class ItemsTransformer(MigrationTaskBase):
     def load_boundwith_relationships(self):
         try:
             with open(
-                    self.folder_structure.boundwith_relationships_map_path
+                self.folder_structure.boundwith_relationships_map_path
             ) as boundwith_relationship_file:
                 self.boundwith_relationship_map = dict(
-                        json.loads(x) for x in boundwith_relationship_file
-                    )
-            logging.info(
-                "Rows in Bound with relationship map: %s",
-                len(self.boundwith_relationship_map)
+                    json.loads(x) for x in boundwith_relationship_file
                 )
-        except FileNotFoundError:
+            logging.info(
+                "Rows in Bound with relationship map: %s", len(self.boundwith_relationship_map)
+            )
+        except FileNotFoundError as fnfe:
             raise TransformationProcessError(
                 "",
                 "Boundwith relationship file specified, but relationships file "
                 "from holdings transformation not found.",
-                self.folder_structure.boundwith_relationships_map_path
-            )
-        except ValueError:
+                self.folder_structure.boundwith_relationships_map_path,
+            ) from fnfe
+        except ValueError as ve:
             raise TransformationProcessError(
                 "",
                 "Boundwith relationship file specified, but relationships file "
                 "from holdings transformation is not a valid line JSON.",
                 self.folder_structure.boundwith_relationships_map_path,
-            )
+            ) from ve
 
     def wrap_up(self):
         logging.info("Done. Transformer wrapping up...")
         self.extradata_writer.flush()
         with open(self.folder_structure.migration_reports_file, "w") as migration_report_file:
             self.mapper.migration_report.write_migration_report(
-                i18n.t("Item transformation report"),
+                i18n_t("Item transformation report"),
                 migration_report_file,
                 self.mapper.start_datetime,
             )