folio-migration-tools 1.9.10__py3-none-any.whl → 1.10.0b1__py3-none-any.whl

folio_migration_tools/__init__.py

@@ -3,9 +3,8 @@ from typing import Protocol
 
 __version__ = importlib.metadata.version("folio_migration_tools")
 
+
 class StrCoercible(Protocol):
-    def __repr__(self) -> str:
-        ...
+    def __repr__(self) -> str: ...
 
-    def __str__(self) -> str:
-        ...
+    def __str__(self) -> str: ...

folio_migration_tools/__main__.py

@@ -33,23 +33,25 @@ def parse_args(args):
 
     parser.add_argument(
         "task_name",
-        help=("Task name. Use one of: " f"{tasks_string}"),
+        help=(f"Task name. Use one of: {tasks_string}"),
         nargs="?" if "FOLIO_MIGRATION_TOOLS_TASK_NAME" in environ else None,
         prompt="FOLIO_MIGRATION_TOOLS_TASK_NAME" not in environ,
         default=environ.get("FOLIO_MIGRATION_TOOLS_TASK_NAME"),
     )
     parser.add_argument(
-        "--folio_password", "--okapi_password",
+        "--folio_password",
+        "--okapi_password",
         help="password for the tenant in the configuration file",
         prompt="FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD" not in environ,
-        default=environ.get("FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD"),
+        default=environ.get(
+            "FOLIO_MIGRATION_TOOLS_FOLIO_PASSWORD",
+            environ.get("FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD"),
+        ),
         secure=True,
     )
     parser.add_argument(
         "--base_folder_path",
-        help=(
-            "path to the base folder for this library. Built on migration_repo_template"
-        ),
+        help=("path to the base folder for this library. Built on migration_repo_template"),
         prompt="FOLIO_MIGRATION_TOOLS_BASE_FOLDER_PATH" not in environ,
         default=environ.get("FOLIO_MIGRATION_TOOLS_BASE_FOLDER_PATH"),
     )
@@ -62,34 +64,43 @@ def parse_args(args):
         prompt=False,
     )
     parser.add_argument(
-        "--version", "-V",
+        "--version",
+        "-V",
         help="Show the version of the FOLIO Migration Tools",
         action="store_true",
         prompt=False,
     )
     return parser.parse_args(args)
 
+
 def prep_library_config(args):
-        config_file_humped = merge_load(args.configuration_path)
-        config_file_humped["libraryInformation"]["okapiPassword"] = args.folio_password
-        config_file_humped["libraryInformation"]["baseFolder"] = args.base_folder_path
-        config_file = humps.decamelize(config_file_humped)
-        library_config = LibraryConfiguration(**config_file["library_information"])
-        if library_config.ecs_tenant_id:
-            library_config.is_ecs = True
-        if library_config.ecs_tenant_id and not library_config.ecs_central_iteration_identifier:
-            print(
-                "ECS tenant ID is set, but no central iteration identifier is provided. "
-                "Please provide the central iteration identifier in the configuration file."
-            )
-            sys.exit("ECS Central Iteration Identifier Not Found")
-        return config_file, library_config
+    config_file_humped = merge_load(args.configuration_path)
 
-def print_version(args):
-    if "-V" in args or "--version" in args:
+    # Only set folioPassword if neither folioPassword nor okapiPassword exist in config
+    # The Pydantic validator will handle backward compatibility for existing okapiPassword
+    if (
+        "folioPassword" not in config_file_humped["libraryInformation"]
+        and "okapiPassword" not in config_file_humped["libraryInformation"]
+    ):
+        config_file_humped["libraryInformation"]["folioPassword"] = args.folio_password
+
+    config_file_humped["libraryInformation"]["baseFolder"] = args.base_folder_path
+    config_file = humps.decamelize(config_file_humped)
+    library_config = LibraryConfiguration(**config_file["library_information"])
+    if library_config.ecs_tenant_id:
+        library_config.is_ecs = True
+    if library_config.ecs_tenant_id and not library_config.ecs_central_iteration_identifier:
         print(
-            f"FOLIO Migration Tools: {metadata.version('folio_migration_tools')}"
+            "ECS tenant ID is set, but no central iteration identifier is provided. "
+            "Please provide the central iteration identifier in the configuration file."
         )
