proteworks 0.1.2__tar.gz → 0.1.3__tar.gz

{proteworks-0.1.2 → proteworks-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proteworks
-Version: 0.1.2
+Version: 0.1.3
 Summary: Sync files with Proteworks using file-browser paths.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{proteworks-0.1.2 → proteworks-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "proteworks"
-version = "0.1.2"
+version = "0.1.3"
 description = "Sync files with Proteworks using file-browser paths."
 readme = "README.md"
 requires-python = ">=3.11"

{proteworks-0.1.2 → proteworks-0.1.3}/src/proteworks/api.py

@@ -88,19 +88,21 @@ class ApiClient:
             params={"path": path, "offset": offset, "limit": limit},
         )
 
-    def manifest_all(self, path: str) -> dict:
+    def manifest_all(self, path: str, *, on_list_progress=None, page_size: int = 500) -> dict:
         """Follow pages. Returns items plus root_folder_id from the first page."""
         offset = 0
         items: list[dict] = []
         root_folder_id = None
         total = None
         while True:
-            page = self.manifest(path, offset)
+            page = self.manifest(path, offset, limit=page_size)
             root_folder_id = root_folder_id or page.get("root_folder_id")
             batch = list(page.get("items") or [])
             items.extend(batch)
             total = int(page.get("total") or 0)
             offset += len(batch)
+            if on_list_progress is not None:
+                on_list_progress(offset, total)
             if not batch or offset >= total:
                 break
         return {"items": items, "total": total or 0, "root_folder_id": root_folder_id}
@@ -112,17 +114,19 @@ class ApiClient:
             params={"offset": offset, "limit": limit},
         )
 
-    def export_all(self) -> dict:
+    def export_all(self, *, on_list_progress=None, page_size: int = 500) -> dict:
         """Follow export pages. Returns every item for the active organization."""
         offset = 0
         items: list[dict] = []
         total = None
         while True:
-            page = self.export_page(offset)
+            page = self.export_page(offset, limit=page_size)
             batch = list(page.get("items") or [])
             items.extend(batch)
             total = int(page.get("total") or 0)
             offset += len(batch)
+            if on_list_progress is not None:
+                on_list_progress(offset, total)
             if not batch or offset >= total:
                 break
         return {"items": items, "total": total or 0}

{proteworks-0.1.2 → proteworks-0.1.3}/src/proteworks/pull.py

