style: Drop underscore prefix from test helpers and tighten comments

Author: vdusek

src/apify_client/_resource_clients/key_value_store.py

@@ -802,8 +802,7 @@ async def set_record(
             content_type: The content type of the saved value.
             timeout: Timeout for the API HTTP request.
         """
-        # Encoding reads file-like values and may serialize large payloads, which is blocking; offload it to a
-        # worker thread so it does not stall the event loop (mirrors the transport's own body-prep offload).
+        # Encoding may read a file or serialize a large payload (blocking), so run it off the event loop.
         value, content_type = await asyncio.to_thread(
             encode_key_value_store_record_value, value, content_type=content_type
         )

src/apify_client/_utils/encoding.py

@@ -21,10 +21,8 @@ def encode_key_value_store_record_value(value: Any, *, content_type: str | None
     Returns:
         A tuple of (encoded_value, content_type).
     """
-    # Read file-like values into memory; the underlying HTTP transport only accepts bytes-like bodies,
-    # so a file object would otherwise reach it unread and raise a raw `TypeError`. Detect them by a
-    # callable `read` rather than `io.IOBase` so duck-typed file-likes (upload wrappers, raw streams)
-    # are read too, instead of falling through to JSON serialization.
+    # Read file-like values into memory; the transport only accepts bytes-like bodies. Detect them by a
+    # callable `read` (not `io.IOBase`) so duck-typed file-likes are read, not JSON-serialized.
     read = getattr(value, 'read', None)
     if callable(read):
         value = read()

tests/unit/test_key_value_store.py

@@ -15,7 +15,7 @@
 _RECORD_PATH = f'/v2/key-value-stores/{_MOCKED_KVS_ID}/records/f'
 
 
-def _decode_body(request: Request) -> bytes:
+def decode_body(request: Request) -> bytes:
     raw = request.get_data()
     return gzip.decompress(raw) if request.headers.get('Content-Encoding') == 'gzip' else raw
 
@@ -36,7 +36,7 @@ def capture_request(request: Request) -> Response:
     client.key_value_store(_MOCKED_KVS_ID).set_record('f', io.BytesIO(b'buffer data'))
 
     assert len(captured_requests) == 1
-    assert _decode_body(captured_requests[0]) == b'buffer data'
+    assert decode_body(captured_requests[0]) == b'buffer data'
     assert captured_requests[0].headers['content-type'] == 'application/octet-stream'
 
 
@@ -56,7 +56,7 @@ def capture_request(request: Request) -> Response:
     await client.key_value_store(_MOCKED_KVS_ID).set_record('f', io.BytesIO(b'buffer data'))
 
     assert len(captured_requests) == 1
-    assert _decode_body(captured_requests[0]) == b'buffer data'
+    assert decode_body(captured_requests[0]) == b'buffer data'
     assert captured_requests[0].headers['content-type'] == 'application/octet-stream'
 
 
@@ -76,5 +76,5 @@ def capture_request(request: Request) -> Response:
     client.key_value_store(_MOCKED_KVS_ID).set_record('f', io.StringIO('buffer data'))
 
     assert len(captured_requests) == 1
-    assert _decode_body(captured_requests[0]) == b'buffer data'
+    assert decode_body(captured_requests[0]) == b'buffer data'
     assert captured_requests[0].headers['content-type'] == 'text/plain; charset=utf-8'

tests/unit/test_utils.py

@@ -267,11 +267,11 @@ def test_encode_key_value_store_record_value_stringio() -> None:
 def test_encode_key_value_store_record_value_duck_typed_file_like() -> None:
     """Test that a duck-typed file-like value (a callable `read`, not an `io.IOBase`) is read into bytes."""
 
-    class _Reader:
+    class Reader:
         def read(self) -> bytes:
             return b'buffer data'
 
-    value, content_type = encode_key_value_store_record_value(_Reader())
+    value, content_type = encode_key_value_store_record_value(Reader())
     assert value == b'buffer data'
     assert content_type == 'application/octet-stream'