kleinkram 0.43.2.dev20250331124109__py3-none-any.whl → 0.58.0.dev20260110152317__py3-none-any.whl

kleinkram/utils.py

@@ -28,15 +28,11 @@ from kleinkram.types import IdLike
 from kleinkram.types import PathLike
 
 INTERNAL_ALLOWED_CHARS = string.ascii_letters + string.digits + "_" + "-"
-SUPPORT_FILE_TYPES = [
-    ".bag",
-    ".mcap",
-]
+SUPPORT_FILE_TYPES = [".bag", ".mcap", ".db3", ".svo2", ".tum", ".yaml", ".yml"]
+EXPERIMENTAL_FILE_TYPES = []
 
 
-def file_paths_from_files(
-    files: Sequence[File], *, dest: Path, allow_nested: bool = False
-) -> Dict[Path, File]:
+def file_paths_from_files(files: Sequence[File], *, dest: Path, allow_nested: bool = False) -> Dict[Path, File]:
     """\
     determines the destinations for a sequence of `File` objects,
     possibly nested by project and mission
@@ -46,10 +42,7 @@ def file_paths_from_files(
     elif not allow_nested:
         return {dest / file.name: file for file in files}
     else:
-        return {
-            dest / file.project_name / file.mission_name / file.name: file
-            for file in files
-        }
+        return {dest / file.project_name / file.mission_name / file.name: file for file in files}
 
 
 def upper_camel_case_to_words(s: str) -> List[str]:
@@ -89,13 +82,10 @@ def check_file_path(file: Path) -> None:
     if not file.exists():
         raise FileNotFoundError(f"{file} does not exist")
     if file.suffix not in SUPPORT_FILE_TYPES:
-        raise FileTypeNotSupported(
-            f"only {', '.join(SUPPORT_FILE_TYPES)} files are supported: {file}"
-        )
+        raise FileTypeNotSupported(f"only {', '.join(SUPPORT_FILE_TYPES)} files are supported: {file}")
     if not check_filename_is_sanatized(file.stem):
         raise FileNameNotSupported(
-            f"only `{''.join(INTERNAL_ALLOWED_CHARS)}` are "
-            f"allowed in filenames and at most 50chars: {file}"
+            f"only `{''.join(INTERNAL_ALLOWED_CHARS)}` are " f"allowed in filenames and at most 50chars: {file}"
         )
 
 
@@ -108,9 +98,7 @@ def format_error(msg: str, exc: Exception, *, verbose: bool = False) -> str:
 
 
 def format_traceback(exc: Exception) -> str:
-    return "".join(
-        traceback.format_exception(type(exc), value=exc, tb=exc.__traceback__)
-    )
+    return "".join(traceback.format_exception(type(exc), value=exc, tb=exc.__traceback__))
 
 
 def styled_string(*objects: Any, **kwargs: Any) -> str:
@@ -150,9 +138,7 @@ def get_filename(path: Path) -> str:
         - the 10 hashed chars are deterministic given the original filename
     """
 
-    stem = "".join(
-        char if char in INTERNAL_ALLOWED_CHARS else "_" for char in path.stem
-    )
+    stem = "".join(char if char in INTERNAL_ALLOWED_CHARS else "_" for char in path.stem)
 
     if len(stem) > 50:
         hash = md5(path.name.encode()).hexdigest()
@@ -229,10 +215,10 @@ def format_bytes(size_bytes: int | float, speed: bool = False) -> str:
         return "0 B/s" if speed else "0 B"
 
     units = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
-    power = math.floor(math.log(size_bytes, 1024))
+    power = math.floor(math.log(size_bytes, 1000))
     unit_index = min(power, len(units) - 1)
 
-    value = size_bytes / (1024**unit_index)
+    value = size_bytes / (1000**unit_index)
 
     unit_suffix = "/s" if speed else ""
     return f"{value:.2f} {units[unit_index]}{unit_suffix}"