@@ -20,10 +20,19 @@ from proteworks.index import (
 _CONTENT_URL_BATCH = 100
 
 
+def _list_progress(stderr):
+    """Print how many paths the API has returned so far."""
+
+    def report(listed: int, total: int) -> None:
+        print(f"Listed {listed}/{total}", file=stderr)
+
+    return report
+
+
 def pull_path(api: ApiClient, remote: str, dest: Path, *, dry_run: bool, stderr) -> int:
     """Download readable files for a file-browser path. Returns a process status code."""
     try:
-        page = api.manifest_all(remote)
+        page = api.manifest_all(remote, on_list_progress=_list_progress(stderr))
     except ApiError as exc:
         print(str(exc), file=stderr)
         return 1
@@ -35,7 +44,7 @@ def pull_path(api: ApiClient, remote: str, dest: Path, *, dry_run: bool, stderr)
 def export_organization(api: ApiClient, dest: Path, *, dry_run: bool, stderr) -> int:
     """Download every live file in the active organization. Returns a process status code."""
     try:
-        page = api.export_all()
+        page = api.export_all(on_list_progress=_list_progress(stderr))
     except ApiError as exc:
         print(str(exc), file=stderr)
         return 1

{proteworks-0.1.2 → proteworks-0.1.3}/src/proteworks/push.py

@@ -20,7 +20,10 @@ def push_directory(api: ApiClient, local_dir: Path, remote: str, *, dry_run: boo
         print(str(exc), file=stderr)
         return 2
     try:
-        page = api.manifest_all(remote)
+        page = api.manifest_all(
+            remote,
+            on_list_progress=lambda listed, total: print(f"Listed {listed}/{total}", file=stderr),
+        )
     except ApiError as exc:
         print(str(exc), file=stderr)
         return 1

{proteworks-0.1.2 → proteworks-0.1.3}/src/proteworks.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proteworks
-Version: 0.1.2
+Version: 0.1.3
 Summary: Sync files with Proteworks using file-browser paths.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{proteworks-0.1.2 → proteworks-0.1.3}/tests/test_cli.py

@@ -13,6 +13,7 @@ from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
 from pathlib import Path
 from urllib.parse import parse_qs, urlparse
 
+from proteworks.api import ApiClient
 from proteworks.auth import loopback_redirect_uri, open_browser
 from proteworks.cli import main
 from proteworks.config import Settings
@@ -91,13 +92,16 @@ class FakeApi(threading.Thread):
                     return
                 if parsed.path == "/api/v1/sync/manifest":
                     query = parse_qs(parsed.query)
+                    offset = int((query.get("offset") or ["0"])[0])
+                    limit = int((query.get("limit") or ["500"])[0])
+                    page = parent.items[offset : offset + limit]
                     self._send(
                         200,
                         {
-                            "items": parent.items,
+                            "items": page,
                             "total": len(parent.items),
-                            "limit": 500,
-                            "offset": 0,
+                            "limit": limit,
+                            "offset": offset,
                             "root_folder_id": parent.root_folder_id,
                             "cloud_storage_url": GS_URL,
                         },
@@ -110,14 +114,18 @@ class FakeApi(threading.Thread):
                         status, payload = parent.export_error
                         self._send(status, payload)
                         return
+                    query = parse_qs(parsed.query)
+                    offset = int((query.get("offset") or ["0"])[0])
+                    limit = int((query.get("limit") or ["500"])[0])
                     exported = parent.export_items or []
+                    page = exported[offset : offset + limit]
                     self._send(
                         200,
                         {
-                            "items": exported,
+                            "items": page,
                             "total": len(exported),
-                            "limit": 500,
-                            "offset": 0,
+                            "limit": limit,
+                            "offset": offset,
                             "cloud_storage_url": GS_URL,
                         },
                     )
@@ -333,7 +341,29 @@ def test_pull_with_two_regular_orgs_stops_before_manifest(tmp_path, capsys):
     assert not any(path == "/api/v1/sync/manifest" for _method, path, _body in server.requests)
 
 
-def test_pull_mints_download_urls_in_one_batch(tmp_path):
+def test_manifest_all_reports_listing_progress():
+    items = []
+    for index in range(5):
+        item = _item(f"~/My Files/msa/{index}.cif")
+        item["file_id"] = f"f{index}"
+        items.append(item)
+    server = FakeApi([_org("reg", "Research")], items).start()
+    progress = []
+    try:
+        api = ApiClient(server.url, "token", organization_id="reg")
+        page = api.manifest_all(
+            "~/My Files/msa/",
+            on_list_progress=lambda listed, total: progress.append((listed, total)),
+            page_size=2,
+        )
+    finally:
+        api.close()
+        server.stop()
+    assert len(page["items"]) == 5
+    assert progress == [(2, 5), (4, 5), (5, 5)]
+
+
+def test_pull_mints_download_urls_in_one_batch(tmp_path, capsys):
     items = []
     for name in ("a.cif", "b.cif", "c.cif"):
         item = _item(f"~/My Files/msa/{name}")
@@ -355,7 +385,9 @@ def test_pull_mints_download_urls_in_one_batch(tmp_path):
         for method, path, body in server.requests
         if method == "POST" and path == "/api/v1/files/content-urls"
     ]
+    err = capsys.readouterr().err
     assert code == 0
+    assert "Listed 3/3" in err
     assert len(posts) == 1
     assert set(posts[0]["file_ids"]) == {"a.cif", "b.cif", "c.cif"}
     assert posts[0]["purpose"] == "download"