kleinkram 0.41.1.dev20250303132129__tar.gz → 0.41.2__tar.gz

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kleinkram
-Version: 0.41.1.dev20250303132129
+Version: 0.41.2
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/kleinkram/api/client.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import logging
 from collections import abc
+from pathlib import Path
 from threading import Lock
 from typing import Any
 from typing import List
@@ -13,6 +14,9 @@ from typing import Union
 import httpx
 from httpx._types import PrimitiveData
 
+import kleinkram.errors
+from kleinkram._version import __version__
+from kleinkram.config import CONFIG_PATH
 from kleinkram.config import Config
 from kleinkram.config import Credentials
 from kleinkram.config import get_config
@@ -26,6 +30,8 @@ COOKIE_AUTH_TOKEN = "authtoken"
 COOKIE_REFRESH_TOKEN = "refreshtoken"
 COOKIE_API_KEY = "clikey"
 
+CLI_VERSION_HEADER = "Kleinkram-Client-Version"
+
 
 Data = Union[PrimitiveData, Any]
 NestedData = Mapping[str, Data]
@@ -65,10 +71,12 @@ class AuthenticatedClient(httpx.Client):
     _config: Config
     _config_lock: Lock
 
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
+    def __init__(
+        self, config_path: Path = CONFIG_PATH, *args: Any, **kwargs: Any
+    ) -> None:
         super().__init__(*args, **kwargs)
 
-        self._config = get_config()
+        self._config = get_config(path=config_path)
         self._config_lock = Lock()
 
         if self._config.credentials is None:
@@ -95,9 +103,7 @@ class AuthenticatedClient(httpx.Client):
         self.cookies.set(COOKIE_REFRESH_TOKEN, refresh_token)
 
         logger.info("refreshing token...")
-        response = self.post(
-            "/auth/refresh-token",
-        )
+        response = self.post("/auth/refresh-token")
         response.raise_for_status()
         new_access_token = response.cookies[COOKIE_AUTH_TOKEN]
         creds = Credentials(auth_token=new_access_token, refresh_token=refresh_token)
@@ -110,6 +116,22 @@ class AuthenticatedClient(httpx.Client):
 
         self.cookies.set(COOKIE_AUTH_TOKEN, new_access_token)
 
+    def _send_request_with_kleinkram_headers(
+        self, *args: Any, **kwargs: Any
+    ) -> httpx.Response:
+        # add the cli version to the headers
+        headers = kwargs.get("headers") or {}
+        headers.setdefault(CLI_VERSION_HEADER, __version__)
+        kwargs["headers"] = headers
+
+        # send the request
+        response = super().request(*args, **kwargs)
+
+        # check version compatibility
+        if response.status_code == 426:
+            raise kleinkram.errors.UpdateCLIVersion
+        return response
+
     def request(
         self,
         method: str,
@@ -128,7 +150,7 @@ class AuthenticatedClient(httpx.Client):
         logger.info(f"requesting {method} {full_url}")
 
         httpx_params = _convert_query_params_to_httpx_format(params or {})
-        response = super().request(
+        response = self._send_request_with_kleinkram_headers(
             method, full_url, params=httpx_params, *args, **kwargs
         )
 
@@ -148,10 +170,10 @@ class AuthenticatedClient(httpx.Client):
                 raise NotAuthenticated
 
             logger.info(f"retrying request {method} {full_url}")
-            resp = super().request(
+            response = self._send_request_with_kleinkram_headers(
                 method, full_url, params=httpx_params, *args, **kwargs
             )
-            logger.info(f"got response {resp}")
-            return resp
+            logger.info(f"got response {response}")
+            return response
         else:
             return response

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/kleinkram/core.py

@@ -210,6 +210,10 @@ def delete_files(*, client: AuthenticatedClient, file_ids: Collection[UUID]) ->
     """\
     deletes multiple files accross multiple missions
     """
+    if not file_ids:
+        return
+
+    # we need to check that file_ids is not empty, otherwise this is bad
     files = list(kleinkram.api.routes.get_files(client, FileQuery(ids=list(file_ids))))
 
     # check if all file_ids were actually found
@@ -220,6 +224,9 @@ def delete_files(*, client: AuthenticatedClient, file_ids: Collection[UUID]) ->
                 f"file {file_id} not found, did not delete any files"
             )
 
+    # to prevent catastrophic mistakes from happening *again*
+    assert set(file_ids) == set([file.id for file in files]), "unreachable"
+
     # we can only batch delete files within the same mission
     missions_to_files: Dict[UUID, List[UUID]] = {}
     for file in files:

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/kleinkram/errors.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 LOGIN_MESSAGE = "Please login using `klein login`."
+UPDATE_MESSAGE = "Please update your CLI using `pip install --upgrade kleinkram`."
 
 
 class ParsingError(Exception): ...
@@ -33,11 +34,6 @@ class FileNotFound(Exception): ...
 class AccessDenied(Exception): ...
 
 
-class NotAuthenticated(Exception):
-    def __init__(self) -> None:
-        super().__init__(LOGIN_MESSAGE)
-
-
 class InvalidCLIVersion(Exception): ...
 
 
@@ -48,3 +44,13 @@ class FileNameNotSupported(Exception): ...
 
 
 class InvalidMissionMetadata(Exception): ...
+
+
+class NotAuthenticated(Exception):
+    def __init__(self) -> None:
+        super().__init__(LOGIN_MESSAGE)
+
+
+class UpdateCLIVersion(Exception):
+    def __init__(self) -> None:
+        super().__init__(UPDATE_MESSAGE)

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/kleinkram/printing.py

@@ -273,7 +273,7 @@ def project_info_table(project: Project) -> Table:
 
 
 def file_verification_status_table(
-    file_status: Mapping[Path, FileVerificationStatus]
+    file_status: Mapping[Path, FileVerificationStatus],
 ) -> Table:
     table = Table(title="file status")
     table.add_column("filename", style="cyan")

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/kleinkram.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kleinkram
-Version: 0.41.1.dev20250303132129
+Version: 0.41.2
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = kleinkram
-version = 0.41.1-dev20250303132129
+version = 0.41.2
 description = give me your bags
 long_description = file: README.md
 long_description_content_type = text/markdown

{kleinkram-0.41.1.dev20250303132129 → kleinkram-0.41.2}/tests/test_core.py

@@ -77,6 +77,19 @@ def test_delete_existing_files(mission):
     assert not list_files(mission_ids=[mission.id], file_names=["*.bag"])
 
 
+@pytest.mark.slow
+def test_delete_working_as_expected_when_passing_empty_list(mission):
+    client = AuthenticatedClient()
+
+    # we need to filter by *.bag to not get flakyness due to conversion
+    n_files = len(list_files(mission_ids=[mission.id], file_names=["*.bag"]))
+    kleinkram.core.delete_files(client=client, file_ids=[])
+    n_files_after_delete = len(
+        list_files(mission_ids=[mission.id], file_names=["*.bag"])
+    )
+    assert n_files == n_files_after_delete
+
+
 @pytest.mark.slow
 def test_delete_non_existing_files():
     client = AuthenticatedClient()