kleinkram/wrappers.py

@@ -9,6 +9,7 @@ conversion to the internal representation
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Any
 from typing import Collection
 from typing import Dict
 from typing import List
@@ -39,6 +40,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,15 +57,39 @@ 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 []),
-        project_query=_args_to_project_query(
-            project_names=project_names, project_ids=project_ids
-        ),
+        project_query=_args_to_project_query(project_names=project_names, project_ids=project_ids),
     )
 
 
+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 +98,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 +327,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,
@@ -313,15 +355,11 @@ def create_mission(
 
 
 def create_project(project_name: str, description: str) -> None:
-    kleinkram.api.routes._create_project(
-        AuthenticatedClient(), project_name, description
-    )
+    kleinkram.api.routes._create_project(AuthenticatedClient(), project_name, description)
 
 
 def update_file(file_id: IdLike) -> None:
-    kleinkram.core.update_file(
-        client=AuthenticatedClient(), file_id=parse_uuid_like(file_id)
-    )
+    kleinkram.core.update_file(client=AuthenticatedClient(), file_id=parse_uuid_like(file_id))
 
 
 def update_mission(mission_id: IdLike, metadata: Dict[str, str]) -> None:
@@ -354,48 +392,34 @@ def delete_file(file_id: IdLike) -> None:
     """\
     delete a single file by id
     """
-    file = kleinkram.api.routes.get_file(
-        AuthenticatedClient(), FileQuery(ids=[parse_uuid_like(file_id)])
-    )
-    kleinkram.api.routes._delete_files(
-        AuthenticatedClient(), file_ids=[file.id], mission_id=file.mission_id
-    )
+    file = kleinkram.api.routes.get_file(AuthenticatedClient(), FileQuery(ids=[parse_uuid_like(file_id)]))
+    kleinkram.api.routes._delete_files(AuthenticatedClient(), file_ids=[file.id], mission_id=file.mission_id)
 
 
 def delete_mission(mission_id: IdLike) -> None:
-    kleinkram.core.delete_mission(
-        client=AuthenticatedClient(), mission_id=parse_uuid_like(mission_id)
-    )
+    kleinkram.core.delete_mission(client=AuthenticatedClient(), mission_id=parse_uuid_like(mission_id))
 
 
 def delete_project(project_id: IdLike) -> None:
-    kleinkram.core.delete_project(
-        client=AuthenticatedClient(), project_id=parse_uuid_like(project_id)
-    )
+    kleinkram.core.delete_project(client=AuthenticatedClient(), project_id=parse_uuid_like(project_id))
 
 
 def get_file(file_id: IdLike) -> File:
     """\
     get a file by its id
     """
-    return kleinkram.api.routes.get_file(
-        AuthenticatedClient(), FileQuery(ids=[parse_uuid_like(file_id)])
-    )
+    return kleinkram.api.routes.get_file(AuthenticatedClient(), FileQuery(ids=[parse_uuid_like(file_id)]))
 
 
 def get_mission(mission_id: IdLike) -> Mission:
     """\
     get a mission by its id
     """
-    return kleinkram.api.routes.get_mission(
-        AuthenticatedClient(), MissionQuery(ids=[parse_uuid_like(mission_id)])
-    )
+    return kleinkram.api.routes.get_mission(AuthenticatedClient(), MissionQuery(ids=[parse_uuid_like(mission_id)]))
 
 
 def get_project(project_id: IdLike) -> Project:
     """\
     get a project by its id
     """
-    return kleinkram.api.routes.get_project(
-        AuthenticatedClient(), ProjectQuery(ids=[parse_uuid_like(project_id)])
-    )
+    return kleinkram.api.routes.get_project(AuthenticatedClient(), ProjectQuery(ids=[parse_uuid_like(project_id)]))

{kleinkram-0.43.2.dev20250331124109.dist-info → kleinkram-0.58.0.dev20260110152317.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kleinkram
-Version: 0.43.2.dev20250331124109
+Version: 0.58.0.dev20260110152317
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Author-email: pucyril@ethz.ch, dgarmier@ethz.ch, jschwab@ethz.ch
@@ -16,9 +16,11 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: boto3
 Requires-Dist: botocore
+Requires-Dist: click
 Requires-Dist: httpx
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml
+Requires-Dist: requests
 Requires-Dist: rich
 Requires-Dist: tqdm
 Requires-Dist: typer
@@ -75,7 +77,7 @@ Instead of downloading files from a specified mission you can download arbitrary
 klein download --dest out *id1* *id2* *id3*
 ```
 
-For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/python/getting-started.html).
+For more information consult the [documentation](https://docs.datasets.leggedrobotics.com//usage/python/setup).
 
 ## Development
 
@@ -117,7 +119,7 @@ pytest
 ```
 For the latter you need to have an instance of the backend running locally.
 See instructions in the root of the repository for this.
-On top of that these tests require particular files to be present in the `cli/data/testing` directory.
-To see the exact files that are required, see `cli/testing/backend_fixtures.py`.
+On top of that these tests require particular files to be present in the `cli/tests/data` directory.
+These files are automatically generated by the `cli/tests/generate_test_data.py` script.
 
 You also need to make sure to be logged in with the cli with `klein login`.

kleinkram-0.58.0.dev20260110152317.dist-info/RECORD

@@ -0,0 +1,53 @@
+kleinkram/__init__.py,sha256=xIJqTJw2kbCGryGlCeAdpmtR1FTxmrW1MklUNQEaj74,1061
+kleinkram/__main__.py,sha256=B9RiZxfO4jpCmWPUHyKJ7_EoZlEG4sPpH-nz7T_YhhQ,125
+kleinkram/_version.py,sha256=QYJyRTcqFcJj4qWYpqs7WcoOP6jxDMqyvxLY-cD6KcE,129
+kleinkram/auth.py,sha256=zbjSIPBS5xzLzo75Ou2dgUluXLwBRxKxBdSwtIQdA5g,6835
+kleinkram/config.py,sha256=fCRyDdBKXbH7HQ_Kc3YGTamqGL9zkKLRIIQTQDql0Ec,7273
+kleinkram/core.py,sha256=AhFIxm2jjzRUlGXrOJksebYHOyuioAcbpCx0WmbIpbs,9790
+kleinkram/errors.py,sha256=Bevo8LNPlM46C9JY_uj1Z3FSvPJ051Vyd0M9IYENLtc,1140
+kleinkram/main.py,sha256=BTE0mZN__xd46wBhFi6iBlK9eGGQvJ1LdUMsbnysLi0,172
+kleinkram/models.py,sha256=YB3pcZGJ5nXeZ9gLTbpaaWsUCnvaDIcnvpXUnyWZAaY,2824
+kleinkram/printing.py,sha256=U8I43Ju3orA_jKqF5f-vmgl3cC8Ffjo5m2fgChmY6ik,19163
+kleinkram/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kleinkram/types.py,sha256=nfDjj8TB1Jn5vqO0Xg6qhLOuKom9DDhe62BrngqnVGM,185
+kleinkram/utils.py,sha256=iPZXUbiG4cYfkL3CG-Rs-dwVovNYkgybfAAvD0oamBY,6725
+kleinkram/wrappers.py,sha256=TprQWvEw-8QsgcDNsQxjBkcEwVFQyfmclTpt8wcZ4tA,12967
+kleinkram/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kleinkram/api/client.py,sha256=j-ZWBsHI-PQOk86RtDfqunaSVyKqCnKdqPMy0tCbdNI,5840
+kleinkram/api/deser.py,sha256=94O1ZeP0kW-LaKaZeP4o1PQLeHbxxZ_C7nU2FzunntY,10077
+kleinkram/api/file_transfer.py,sha256=j1iINYFV4iXMjAz59eM6y8G35Uq4GpPgqf1T0z73Jzs,19710
+kleinkram/api/pagination.py,sha256=NRVGorgNthKi4t_H9lOn87rDebx33WVOvTadA6-4QXw,1693
+kleinkram/api/query.py,sha256=WR_j0WRt9LDW9uyqc8pEdjmgN5eOLVQi1y3LSOh2Y9A,3498
+kleinkram/api/routes.py,sha256=zKgjEiuFP-v06pBnN87yLcdYyuAV4Jx-hbEf44qu_e4,17461
+kleinkram/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kleinkram/cli/_action.py,sha256=Gb3kIs4jcutINX4pmrnOjhetcEpeAGVs3llX0GR9gz0,4911
+kleinkram/cli/_download.py,sha256=n4d9y8ViTLnzrfn8MLaM_6Jlsuh9_Y_F0I-dfAhZEqI,2318
+kleinkram/cli/_endpoint.py,sha256=dFLTaARXP96ide4J4cOHx5qHc3_iFYGJmhz-fKLGbP8,1785
+kleinkram/cli/_file.py,sha256=CiTmy3Di7lVBH7mfsNbWpiwyDl8WGw0xi8MV0-EmAV4,2897
+kleinkram/cli/_file_validator.py,sha256=6SkQGNysq1ydZimfv7MmAqyRP7xiKwaWcoK7R-tL_M4,4552
+kleinkram/cli/_list.py,sha256=jDZlG76b0KWr8imBQdA--V2DC6O3j6jrMd6qyJm6cTw,3028
+kleinkram/cli/_mission.py,sha256=nZjk9gHsTCMkmwbtNMIb9fxfySyggc3nGJdTC0t45G4,5759
+kleinkram/cli/_project.py,sha256=C6mnNJM4oloFto9wDY4zgwdmXNsqR9ErbgZeFdhCENk,3338
+kleinkram/cli/_run.py,sha256=TRx08DPB4PRGIqZl2CjHEDODgQac3Jr7iNQqBN9A7nE,8008
+kleinkram/cli/_upload.py,sha256=PkD9O4ApBo5VUxdt70pu0XdJqZ88FrY_vZWQzTtN0pg,4030
+kleinkram/cli/_verify.py,sha256=j-bRmFqW2j88ZwVOSFEy0Dgok-JY0nAPkcTAOwgxQyY,3211
+kleinkram/cli/app.py,sha256=fpme23Y6pd2LeTadcFYBNfyjDn4AEGltSJVg79GCDAI,8940
+kleinkram/cli/error_handling.py,sha256=ZFcJhPXWITG1cGpnsiuDVVehjIqO5pbz47zWdL1QcQs,1907
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/backend_fixtures.py,sha256=Kjr1W9NYQ1yCOqLheAIILYeTo9B59WW1M0FMr2MPKew,2308
+tests/conftest.py,sha256=0kbRbC4AJhwjOlZYdwkzQHLBmcrU5pB3o76PImunP4c,102
+tests/generate_test_data.py,sha256=TkyB208mHRs1wINq0aHOfWt5J0ad4umnATPSnHgkENY,11799
+tests/test_config.py,sha256=RUIUEqTnAKg8EyqXVGohwfm9jtuaWo1hWqVxZMV6_bU,5843
+tests/test_core.py,sha256=qIPYuMpI3yh2G6OEqqqjRCWlvaM9bd9VC0bB5kI7PJs,5473
+tests/test_end_to_end.py,sha256=mySbCPZPmrszo2AjD18TDitrPAJJ73oz7DaBpTXIkiI,3337
+tests/test_error_handling.py,sha256=qPSMKF1qsAHyUME0-krxbIrk38iGKkhAyAah-KwN4NE,1300
+tests/test_fixtures.py,sha256=SaOe7naSqGH3nivdbwyNo1tcYOg_XU-NJy1cFv3__2o,1053
+tests/test_printing.py,sha256=Kfg0XjGV7ymvI4RgHtNc8wiwpqB3VG0wc1XYWO1ld_k,2217
+tests/test_query.py,sha256=fExmCKXLA7-9j2S2sF_sbvRX_2s6Cp3a7OTcqE25q9g,3864
+tests/test_utils.py,sha256=_DGxsQ60YEKeLNmrwLdJbevSFhWgIK9f38fH02VA8MI,4762
+tests/test_wrappers.py,sha256=Jr7qFbkEBbs21S-SkwF8A5cH-OcFsVz0Y0kBc6gGBuY,2547
+kleinkram-0.58.0.dev20260110152317.dist-info/METADATA,sha256=bNsmokgdVcrAZPIx6CzVWcNI624Ayy1EWrDuKkdDfyQ,2862
+kleinkram-0.58.0.dev20260110152317.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kleinkram-0.58.0.dev20260110152317.dist-info/entry_points.txt,sha256=SaB2l5aqhSr8gmaMw2kvQU90a8Bnl7PedU8cWYxkfYo,46
+kleinkram-0.58.0.dev20260110152317.dist-info/top_level.txt,sha256=G1Lj9vHAtZn402Ukkrfll-6BCmnDNy_HVtWeNvXzdDA,16
+kleinkram-0.58.0.dev20260110152317.dist-info/RECORD,,

{kleinkram-0.43.2.dev20250331124109.dist-info → kleinkram-0.58.0.dev20260110152317.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{kleinkram-0.43.2.dev20250331124109.dist-info → kleinkram-0.58.0.dev20260110152317.dist-info}/top_level.txt

@@ -1,3 +1,2 @@
 kleinkram
-testing
 tests

{testing → tests}/backend_fixtures.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import subprocess
+import sys
 import time
 from pathlib import Path
 from secrets import token_hex
@@ -14,7 +16,7 @@ from kleinkram import list_projects
 from kleinkram import upload
 
 # we expect the mission files to be in this folder that is not commited to the repo
-DATA_PATH = Path(__file__).parent.parent / "data" / "testing"
+DATA_PATH = Path(__file__).parent / "data"
 DATA_FILES = [
     DATA_PATH / "10_KB.bag",
     DATA_PATH / "50_KB.bag",
@@ -26,7 +28,7 @@ DATA_FILES = [
 PROJECT_DESCRIPTION = "This is a test project"
 
 
-WAIT_BEOFORE_DELETION = 5
+WAIT_BEFORE_DELETION = 5
 
 
 @pytest.fixture(scope="session")
@@ -38,7 +40,7 @@ def project():
 
     yield project
 
-    time.sleep(WAIT_BEOFORE_DELETION)
+    time.sleep(WAIT_BEFORE_DELETION)
     delete_project(project.id)
 
 
@@ -63,3 +65,25 @@ def empty_mission(project):
     mission = list_missions(project_ids=[project.id], mission_names=[mission_name])[0]
 
     yield mission
+
+
+@pytest.fixture(scope="session", autouse=True)
+def auto_login():
+    """
+    Automatically logs in using the CLI before running any tests.
+    """
+    try:
+        # Run: python3 -m kleinkram login --user 1
+        result = subprocess.run(
+            [sys.executable, "-m", "kleinkram", "login", "--user", "1"],
+            cwd=str(Path(__file__).parent.parent),  # Run from cli root
+            capture_output=True,
+            text=True,
+        )
+        if result.returncode != 0:
+            pytest.fail(
+                f"Failed to auto-login. Return code: {result.returncode}\nStdout: {result.stdout}\nStderr: {result.stderr}"
+            )
+
+    except Exception as e:
+        pytest.fail(f"Failed to auto-login: {e}")

tests/conftest.py

@@ -3,5 +3,5 @@ from __future__ import annotations
 import pytest
 
 pytest_plugins = [
-    "testing.backend_fixtures",
+    "tests.backend_fixtures",
 ]