dsp-tools 17.0.0.post23__tar.gz → 17.0.0.post26__tar.gz

{dsp_tools-17.0.0.post23 → dsp_tools-17.0.0.post26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dsp-tools
-Version: 17.0.0.post23
+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.post23 → dsp_tools-17.0.0.post26}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "dsp-tools"
-version = "17.0.0.post23"
+version = "17.0.0.post26"
 description = "DSP-TOOLS is a Python package with a command line interface that helps you interact with a DaSCH service platform (DSP) server."
 authors = [
     { name = "DaSCH - Swiss National Data and Service Center for the Humanities", email = "info@dasch.swiss" },

{dsp_tools-17.0.0.post23 → dsp_tools-17.0.0.post26}/src/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-17.0.0.post23 → dsp_tools-17.0.0.post26}/src/dsp_tools/commands/create/parsing/parsing_utils.py

@@ -4,6 +4,7 @@ import regex
 
 from dsp_tools.commands.create.constants import KNORA_API_STR
 from dsp_tools.commands.create.constants import UNIVERSAL_PREFIXES
+from dsp_tools.utils.data_formats.iri_util import make_dsp_ontology_prefix
 from dsp_tools.utils.data_formats.uri_util import is_uri
 
 
@@ -27,7 +28,7 @@ def create_prefix_lookup(project_json: dict[str, Any], api_url: str) -> dict[str
     shortcode = project_json["project"]["shortcode"]
     for onto in project_json["project"]["ontologies"]:
         onto_name = onto["name"]
-        defined_prefixes[onto_name] = _make_dsp_ontology_prefix(api_url, shortcode, onto_name)
+        defined_prefixes[onto_name] = make_dsp_ontology_prefix(api_url, shortcode, onto_name)
     return defined_prefixes
 
 
@@ -37,7 +38,3 @@ def _correct_external_prefix(prefixes: dict[str, str]) -> dict[str, str]:
             continue
         prefixes[prfx] = f"{namespace}/"
     return prefixes
-
-
-def _make_dsp_ontology_prefix(api_url: str, shortcode: str, onto_name: str) -> str:
-    return f"{api_url}/ontology/{shortcode}/{onto_name}/v2#"

{dsp_tools-17.0.0.post23 → dsp_tools-17.0.0.post26}/src/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.post23 → dsp_tools-17.0.0.post26}/src/dsp_tools/utils/data_formats/iri_util.py

@@ -19,3 +19,12 @@ def from_dsp_iri_to_prefixed_iri(iri: str) -> str:
     if not (found := regex.search(dsp_iri_re, iri)):
         return iri
     return f"{found.group(1)}:{found.group(2)}"
+
+
+def make_dsp_ontology_prefix(api_url: str, shortcode: str, onto_name: str) -> str:
+    api_fixed = convert_api_url_for_correct_iri_namespace_construction(api_url)
+    return f"{api_fixed}/ontology/{shortcode}/{onto_name}/v2#"
+
+
+def convert_api_url_for_correct_iri_namespace_construction(api_url: str) -> str:
+    return regex.sub(r"^https", "http", api_url)

{dsp_tools-17.0.0.post23 → dsp_tools-17.0.0.post26}/src/dsp_tools/utils/xml_parsing/get_parsed_resources.py

@@ -5,6 +5,7 @@ from lxml import etree
 
 from dsp_tools.commands.validate_data.mappers import XML_TAG_TO_VALUE_TYPE_MAPPER
 from dsp_tools.error.exceptions import InputError
+from dsp_tools.utils.data_formats.iri_util import convert_api_url_for_correct_iri_namespace_construction
 from dsp_tools.utils.rdflib_constants import KNORA_API_STR
 from dsp_tools.utils.xml_parsing.models.parsed_resource import KnoraValueType
 from dsp_tools.utils.xml_parsing.models.parsed_resource import ParsedFileValue
@@ -15,7 +16,7 @@ from dsp_tools.utils.xml_parsing.models.parsed_resource import ParsedValue
 
 
 def get_parsed_resources(root: etree._Element, api_url: str) -> list[ParsedResource]:
-    api_url = _convert_api_url_for_correct_iri_namespace_construction(api_url)
+    api_url = convert_api_url_for_correct_iri_namespace_construction(api_url)
     iri_lookup = _create_from_local_name_to_absolute_iri_lookup(root, api_url)
     all_res: list[ParsedResource] = []
     for res in root.iterdescendants(tag="resource"):
@@ -34,10 +35,6 @@ def get_parsed_resources(root: etree._Element, api_url: str) -> list[ParsedResou
     return all_res
 
 
-def _convert_api_url_for_correct_iri_namespace_construction(api_url: str) -> str:
-    return regex.sub(r"^https", "http", api_url)
-
-
 def _create_from_local_name_to_absolute_iri_lookup(root: etree._Element, api_url: str) -> dict[str, str]:
     shortcode = root.attrib["shortcode"]
     default_ontology = root.attrib["default-ontology"]