+        sys.exit("ECS Central Iteration Identifier Not Found")
+    return config_file, library_config
+
+
+def print_version(args):
+    if "-V" in args or "--version" in args:
+        print(f"FOLIO Migration Tools: {metadata.version('folio_migration_tools')}")
         sys.exit(0)
     return None
 
@@ -122,7 +133,7 @@ def main():
             task_names = [t.get("name", "") for t in config_file["migration_tasks"]]
             print(
                 f"Referenced task name {args.task_name} not found in the "
-                f'configuration file. Use one of {", ".join(task_names)}'
+                f"configuration file. Use one of {', '.join(task_names)}"
                 "\nHalting..."
             )
             sys.exit("Task Name Not Found")
@@ -134,13 +145,15 @@ def main():
             )
         except StopIteration:
             print(
-                f'Referenced task {migration_task_config["migration_task_type"]} '
+                f"Referenced task {migration_task_config['migration_task_type']} "
                 "is not a valid option. Update your task to incorporate "
                 f"one of {json.dumps([tc.__name__ for tc in task_classes], indent=4)}"
             )
             sys.exit("Task Type Not Found")
         try:
-            logging.getLogger("httpx").setLevel(logging.WARNING) # Exclude info messages from httpx
+            logging.getLogger("httpx").setLevel(
+                logging.WARNING
+            )  # Exclude info messages from httpx
             with FolioClient(
                 library_config.gateway_url,
                 library_config.tenant_id,
@@ -161,16 +174,15 @@ def main():
         logging.critical(json_error)
         print(json_error.doc)
         print(
-            f"\n{json_error}"
-            f"\nError parsing the above JSON mapping or configruation file. Halting."
+            f"\n{json_error}\nError parsing the above JSON mapping or configruation file. Halting."
         )
         sys.exit("Invalid JSON")
     except ValidationError as e:
-        print(e.json())
+        print(json.dumps(e.errors(), indent=2))
         print("Validation errors in configuration file:")
         print("==========================================")
 
-        for validation_message in json.loads(e.json()):
+        for validation_message in e.errors():
             print(
                 f"{validation_message['msg']}\t"
                 f"{', '.join(humps.camelize(str(x)) for x in validation_message['loc'])}"
@@ -199,6 +211,7 @@ def main():
         sys.exit(ee.__class__.__name__)
     sys.exit(0)
 
+
 def inheritors(base_class):
     subclasses = set()
     work = [base_class]

folio_migration_tools/circulation_helper.py

@@ -3,12 +3,12 @@ import json
 import logging
 import re
 import time
+from http import HTTPStatus
 from typing import Set
 
 import httpx
 import i18n
-from folioclient import FolioClient
-from httpx import HTTPError
+from folioclient import FolioClient, FolioClientError, FolioConnectionError, FolioValidationError
 
 from folio_migration_tools.helper import Helper
 from folio_migration_tools.migration_report import MigrationReport
@@ -138,7 +138,6 @@ class CirculationHelper:
         if legacy_loan.proxy_patron_barcode:
             data.update({"proxyUserBarcode": legacy_loan.proxy_patron_barcode})
         path = "/circulation/check-out-by-barcode"
-        url = f"{self.folio_client.gateway_url}{path}"
         try:
             if legacy_loan.patron_barcode in self.missing_patron_barcodes:
                 error_message = i18n.t("Patron barcode already detected as missing")
@@ -147,108 +146,109 @@ class CirculationHelper:
                     f"Item Barcode:{legacy_loan.item_barcode}"
                 )
                 return TransactionResult(False, False, "", error_message, error_message)
-            req = httpx.post(url, headers=self.folio_client.okapi_headers, json=data, timeout=None)
-            if req.status_code == 422:
-                error_message_from_folio = json.loads(req.text)["errors"][0]["message"]
-                stat_message = error_message_from_folio
-                error_message = error_message_from_folio
-                if "has the item status" in error_message_from_folio:
-                    stat_message = re.findall(
-                        r"(?<=has the item status\s).*(?=\sand cannot be checked out)",
-                        error_message_from_folio,
-                    )[0]
-                    error_message = (
-                        f"{stat_message} for item with barcode {legacy_loan.item_barcode}"
-                    )
-                    return TransactionResult(
-                        False,
-                        True,
-                        None,
-                        error_message_from_folio,
-                        stat_message,
-                    )
-                elif "No item with barcode" in error_message_from_folio:
-                    error_message = f"No item with barcode {legacy_loan.item_barcode} in FOLIO"
-                    stat_message = "Item barcode not in FOLIO"
-                    self.missing_item_barcodes.add(legacy_loan.item_barcode)
-                    return TransactionResult(
-                        False,
-                        False,
-                        None,
-                        error_message_from_folio,
-                        stat_message,
-                    )
-
-                elif "find user with matching barcode" in error_message_from_folio:
-                    self.missing_patron_barcodes.add(legacy_loan.patron_barcode)
-                    error_message = f"No patron with barcode {legacy_loan.patron_barcode} in FOLIO"
-                    stat_message = i18n.t("Patron barcode not in FOLIO")
-                    return TransactionResult(
-                        False,
-                        False,
-                        None,
-                        error_message_from_folio,
-                        stat_message,
-                    )
-                elif "Cannot check out item that already has an open" in error_message_from_folio:
-                    return TransactionResult(
-                        False,
-                        False,
-                        None,
-                        error_message_from_folio,
-                        error_message_from_folio,
-                    )
-                elif "Item is already checked out" in error_message_from_folio:
-                    return TransactionResult(
-                        False,
-                        True,
-                        None,
-                        error_message_from_folio,
-                        error_message_from_folio,
-                    )
-                logging.error(
-                    f"{error_message} "
-                    f"Patron barcode: {legacy_loan.patron_barcode} "
-                    f"Item Barcode:{legacy_loan.item_barcode}"
+            loan = self.folio_client.folio_post(path, data)
+            stats = "Successfully checked out by barcode"
+            logging.debug(
+                "%s (item barcode %s}) in %ss",
+                stats,
+                legacy_loan.item_barcode,
+                f"{(time.time() - t0_function):.2f}",
+            )
+            return TransactionResult(True, False, loan, "", stats)
+        except FolioValidationError as fve:
+            error_message_from_folio = self.folio_client.handle_json_response(fve.response)[
+                "errors"
+            ][0]["message"]
+            stat_message = error_message_from_folio
+            error_message = error_message_from_folio
+            if "has the item status" in error_message_from_folio:
+                stat_message = re.findall(
+                    r"(?<=has the item status\s).*(?=\sand cannot be checked out)",
+                    error_message_from_folio,
+                )[0]
+                error_message = f"{stat_message} for item with barcode {legacy_loan.item_barcode}"
+                return TransactionResult(
+                    False,
+                    True,
+                    None,
+                    error_message_from_folio,
+                    stat_message,
                 )
-                self.migration_report.add("Details", stat_message)
+            elif "No item with barcode" in error_message_from_folio:
+                error_message = f"No item with barcode {legacy_loan.item_barcode} in FOLIO"
+                stat_message = "Item barcode not in FOLIO"
+                self.missing_item_barcodes.add(legacy_loan.item_barcode)
                 return TransactionResult(
-                    False, True, None, error_message, f"Check out error: {stat_message}"
+                    False,
+                    False,
+                    None,
+                    error_message_from_folio,
+                    stat_message,
                 )
-            elif req.status_code == 201:
-                stats = "Successfully checked out by barcode"
-                logging.debug(
-                    "%s (item barcode %s}) in %ss",
-                    stats,
-                    legacy_loan.item_barcode,
-                    f"{(time.time() - t0_function):.2f}",
+
+            elif "find user with matching barcode" in error_message_from_folio:
+                self.missing_patron_barcodes.add(legacy_loan.patron_barcode)
+                error_message = f"No patron with barcode {legacy_loan.patron_barcode} in FOLIO"
+                stat_message = i18n.t("Patron barcode not in FOLIO")
+                return TransactionResult(
+                    False,
+                    False,
+                    None,
+                    error_message_from_folio,
+                    stat_message,
                 )
-                return TransactionResult(True, False, json.loads(req.text), "", stats)
-            elif req.status_code == 204:
-                stats = "Successfully checked out by barcode"
-                logging.debug(
-                    "%s (item barcode %s) %s",
-                    stats,
-                    legacy_loan.item_barcode,
-                    req.status_code,
+            elif "Cannot check out item that already has an open" in error_message_from_folio:
+                return TransactionResult(
+                    False,
+                    False,
+                    None,
+                    error_message_from_folio,
+                    error_message_from_folio,
                 )
-                return TransactionResult(True, False, None, "", stats)
-            else:
-                req.raise_for_status()
-        except HTTPError:
+            elif "Item is already checked out" in error_message_from_folio:
+                return TransactionResult(
+                    False,
+                    True,
+                    None,
+                    error_message_from_folio,
+                    error_message_from_folio,
+                )
+            logging.error(
+                f"{error_message} "
+                f"Patron barcode: {legacy_loan.patron_barcode} "
+                f"Item Barcode:{legacy_loan.item_barcode}"
+            )
+            self.migration_report.add("Details", stat_message)
+            return TransactionResult(
+                False, True, None, error_message, f"Check out error: {stat_message}"
+            )
+        except FolioClientError as fce:
             logging.exception(
                 "%s\tPOST FAILED %s\n\t%s\n\t%s",
-                req.status_code,
-                url,
+                fce.response.status_code,
+                fce.request.url,
                 json.dumps(data),
-                req.text,
+                fce.response.text,
             )
             return TransactionResult(
                 False,
                 False,
                 None,
                 "5XX",
-                i18n.t("Failed checkout http status %{code}", code=req.status_code),
+                i18n.t("Failed checkout http status %{code}", code=fce.response.status_code),
+            )
+        except FolioConnectionError as fce:
+            logging.exception(
+                "Connection error\tPOST FAILED %s\n\t%s\n\t%s",
+                fce.request.url,
+                json.dumps(data),
+            )
+            return TransactionResult(
+                False,
+                False,
+                None,
+                "Connection error",
+                i18n.t("Connection error during checkout"),
             )
 
     @staticmethod
@@ -257,7 +257,6 @@ class CirculationHelper:
     ):
         try:
             path = "/circulation/requests"
-            url = f"{folio_client.gateway_url}{path}"
             data = legacy_request.serialize()
             data["requestProcessingParameters"] = {
                 "overrideBlocks": {
@@ -269,21 +268,31 @@ class CirculationHelper:
                     "comment": "Migrated from legacy system",
                 }
             }
-            req = httpx.post(url, headers=folio_client.okapi_headers, json=data, timeout=None)
-            logging.debug(f"POST {req.status_code}\t{url}\t{json.dumps(data)}")
-            if str(req.status_code) == "422":
-                message = json.loads(req.text)["errors"][0]["message"]
-                logging.error(f"{message}")
+            _ = folio_client.folio_post(path, data)
+            logging.debug(f"POST {path}\t{json.dumps(data)}")
+            logging.info(
+                "%s Successfully created %s",
+                HTTPStatus.OK,
+                legacy_request.request_type,
+            )
+            return True
+        except FolioValidationError as fve:
+            message = folio_client.handle_json_response(fve.response)["errors"][0]["message"]
+            logging.error(message)
+            migration_report.add_general_statistics(message)
+            return False
+        except (FolioConnectionError, FolioClientError) as fce:
+            if client_response := getattr(fce, "response", None):
+                message = (
+                    f"HTTP {client_response.status_code} Error creating request: "
+                    f"{client_response.text}"
+                )
+                logging.error(message)
                 migration_report.add_general_statistics(message)
-                return False
             else:
-                req.raise_for_status()
-                logging.info(
-                    "%s Successfully created %s",
-                    req.status_code,
-                    legacy_request.request_type,
-                )
-                return True
+                logging.error(f"Connection error creating request: {fce}")
+                migration_report.add_general_statistics("Connection error creating request")
+            return False
         except Exception as exception:
             logging.error(exception, exc_info=True)
             migration_report.add("Details", exception)

folio_migration_tools/custom_dict.py

@@ -7,10 +7,10 @@ class InsensitiveDictReader(csv.DictReader):
     # spaces and to lower case.
     @property
     def fieldnames(self):
-        return [field.strip().lower() for field in csv.DictReader.fieldnames.fget(self)] # type: ignore
+        return [field.strip().lower() for field in csv.DictReader.fieldnames.fget(self)]  # type: ignore
 
     def next(self):
-        return InsensitiveDict(csv.DictReader.next(self)) # type: ignore
+        return InsensitiveDict(csv.DictReader.next(self))  # type: ignore
 
 
 class InsensitiveDict(dict):

folio_migration_tools/custom_exceptions.py

@@ -1,5 +1,4 @@
 import logging
-from typing import Union
 import i18n
 
 from folio_migration_tools import StrCoercible
@@ -13,10 +12,10 @@ class TransformationFieldMappingError(TransformationError):
     """Raised when the field mapping fails, but the error is not critical.
     The issue should be logged for the library to act upon it"""
 
-    def __init__(self, index_or_id="", message="", data_value: Union[str, StrCoercible]=""):
+    def __init__(self, index_or_id="", message="", data_value: str | StrCoercible = ""):
         self.index_or_id = index_or_id or ""
         self.message = message
-        self.data_value: Union[str, StrCoercible] = data_value
+        self.data_value: str | StrCoercible = data_value
         super().__init__(self.message)
 
     def __str__(self):
@@ -41,7 +40,7 @@ class TransformationRecordFailedError(TransformationError):
     def __init__(self, index_or_id, message="", data_value=""):
         self.index_or_id = index_or_id
         self.message = message
-        self.data_value: Union[str, StrCoercible] = data_value
+        self.data_value: str | StrCoercible = data_value
         # logging.log(26, f"RECORD FAILED\t{self.id}\t{self.message}\t{self.data_value}")
         super().__init__(self.message)
 
@@ -70,7 +69,7 @@ class TransformationProcessError(TransformationError):
         index_or_id,
         message="Critical Process issue. Transformation failed."
         " Check configuration, mapping files and reference data",
-        data_value: Union[str, StrCoercible]="",
+        data_value: str | StrCoercible = "",
     ):
         self.index_or_id = index_or_id
         self.message = message

folio_migration_tools/folder_structure.py

@@ -58,7 +58,7 @@ class FolderStructure:
         logging.info("Migration report file will be saved at %s", self.migration_reports_file)
 
     def setup_migration_file_structure(self, source_file_type: str = ""):
-        self.time_stamp = f'_{time.strftime("%Y%m%d-%H%M%S")}'
+        self.time_stamp = f"_{time.strftime('%Y%m%d-%H%M%S')}"
         self.time_str = self.time_stamp if self.add_time_stamp_to_file_names else ""
         self.file_template = f"{self.time_str}_{self.migration_task_name}"
         object_type_string = str(self.object_type.name).lower()

folio_migration_tools/helper.py

@@ -56,7 +56,7 @@ class Helper:
     @staticmethod
     def log_data_issue(index_or_id, message, legacy_value):
         logging.log(26, "DATA ISSUE\t%s\t%s\t%s", index_or_id, message, legacy_value)
-    
+
     @staticmethod
     def log_data_issue_failed(index_or_id, message, legacy_value):
         logging.log(26, "RECORD FAILED\t%s\t%s\t%s", index_or_id, message, legacy_value)