kleinkram 0.43.5__py3-none-any.whl → 0.43.6__py3-none-any.whl

kleinkram/api/file_transfer.py

@@ -309,10 +309,10 @@ def download_file(
     if path.exists():
         local_hash = b64_md5(path)
         if local_hash != file.hash and not overwrite and file.hash is not None:
-            return DownloadState.SKIPPED_INVALID_HASH
+            return DownloadState.SKIPPED_INVALID_HASH, 0
 
         elif local_hash == file.hash:
-            return DownloadState.SKIPPED_OK
+            return DownloadState.SKIPPED_OK, 0
 
         # this has to be here
         if verbose:

kleinkram/wrappers.py

@@ -9,7 +9,7 @@ conversion to the internal representation
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Collection
+from typing import Collection, Any
 from typing import Dict
 from typing import List
 from typing import Literal
@@ -39,6 +39,11 @@ def _args_to_project_query(
     project_names: Optional[Sequence[str]] = None,
     project_ids: Optional[Sequence[IdLike]] = None,
 ) -> ProjectQuery:
+
+    # verify types of passed arguments
+    _verify_string_sequence("project_names", project_names)
+    _verify_sequence("project_ids", project_ids)
+
     return ProjectQuery(
         ids=[parse_uuid_like(_id) for _id in project_ids or []],
         patterns=list(project_names or []),
@@ -51,6 +56,13 @@ def _args_to_mission_query(
     project_names: Optional[Sequence[str]] = None,
     project_ids: Optional[Sequence[IdLike]] = None,
 ) -> MissionQuery:
+
+    # verify types of passed arguments
+    _verify_string_sequence("mission_names", mission_names)
+    _verify_sequence("mission_ids", mission_ids)
+    _verify_string_sequence("project_names", project_names)
+    _verify_sequence("project_ids", project_ids)
+
     return MissionQuery(
         ids=[parse_uuid_like(_id) for _id in mission_ids or []],
         patterns=list(mission_names or []),
@@ -60,6 +72,27 @@ def _args_to_mission_query(
     )
 
 
+def _verify_sequence(arg_name: str, arg_value: Optional[Sequence[Any]]) -> None:
+    """Verifies that an argument is either None, or a sequence."""
+    if arg_value is not None:
+        if not isinstance(arg_value, Sequence):
+            raise TypeError(f"{arg_name} must be a Sequence, None, or empty array.")
+
+
+def _verify_string_sequence(arg_name: str, arg_value: Optional[Sequence[Any]]) -> None:
+    """Verifies that an argument is either None, an empty sequence, or a sequence of strings."""
+    if arg_value is not None:
+        if not isinstance(arg_value, Sequence):
+            raise TypeError(f"{arg_name} must be a Sequence, None, or empty array.")
+        if isinstance(arg_value, str):
+            raise TypeError(
+                f"{arg_name} cannot be a string, but a sequence of strings."
+            )
+        for item in arg_value:
+            if not isinstance(item, str):
+                raise TypeError(f"{arg_name} must contain strings only.")
+
+
 def _args_to_file_query(
     file_names: Optional[Sequence[str]] = None,
     file_ids: Optional[Sequence[IdLike]] = None,
@@ -68,6 +101,15 @@ def _args_to_file_query(
     project_names: Optional[Sequence[str]] = None,
     project_ids: Optional[Sequence[IdLike]] = None,
 ) -> FileQuery:
+
+    # verify types of passed arguments
+    _verify_string_sequence("file_names", file_names)
+    _verify_sequence("file_ids", file_ids)
+    _verify_string_sequence("mission_names", mission_names)
+    _verify_sequence("mission_ids", mission_ids)
+    _verify_string_sequence("project_names", project_names)
+    _verify_sequence("project_ids", project_ids)
+
     return FileQuery(
         ids=[parse_uuid_like(_id) for _id in file_ids or []],
         patterns=list(file_names or []),
@@ -288,6 +330,9 @@ def verify(
         project_names=singleton_list(project_name),
         project_ids=singleton_list(project_id),
     )
+
+    _verify_string_sequence("files", files)
+
     return kleinkram.core.verify(
         client=AuthenticatedClient(),
         query=query,

{kleinkram-0.43.5.dist-info → kleinkram-0.43.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kleinkram
-Version: 0.43.5
+Version: 0.43.6
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Author-email: pucyril@ethz.ch, dgarmier@ethz.ch, jschwab@ethz.ch

{kleinkram-0.43.5.dist-info → kleinkram-0.43.6.dist-info}/RECORD

@@ -11,11 +11,11 @@ kleinkram/printing.py,sha256=_vIjs-lPVgv21ER5q5iYtx44OTs5y8wyd32w27WqocM,12161
 kleinkram/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kleinkram/types.py,sha256=nfDjj8TB1Jn5vqO0Xg6qhLOuKom9DDhe62BrngqnVGM,185
 kleinkram/utils.py,sha256=AsKZxEGStn03L2tqqiMVCQCrDyl8HhwOfpa3no4dfYc,6767
-kleinkram/wrappers.py,sha256=4xXU43eNnvMG2sssU330MmTLSSRdurOpnZ-zNGOGmt0,11342
+kleinkram/wrappers.py,sha256=ZScoEov5Q6D2rvaJJ8E-4f58P_NGWrGc9mRPYxSqOC0,13127
 kleinkram/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kleinkram/api/client.py,sha256=VwuT97_WdbDpcVGwMXB0fRnUoQnUSf7BOP5eXUFokfI,5932
 kleinkram/api/deser.py,sha256=xRpYUFKZ0Luoo7XyAtYblJvprmpjNSZOiFVnFKmOzcM,4819
-kleinkram/api/file_transfer.py,sha256=smzT_gQjmJHeVYdlfmpCH6CRS_Swx-Kp-3Q8lvTNrqQ,17452
+kleinkram/api/file_transfer.py,sha256=IqQoKdpK9oqPllE4deell64VoP__vjKOU8lY2gao4vQ,17458
 kleinkram/api/pagination.py,sha256=P_zPsBKlMWkmAv-YfUNHaGW-XLB_4U8BDMrKyiDFIXk,1370
 kleinkram/api/query.py,sha256=9Exi4hJR7Ml38_zjAcOvSEoIAxZLlpM6QwwzO9fs5Gk,3293
 kleinkram/api/routes.py,sha256=x0IfzQO5RAC3rohDSpdUNlVOWl221gh4e0fbMKfGrQA,12251
@@ -43,8 +43,8 @@ tests/test_printing.py,sha256=Jz1AjqmqBRjp1JLm6H1oVJyvGaMPlahVXdKnd7UDQFc,2231
 tests/test_query.py,sha256=fExmCKXLA7-9j2S2sF_sbvRX_2s6Cp3a7OTcqE25q9g,3864
 tests/test_utils.py,sha256=eUBYrn3xrcgcaxm1X4fqZaX4tRvkbI6rh6BUbNbu9T0,4784
 tests/test_wrappers.py,sha256=TbcTyO2L7fslbzgfDdcVZkencxNQ8cGPZm_iB6c9d6Q,2673
-kleinkram-0.43.5.dist-info/METADATA,sha256=SSuH0PZniJ2cceZCexQvUGq5n69f54TANO4IWA9FBbY,2807
-kleinkram-0.43.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-kleinkram-0.43.5.dist-info/entry_points.txt,sha256=SaB2l5aqhSr8gmaMw2kvQU90a8Bnl7PedU8cWYxkfYo,46
-kleinkram-0.43.5.dist-info/top_level.txt,sha256=N3-sJagEHu1Tk1X6Dx1X1q0pLDNbDZpLzRxVftvepds,24
-kleinkram-0.43.5.dist-info/RECORD,,
+kleinkram-0.43.6.dist-info/METADATA,sha256=UXlKRQqqCEhxWPgaYC8Bd7ujsKiwHc3qjPIxz8hFJ6Y,2807
+kleinkram-0.43.6.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+kleinkram-0.43.6.dist-info/entry_points.txt,sha256=SaB2l5aqhSr8gmaMw2kvQU90a8Bnl7PedU8cWYxkfYo,46
+kleinkram-0.43.6.dist-info/top_level.txt,sha256=N3-sJagEHu1Tk1X6Dx1X1q0pLDNbDZpLzRxVftvepds,24
+kleinkram-0.43.6.dist-info/RECORD,,