Address review feedback: types, tests, remove type: ignore

  - Use _FileBase + Union[_FileWithUid, _FileWithPuid] instead of
    NotRequired on both uid/puid fields
  - Type size as Union[int, str] to reflect actual server responses
  - Replace # type: ignore with cast(AsyncIterator[None], streamer)
  - Add unit tests for _file_key and files_from_page
  - Make conftest server args optional so unit tests run without a server

  Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: Robert Denham

filesender/api.py

@@ -1,4 +1,4 @@
-from typing import Any, Iterable, List, Optional, Tuple, AsyncIterator, Union
+from typing import Any, Iterable, List, Optional, Tuple, AsyncIterator, Union, cast
 from filesender.download import files_from_page, DownloadFile
 import filesender.response_types as response
 import filesender.request_types as request
@@ -102,7 +102,8 @@ def iter_files(paths: Iterable[Path], root: Optional[Path] = None) -> Iterable[T
 def _file_key(file_info: response.File) -> str:
     """
     Returns the per-file upload key, checking both ``uid`` (older FileSender servers)
-    and ``puid`` (newer FileSender servers).
+    and ``puid`` (newer FileSender servers). The field was renamed in
+    https://github.com/filesender/filesender/pull/2429.
     """
     if "uid" in file_info:
         return file_info["uid"]
@@ -333,7 +334,7 @@ async def _task_generator(chunk_size: int) -> AsyncIterator[Tuple[response.File,
             task_limit=self.concurrent_chunks
         )
        ).stream() as streamer:
-            async for _ in tqdm(streamer, total=math.ceil(int(file_info["size"]) / self.chunk_size), desc=file_info["name"]): # type: ignore
+            async for _ in tqdm(cast(AsyncIterator[None], streamer), total=math.ceil(int(file_info["size"]) / self.chunk_size), desc=file_info["name"]):
                 pass
 
     async def _upload_chunk(
@@ -441,7 +442,7 @@ async def download_file(
             file_path.parent.mkdir(parents=True, exist_ok=True)
             chunk_size = 8192
             chunk_size_mb = chunk_size / 1024 / 1024
-            with tqdm(desc=file_name, unit="MB", total=None if file_size is None else int(int(file_size) / 1024 / 1024)) as progress:
+            with tqdm(desc=file_name, unit="MB", total=None if file_size is None else int(file_size / 1024 / 1024)) as progress:
                 async with aiofiles.open(out_dir / file_name, "wb") as fp:
                     # We can't add the total here, because we don't know it: 
                     # https://github.com/filesender/filesender/issues/1555

filesender/response_types.py

@@ -1,15 +1,21 @@
-from typing import List
-from typing_extensions import TypedDict, NotRequired
+from typing import List, Union
+from typing_extensions import TypedDict
 
-class File(TypedDict):
+class _FileBase(TypedDict):
     id: int
     transfer_id: int
-    uid: NotRequired[str]   # older FileSender servers
-    puid: NotRequired[str]  # newer FileSender servers
     name: str
-    size: int
+    size: Union[int, str]  # some FileSender servers return this as a string
     sha1: str
 
+class _FileWithUid(_FileBase):
+    uid: str
+
+class _FileWithPuid(_FileBase):
+    puid: str
+
+File = Union[_FileWithUid, _FileWithPuid]
+
 class Date(TypedDict):
     raw: int
     formatted: str

test/conftest.py

@@ -1,20 +1,22 @@
-from pytest import Parser, Metafunc
+from pytest import Parser, Metafunc, skip
 
 def pytest_addoption(parser: Parser):
-    # Require the user to provide these arguments
-    parser.addoption("--base-url", required=True)
-    parser.addoption("--apikey", required=True)
-    parser.addoption("--username", required=True)
+    parser.addoption("--base-url", required=False)
+    parser.addoption("--apikey", required=False)
+    parser.addoption("--username", required=False)
     parser.addoption("--delay", required=False, default="0")
-    parser.addoption("--recipient", help="Email address that will be used as the recipient of the invitations", required=True)
+    parser.addoption("--recipient", help="Email address that will be used as the recipient of the invitations", required=False)
 
 def pytest_generate_tests(metafunc: Metafunc):
     argnames = []
     argvalues = []
 
     for fixture in metafunc.fixturenames:
         if hasattr(metafunc.config.option, fixture):
+            value = getattr(metafunc.config.option, fixture)
+            if value is None:
+                skip(f"--{fixture} not provided")
             argnames.append(fixture)
-            argvalues.append(getattr(metafunc.config.option, fixture))
+            argvalues.append(value)
 
     metafunc.parametrize(argnames, [argvalues])

test/test_utils.py

@@ -1,6 +1,120 @@
-from filesender.api import iter_files
+from filesender.api import iter_files, _file_key
+from filesender.response_types import _FileWithUid, _FileWithPuid
+from filesender.download import files_from_page
 from pathlib import Path
 import tempfile
+import pytest
+
+
+# Minimal file dicts matching the structure of the real API response
+
+FILE_WITH_UID: _FileWithUid = {
+    "id": 28000001,
+    "transfer_id": 3500001,
+    "uid": "abc123def456",
+    "name": "example.txt",
+    "size": 1024,
+    "sha1": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
+}
+
+FILE_WITH_PUID: _FileWithPuid = {
+    "id": 28622026,
+    "transfer_id": 3573766,
+    "puid": "91dc452a-7d5c-4e34-9bee-6bc44fa5e012",
+    "name": "final_train.h5",
+    "size": "5243079740",  # AARNet server returns size as a string
+    "sha1": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
+}
+
+# Minimal HTML matching the structure of the FileSender download page
+
+DOWNLOAD_PAGE_ENCRYPTED = b"""
+<html><body>
+<div class="file"
+    data-id="1"
+    data-transfer-id="1"
+    data-name="secret.txt"
+    data-size="1024"
+    data-mime="text/plain"
+    data-encrypted="1"
+    data-encrypted-size="1040"
+    data-fileiv="aabbccdd"
+    data-fileaead="eeff0011"
+    data-key-version="1"
+    data-key-salt="saltsalt"
+    data-client-entropy="entropydata"
+    data-password-version="1"
+    data-password-encoding="base64"
+    data-password-hash-iterations="10000"
+    data-transferid="1">
+</div>
+</body></html>
+"""
+
+DOWNLOAD_PAGE_UNENCRYPTED = b"""
+<html><body>
+<div class="file"
+    data-id="2"
+    data-transfer-id="2"
+    data-name="plain.txt"
+    data-size="2048"
+    data-mime="text/plain"
+    data-encrypted="0"
+    data-encrypted-size=""
+    data-fileiv=""
+    data-fileaead=""
+    data-key-version=""
+    data-key-salt=""
+    data-client-entropy=""
+    data-password-version=""
+    data-password-encoding=""
+    data-password-hash-iterations=""
+    data-transferid="2">
+</div>
+</body></html>
+"""
+
+
+def test_file_key_uid():
+    assert _file_key(FILE_WITH_UID) == "abc123def456"
+
+
+def test_file_key_puid():
+    assert _file_key(FILE_WITH_PUID) == "91dc452a-7d5c-4e34-9bee-6bc44fa5e012"
+
+
+def test_file_key_neither():
+    file: _FileWithUid = {
+        "id": 1,
+        "transfer_id": 1,
+        "uid": "x",
+        "name": "test.txt",
+        "size": 0,
+        "sha1": "",
+    }
+    # Strip the uid at runtime to simulate a response with neither field
+    d = dict(file)
+    del d["uid"]
+    with pytest.raises(Exception, match="neither 'uid' nor 'puid'"):
+        _file_key(d)  # type: ignore[arg-type]
+
+
+def test_files_from_page_encrypted():
+    (file,) = files_from_page(DOWNLOAD_PAGE_ENCRYPTED)
+    assert file["name"] == "secret.txt"
+    assert file["size"] == 1024
+    assert file["encrypted_size"] == 1040
+    assert file["key_version"] == 1
+    assert file["password_hash_iterations"] == 10000
+
+
+def test_files_from_page_unencrypted():
+    (file,) = files_from_page(DOWNLOAD_PAGE_UNENCRYPTED)
+    assert file["name"] == "plain.txt"
+    assert file["size"] == 2048
+    assert file["encrypted_size"] is None
+    assert file["key_version"] is None
+    assert file["password_hash_iterations"] is None
 
 def test_iter_files():
     with tempfile.TemporaryDirectory() as _tempdir: