Add comment about file_name usage

Signed-off-by: Donny Peeters <[email protected]>
minvws · Sep 5, 2024 · a785b56 · a785b56
1 parent 56730ae
commit a785b56
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/boefjes/boefjes/clients/bytes_client.py b/boefjes/boefjes/clients/bytes_client.py
@@ -100,7 +100,7 @@ def get_normalizer_meta(self, normalizer_meta_id: uuid.UUID) -> NormalizerMeta:
 
     @retry_with_login
     def save_raw(self, boefje_meta_id: str, raw: str | bytes, mime_types: Set[str] = frozenset()) -> UUID:
-        file_name = "raw"
+        file_name = "raw"  # The name provides a key for all ids returned, so this is arbitrary as we only upload 1 file
 
         response = self._session.post(
             "/bytes/raw",

diff --git a/bytes/tests/client.py b/bytes/tests/client.py
@@ -127,7 +127,7 @@ def save_raw(self, boefje_meta_id: UUID, raw: bytes, mime_types: list[str] | Non
         if not mime_types:
             mime_types = []
 
-        file_name = "raw"
+        file_name = "raw"  # The name provides a key for all ids returned, so this is arbitrary as we only upload 1 file
         response = self.client.post(
             "/bytes/raw",
             json={

diff --git a/rocky/rocky/bytes_client.py b/rocky/rocky/bytes_client.py
@@ -114,7 +114,7 @@ def _save_normalizer_meta(self, normalizer_meta: NormalizerMeta) -> None:
         response.raise_for_status()
 
     def _save_raw(self, boefje_meta_id: uuid.UUID, raw: bytes, mime_types: Set[str] = frozenset()) -> str:
-        file_name = "raw"
+        file_name = "raw"  # The name provides a key for all ids returned, so this is arbitrary as we only upload 1 file
 
         response = self.session.post(
             "/bytes/raw",