Default audit log downloads to gzip

Author: yummybomb

src/kernel/resources/audit_logs.py

@@ -237,7 +237,6 @@ def download(
         start: Union[str, datetime],
         auth_strategy: str | Omit = omit,
         exclude_method: SequenceNotStr[str] | Omit = omit,
-        format: Literal["jsonl", "jsonl.gz"] | Omit = omit,
         limit: int | Omit = omit,
         method: str | Omit = omit,
         search: str | Omit = omit,
@@ -250,12 +249,13 @@ def download(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AuditLogDownloadResult:
-        """Download a complete audit log export to a writable binary destination.
+        """Download a complete gzip-compressed JSON Lines audit log export.
 
-        The SDK verifies every chunk and retries transient transfer failures. It
-        does not close the destination. If the download fails, the destination
-        may contain a partial export; use a temporary file and atomic rename
-        when the completed export must be published atomically.
+        The SDK writes the export to a writable binary destination, verifies
+        every chunk, and retries transient transfer failures. It does not close
+        the destination. If the download fails, the destination may contain a
+        partial export; use a temporary file and atomic rename when the completed
+        export must be published atomically.
         """
 
         def fetch_chunk(cursor: str | None) -> ContextManager[StreamedBinaryAPIResponse]:
@@ -265,7 +265,6 @@ def fetch_chunk(cursor: str | None) -> ContextManager[StreamedBinaryAPIResponse]
                 auth_strategy=auth_strategy,
                 cursor=cursor if cursor is not None else omit,
                 exclude_method=exclude_method,
-                format=format,
                 limit=limit,
                 method=method,
                 search=search,
@@ -481,7 +480,6 @@ async def download(
         start: Union[str, datetime],
         auth_strategy: str | Omit = omit,
         exclude_method: SequenceNotStr[str] | Omit = omit,
-        format: Literal["jsonl", "jsonl.gz"] | Omit = omit,
         limit: int | Omit = omit,
         method: str | Omit = omit,
         search: str | Omit = omit,
@@ -494,12 +492,13 @@ async def download(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AuditLogDownloadResult:
-        """Download a complete audit log export to a writable binary destination.
+        """Download a complete gzip-compressed JSON Lines audit log export.
 
-        The SDK verifies every chunk and retries transient transfer failures. It
-        does not close the destination. If the download fails, the destination
-        may contain a partial export; use a temporary file and atomic rename
-        when the completed export must be published atomically.
+        The SDK writes the export to a writable binary destination, verifies
+        every chunk, and retries transient transfer failures. It does not close
+        the destination. If the download fails, the destination may contain a
+        partial export; use a temporary file and atomic rename when the completed
+        export must be published atomically.
         """
 
         def fetch_chunk(cursor: str | None) -> AsyncContextManager[AsyncStreamedBinaryAPIResponse]:
@@ -509,7 +508,6 @@ def fetch_chunk(cursor: str | None) -> AsyncContextManager[AsyncStreamedBinaryAP
                 auth_strategy=auth_strategy,
                 cursor=cursor if cursor is not None else omit,
                 exclude_method=exclude_method,
-                format=format,
                 limit=limit,
                 method=method,
                 search=search,

tests/test_audit_log_download.py

@@ -55,9 +55,11 @@ def test_download_writes_verified_chunks(client: Kernel, respx_mock: MockRouter)
         ]
     )
     cursors: list[str | None] = []
+    formats: list[str | None] = []
 
     def respond(request: httpx.Request) -> httpx.Response:
         cursors.append(request.url.params.get("cursor"))
+        formats.append(request.url.params.get("format"))
         return next(responses)
 
     respx_mock.get("/audit-logs/export/chunk").mock(side_effect=respond)
@@ -68,7 +70,6 @@ def respond(request: httpx.Request) -> httpx.Response:
         to=destination,
         start="2026-06-01T00:00:00Z",
         end="2026-06-02T00:00:00Z",
-        format="jsonl.gz",
         on_progress=lambda update: progress.append(
             (update.bytes_written, update.chunks, update.rows, update.chunk_rows)
         ),
@@ -80,17 +81,25 @@ def respond(request: httpx.Request) -> httpx.Response:
     assert result.rows == 3
     assert progress == [(5, 1, 2, 2), (11, 2, 3, 1)]
     assert cursors == [None, "next"]
+    assert formats == [None, None]
 
 
 async def test_async_download_writes_verified_chunks(
     async_client: AsyncKernel, respx_mock: MockRouter, monkeypatch: pytest.MonkeyPatch
 ) -> None:
-    respx_mock.get("/audit-logs/export/chunk").mock(
-        side_effect=[
+    responses = iter(
+        [
             chunk_response(b"first", rows=2, has_more=True, next_cursor="next"),
             chunk_response(b"second", rows=1, has_more=False),
         ]
     )
+    formats: list[str | None] = []
+
+    def respond(request: httpx.Request) -> httpx.Response:
+        formats.append(request.url.params.get("format"))
+        return next(responses)
+
+    respx_mock.get("/audit-logs/export/chunk").mock(side_effect=respond)
     thread_ids: list[int] = []
     write_chunk = audit_log_download._write_chunk
 
@@ -119,6 +128,7 @@ async def on_progress(_: object) -> None:
     assert result.rows == 3
     assert progress_called
     assert thread_ids and all(thread_id != threading.get_ident() for thread_id in thread_ids)
+    assert formats == [None, None]
 
 
 async def test_async_download_retries_body_read_failure(