dsp-tools 17.0.0.post25__py3-none-any.whl → 17.0.0.post26__py3-none-any.whl

dsp_tools/cli/call_action.py

@@ -31,6 +31,8 @@ from dsp_tools.commands.xmlupload.xmlupload import xmlupload
 from dsp_tools.error.exceptions import DockerNotReachableError
 from dsp_tools.error.exceptions import DspApiNotReachableError
 from dsp_tools.error.exceptions import InputError
+from dsp_tools.error.exceptions import UserDirectoryNotFoundError
+from dsp_tools.error.exceptions import UserFilepathNotFoundError
 from dsp_tools.utils.xml_parsing.parse_clean_validate_xml import parse_and_validate_xml_file
 
 LOCALHOST_API = "http://0.0.0.0:3333"
@@ -119,6 +121,8 @@ def _call_start_stack(args: argparse.Namespace) -> bool:
 
 
 def _call_id2iri(args: argparse.Namespace) -> bool:
+    _check_filepath_exists(Path(args.xmlfile))
+    _check_filepath_exists(Path(args.mapping))
     return id2iri(
         xml_file=args.xmlfile,
         json_file=args.mapping,
@@ -127,6 +131,7 @@ def _call_id2iri(args: argparse.Namespace) -> bool:
 
 
 def _call_excel2properties(args: argparse.Namespace) -> bool:
+    _check_filepath_exists(Path(args.excelfile))
     _, _, success = excel2properties(
         excelfile=args.excelfile,
         path_to_output_file=args.properties_section,
@@ -135,6 +140,7 @@ def _call_excel2properties(args: argparse.Namespace) -> bool:
 
 
 def _call_excel2resources(args: argparse.Namespace) -> bool:
+    _check_filepath_exists(Path(args.excelfile))
     _, _, success = excel2resources(
         excelfile=args.excelfile,
         path_to_output_file=args.resources_section,
@@ -143,6 +149,7 @@ def _call_excel2resources(args: argparse.Namespace) -> bool:
 
 
 def _call_old_excel2lists(args: argparse.Namespace) -> bool:
+    _check_directory_exists(Path(args.excelfolder))
     _, success = old_excel2lists(
         excelfolder=args.excelfolder,
         path_to_output_file=args.lists_section,
@@ -152,6 +159,7 @@ def _call_old_excel2lists(args: argparse.Namespace) -> bool:
 
 
 def _call_excel2lists(args: argparse.Namespace) -> bool:
+    _check_directory_exists(Path(args.excelfolder))
     _, success = excel2lists(
         excelfolder=args.excelfolder,
         path_to_output_file=args.lists_section,
@@ -160,6 +168,7 @@ def _call_excel2lists(args: argparse.Namespace) -> bool:
 
 
 def _call_excel2json(args: argparse.Namespace) -> bool:
+    _check_directory_exists(Path(args.excelfolder))
     return excel2json(
         data_model_files=args.excelfolder,
         path_to_output_file=args.project_definition,
@@ -167,6 +176,7 @@ def _call_excel2json(args: argparse.Namespace) -> bool:
 
 
 def _call_old_excel2json(args: argparse.Namespace) -> bool:
+    _check_directory_exists(Path(args.excelfolder))
     return old_excel2json(
         data_model_files=args.excelfolder,
         path_to_output_file=args.project_definition,
@@ -175,8 +185,10 @@ def _call_old_excel2json(args: argparse.Namespace) -> bool:
 
 def _call_upload_files(args: argparse.Namespace) -> bool:
     _check_health_with_docker_on_localhost(args.server)
+    xml_path = Path(args.xml_file)
+    _check_filepath_exists(xml_path)
     return upload_files(
-        xml_file=Path(args.xml_file),
+        xml_file=xml_path,
         creds=_get_creds(args),
         imgdir=Path(args.imgdir),
     )
@@ -189,9 +201,11 @@ def _call_ingest_files(args: argparse.Namespace) -> bool:
 
 def _call_ingest_xmlupload(args: argparse.Namespace) -> bool:
     _check_health_with_docker(args.server)
+    xml_path = Path(args.xml_file)
+    _check_filepath_exists(xml_path)
     interrupt_after = args.interrupt_after if args.interrupt_after > 0 else None
     return ingest_xmlupload(
-        xml_file=Path(args.xml_file),
+        xml_file=xml_path,
         creds=_get_creds(args),
         interrupt_after=interrupt_after,
         skip_validation=args.skip_validation,
@@ -202,8 +216,13 @@ def _call_ingest_xmlupload(args: argparse.Namespace) -> bool:
 
 def _call_xmlupload(args: argparse.Namespace) -> bool:
     _check_health_with_docker(args.server)
+    xml_path = Path(args.xmlfile)
+    _check_filepath_exists(xml_path)
+    id_2_iri_file = args.id2iri_replacement_with_file
+    if id_2_iri_file:
+        _check_filepath_exists(Path(id_2_iri_file))
     if args.validate_only:
-        success = parse_and_validate_xml_file(Path(args.xmlfile))
+        success = parse_and_validate_xml_file(xml_path)
         print("The XML file is syntactically correct.")
         return success
     else:
@@ -221,7 +240,7 @@ def _call_xmlupload(args: argparse.Namespace) -> bool:
                     f"is not part of the allowed values: info, warning, error."
                 )
         return xmlupload(
-            input_file=Path(args.xmlfile),
+            input_file=xml_path,
             creds=_get_creds(args),
             imgdir=args.imgdir,
             config=UploadConfig(
@@ -231,15 +250,17 @@ def _call_xmlupload(args: argparse.Namespace) -> bool:
                 ignore_duplicate_files_warning=args.ignore_duplicate_files_warning,
                 validation_severity=severity,
                 skip_ontology_validation=args.skip_ontology_validation,
-                id2iri_replacement_file=args.id2iri_replacement_with_file,
+                id2iri_replacement_file=id_2_iri_file,
             ),
         )
 
 
 def _call_validate_data(args: argparse.Namespace) -> bool:
     _check_health_with_docker(args.server)
+    xml_path = Path(args.xmlfile)
+    _check_filepath_exists(xml_path)
     return validate_data(
-        filepath=Path(args.xmlfile),
+        filepath=xml_path,
         creds=_get_creds(args),
         save_graphs=args.save_graphs,
         ignore_duplicate_files_warning=args.ignore_duplicate_files_warning,
@@ -259,6 +280,7 @@ def _call_resume_xmlupload(args: argparse.Namespace) -> bool:
 
 def _call_get(args: argparse.Namespace) -> bool:
     _check_health_with_docker_on_localhost(args.server)
+    _check_directory_exists(Path(args.project_definition).parent)
     return get_project(
         project_identifier=args.project,
         outfile_path=args.project_definition,
@@ -269,6 +291,7 @@ def _call_get(args: argparse.Namespace) -> bool:
 
 def _call_create(args: argparse.Namespace) -> bool:
     _check_health_with_docker_on_localhost(args.server)
+    _check_filepath_exists(Path(args.project_definition))
     success = False
     match args.lists_only, args.validate_only:
         case True, True:
@@ -340,3 +363,13 @@ def _check_api_health(api_url: str) -> None:
             msg = "The DSP-API responded with a request exception. Please contact the DaSCH engineering team for help."
         logger.error(msg)
         raise DspApiNotReachableError(msg) from None
+
+
+def _check_filepath_exists(file_path: Path) -> None:
+    if not file_path.exists():
+        raise UserFilepathNotFoundError(file_path)
+
+
+def _check_directory_exists(dir_path: Path) -> None:
+    if not dir_path.is_dir():
+        raise UserDirectoryNotFoundError(dir_path)

dsp_tools/error/exceptions.py

@@ -77,6 +77,14 @@ class UserFilepathNotFoundError(InputError):
         super().__init__(msg)
 
 
+class UserDirectoryNotFoundError(InputError):
+    """This error is raised if a directory from the user does not exist."""
+
+    def __init__(self, directory: str | Path) -> None:
+        msg = f"The provided directory does not exist: {directory}"
+        super().__init__(msg)
+
+
 class JSONFileParsingError(InputError):
     """This error should be raised if the user provided input file cannot be parsed."""
 

{dsp_tools-17.0.0.post25.dist-info → dsp_tools-17.0.0.post26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dsp-tools
-Version: 17.0.0.post25
+Version: 17.0.0.post26
 Summary: DSP-TOOLS is a Python package with a command line interface that helps you interact with a DaSCH service platform (DSP) server.
 Author: DaSCH - Swiss National Data and Service Center for the Humanities
 Author-email: DaSCH - Swiss National Data and Service Center for the Humanities <info@dasch.swiss>

{dsp_tools-17.0.0.post25.dist-info → dsp_tools-17.0.0.post26.dist-info}/RECORD

@@ -1,7 +1,7 @@
 dsp_tools/__init__.py,sha256=XdzLhY_8FUFmPtUEawAvEA8apQ_jlgspb2HpmNjlDV8,158
 dsp_tools/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dsp_tools/cli/args.py,sha256=tS16NvgIMdQuaDWb0cNC8TIK7wY-i4pQe7NFYrzt5Bo,694
-dsp_tools/cli/call_action.py,sha256=i0VS1qkokvxtcxKj_4V0QWe49sLMZxa8eEqMnl2yr9E,12556
+dsp_tools/cli/call_action.py,sha256=2yBnZqNPWy0swC-YTA_CvhPOMh0cKBUHgQXPFGfDpvU,13826
 dsp_tools/cli/create_parsers.py,sha256=zi0E7AHV25B_wXt_8Jcan0Tc6y7aG0vipS5rya5gP9s,17764
 dsp_tools/cli/entry_point.py,sha256=gdexHqVDAy8_Atf0oUxvPVQyDGWUSUhio396U5Oc0RI,10331
 dsp_tools/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -186,7 +186,7 @@ dsp_tools/config/logger_config.py,sha256=Bw2Gu5F2d8un_KNk0hvNtV7fvN2TlThqo6gSwqe
 dsp_tools/config/warnings_config.py,sha256=15_Lt227HLqhdn6v-zJbi1KG9Fo6Zi1_4fp_a-iY72w,1142
 dsp_tools/error/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dsp_tools/error/custom_warnings.py,sha256=7C2DscIz9k7IfM8uebIsKWPcWcSjwpDqbIRDaPw7bI8,1053
-dsp_tools/error/exceptions.py,sha256=giLM6Hx17lMdCjNdlwMr4zqdGcqUHypAxESSAtkvvnU,4853
+dsp_tools/error/exceptions.py,sha256=jaKZE1aDWavHPIjYxc_upK9_tcPPEpaCd7PaIPuazNQ,5131
 dsp_tools/error/problems.py,sha256=DotzVg3MYvMJmernd9tTBmDHoT1MOkHdiWVv8iMoFSk,265
 dsp_tools/error/xmllib_errors.py,sha256=DpYCsBIx_GmsBAUlfk2VMqtzD5IGMRbd2yXTcrJFHR4,549
 dsp_tools/error/xmllib_warnings.py,sha256=sS9jJXGJtQqCiJ9P2zCM5gpIhTpChbujQz_fPvxLm8g,1557
@@ -260,7 +260,7 @@ dsp_tools/xmllib/models/res.py,sha256=c3edvilYZVDmv2O6Z36sSkHXcuKPAJLfWVpStDTMuJ
 dsp_tools/xmllib/models/root.py,sha256=x8_vrDSJ1pZUJUL8LR460dZe4Cg57G_Hy-Zfr2S29dw,13562
 dsp_tools/xmllib/value_checkers.py,sha256=Yx3r6_WoZ5Lev8Orp8yDzd03JvP2GBmFNSFT2dzrycM,10712
 dsp_tools/xmllib/value_converters.py,sha256=WMYS5hd1VlrLLBXnf6pv9yYoPBsv_2MxOO6xv-QsRW4,29218
-dsp_tools-17.0.0.post25.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
-dsp_tools-17.0.0.post25.dist-info/entry_points.txt,sha256=qjRfEbkeAwLU_AE2Q-l4Y9irPNmu4Wna-3bfRp1bqV4,62
-dsp_tools-17.0.0.post25.dist-info/METADATA,sha256=5P4ptenAkzZ86S1o7Uza-FbGFjpMl1nJQScnoipR_1s,4285
-dsp_tools-17.0.0.post25.dist-info/RECORD,,
+dsp_tools-17.0.0.post26.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
+dsp_tools-17.0.0.post26.dist-info/entry_points.txt,sha256=qjRfEbkeAwLU_AE2Q-l4Y9irPNmu4Wna-3bfRp1bqV4,62
+dsp_tools-17.0.0.post26.dist-info/METADATA,sha256=MVoGCBmqa_mR3gpWNETKJMEoBPX8YmBK0wOG_hr-UQs,4285
+dsp_tools-17.0.0.post26.dist-info/RECORD,,