Add master test script for all usage example files

Run linter on client/python

Author: peopleig

client/python/examples/all.py

@@ -0,0 +1,28 @@
+# This file is like a master test. Runs all the examples
+# Not exactly the purpose of the examples dir,
+# but helps in checking if any code updates haven't broken the API
+
+from pathlib import Path
+import subprocess
+import pytest
+
+# Didn't know I could do this with pytest, so cool
+# Just run: pytest ./all.py -v
+
+EXAMPLES_DIR = Path(__file__).parent
+example_files = sorted(EXAMPLES_DIR.glob("*_usage.py"))
+
+
+@pytest.mark.parametrize(
+    "script_path",
+    example_files,
+    ids=lambda p: p.stem,
+)
+def test(script_path):
+    """Run all example scripts to check if they crash or not"""
+    result = subprocess.run(
+        ["python3", str(script_path)], capture_output=True, text=True
+    )
+    assert result.returncode == 0, (
+        f"Script {script_path} failed with stderr:\n{result.stderr}"
+    )

client/python/examples/async_batch_usage.py

@@ -1,15 +1,14 @@
 import asyncio
 
 from vortexdb import AsyncVortexDB
-from vortexdb import DenseVector, Payload, Similarity, SearchQuery, to_dense_vectors
+from vortexdb import Payload, Similarity, SearchQuery, to_dense_vectors
 
 
 async def main():
     async with AsyncVortexDB(
         grpc_url="localhost:50051",
         api_key="my-secret-password",
     ) as db:
-
         raw_vectors = [
             [0.1, 0.2, 0.3],
             [0.4, 0.5, 0.6],
@@ -83,4 +82,4 @@ async def main():
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    asyncio.run(main())

client/python/examples/basic_usage.py

@@ -1,5 +1,6 @@
 from vortexdb import VortexDB
-from vortexdb import DenseVector, Payload, Similarity   # from vortexdb.models
+from vortexdb import DenseVector, Payload, Similarity  # from vortexdb.models
+
 
 def main():
     # Initialize client
@@ -32,5 +33,6 @@ def main():
     # Close connection
     db.close()
 
+
 if __name__ == "__main__":
     main()

client/python/examples/batch_insert_usage.py

@@ -1,5 +1,5 @@
 from vortexdb import VortexDB
-from vortexdb import DenseVector, Payload, to_dense_vectors
+from vortexdb import Payload, to_dense_vectors
 
 
 def main():
@@ -36,4 +36,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

client/python/examples/context_manager_usage.py

@@ -1,11 +1,11 @@
 from vortexdb import VortexDB, DenseVector, Payload, Similarity
 
+
 def main():
     with VortexDB(
         grpc_url="localhost:50051",
         api_key="my-secret-password",
     ) as db:
-
         # Insert a vector
         point_id = db.insert(
             vector=DenseVector([0.1, 0.2, 0.3]),
@@ -30,5 +30,6 @@ def main():
     # At this point, the gRPC channel is closed automatically
     print("Connection closed")
 
+
 if __name__ == "__main__":
     main()

client/python/examples/search_query_usage.py

@@ -1,5 +1,5 @@
 from vortexdb import VortexDB
-from vortexdb import DenseVector, Similarity, SearchQuery, to_dense_vectors
+from vortexdb import Similarity, SearchQuery, to_dense_vectors
 
 
 def main():
@@ -66,4 +66,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

client/python/pyproject.toml

@@ -42,3 +42,6 @@ Repository = "https://github.com/sdslabs/VortexDB"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+
+[tool.ruff]
+exclude = ["vortexdb/grpc"]

client/python/tests/test_async_client.py

@@ -5,7 +5,14 @@
 
 from vortexdb.async_client import AsyncVortexDB
 from vortexdb.async_connection import AsyncGRPCConnection
-from vortexdb.models import ContentType, DenseVector, Payload, Point, Similarity, SearchQuery
+from vortexdb.models import (
+    ContentType,
+    DenseVector,
+    Payload,
+    Point,
+    Similarity,
+    SearchQuery,
+)
 
 
 @pytest.fixture
@@ -60,6 +67,7 @@ async def run():
 
 # Batch Insert
 
+
 def test_async_batch_insert_success(client, mock_connection):
     async def run():
         response = Mock()
@@ -111,6 +119,7 @@ async def run():
 
 # Get
 
+
 def test_async_get_point_success(client, mock_connection):
     async def run():
         proto_point = Mock()
@@ -143,6 +152,7 @@ async def run():
 
 # Delete
 
+
 def test_async_delete_success(client, mock_connection):
     async def run():
         mock_connection.call.return_value = None
@@ -156,6 +166,7 @@ async def run():
 
 # Search
 
+
 def test_async_search_success(client, mock_connection):
     async def run():
         mock_connection.call.return_value = Mock(
@@ -223,6 +234,7 @@ async def run():
 
 # Batch Search
 
+
 def test_async_batch_search_full_tuple(client, mock_connection):
     async def run():
         mock_connection.call.return_value = Mock(
@@ -275,7 +287,9 @@ async def run():
     asyncio.run(run())
 
 
-def test_async_batch_search_vector_similarity_with_global_limit(client, mock_connection):
+def test_async_batch_search_vector_similarity_with_global_limit(
+    client, mock_connection
+):
     async def run():
         mock_connection.call.return_value = Mock(
             results=[
@@ -343,6 +357,7 @@ async def run():
 
 # Close / Context Manager
 
+
 def test_async_close_closes_connection(client, mock_connection):
     async def run():
         await client.close()
@@ -367,4 +382,4 @@ async def run():
 
         conn.close.assert_awaited_once()
 
-    asyncio.run(run())
+    asyncio.run(run())

client/python/tests/test_client.py

@@ -4,13 +4,12 @@
 from vortexdb.client import VortexDB
 from vortexdb.connection import GRPCConnection
 from vortexdb.models import DenseVector, Payload, Similarity, ContentType, Point
-from vortexdb.exceptions import InvalidArgumentError
 from vortexdb.models import SearchQuery
 
 
-
 # Fixtures for a mock connection and client layer
 
+
 @pytest.fixture
 def mock_connection(monkeypatch):
     """
@@ -31,6 +30,7 @@ def client(mock_connection):
 
 # Insert
 
+
 def test_insert_success(client, mock_connection):
     response = Mock()
     response.id = Mock()
@@ -56,6 +56,7 @@ def test_insert_rejects_invalid_vector(client):
 
 # Batch Insert
 
+
 def test_batch_insert_success(client, mock_connection):
     response = Mock()
     response.ids = [
@@ -70,17 +71,20 @@ def test_batch_insert_success(client, mock_connection):
     result = client.batch_insert(items=items)
     assert result == ["p1", "p2"]
 
+
 def test_batch_insert_invalid_items_type(client):
     with pytest.raises(TypeError):
         client.batch_insert(items="not-a-list")
 
+
 def test_batch_insert_invalid_tuple_structure(client):
     items = [
         (DenseVector([1, 2, 3]),),  # only one element
     ]
     with pytest.raises(TypeError):
         client.batch_insert(items=items)
 
+
 def test_batch_insert_invalid_vector(client):
     items = [
         ([1, 2, 3], Payload.text("a")),  # not DenseVector
@@ -91,6 +95,7 @@ def test_batch_insert_invalid_vector(client):
 
 # Get
 
+
 def test_get_point_success(client, mock_connection):
     proto_point = Mock()
     proto_point.id.id.value = "point-123"
@@ -117,6 +122,7 @@ def test_get_point_not_found(client, mock_connection):
 
 # Delete
 
+
 def test_delete_success(client, mock_connection):
     mock_connection.call.return_value = None
 
@@ -127,6 +133,7 @@ def test_delete_success(client, mock_connection):
 
 # Search
 
+
 def test_search_success(client, mock_connection):
     mock_connection.call.return_value = Mock(
         result_point_ids=[
@@ -167,7 +174,6 @@ def test_search_invalid_vector(client):
         )
 
 
-
 def test_batch_search_accepts_ef(client, mock_connection):
     mock_connection.call.return_value = Mock(results=[])
 
@@ -182,8 +188,10 @@ def test_batch_search_accepts_ef(client, mock_connection):
     request = mock_connection.call.call_args.args[1]
     assert [query.ef for query in request.queries] == [256, 256]
 
+
 # Batch Search
 
+
 def test_batch_search_full_tuple(client, mock_connection):
     mock_connection.call.return_value = Mock(
         results=[
@@ -198,6 +206,7 @@ def test_batch_search_full_tuple(client, mock_connection):
     result = client.batch_search(queries=queries)
     assert result == [["p1"], ["p2"]]
 
+
 def test_batch_search_vectors_with_global_params(client, mock_connection):
     mock_connection.call.return_value = Mock(
         results=[
@@ -212,6 +221,7 @@ def test_batch_search_vectors_with_global_params(client, mock_connection):
     )
     assert result == [["p1"]]
 
+
 def test_batch_search_vector_similarity_with_global_limit(client, mock_connection):
     mock_connection.call.return_value = Mock(
         results=[
@@ -227,6 +237,7 @@ def test_batch_search_vector_similarity_with_global_limit(client, mock_connectio
     )
     assert result == [["p1"]]
 
+
 def test_batch_search_searchquery_objects(client, mock_connection):
     mock_connection.call.return_value = Mock(
         results=[
@@ -239,29 +250,35 @@ def test_batch_search_searchquery_objects(client, mock_connection):
     result = client.batch_search(queries=queries)
     assert result == [["p1"]]
 
+
 def test_batch_search_missing_globals_for_vector(client):
     queries = [DenseVector([1, 2, 3])]
     with pytest.raises(ValueError):
         client.batch_search(queries=queries)
 
+
 def test_batch_search_missing_limit(client):
     queries = [
         (DenseVector([1, 2, 3]), Similarity.COSINE),
     ]
     with pytest.raises(ValueError):
         client.batch_search(queries=queries)
 
+
 def test_batch_search_invalid_format(client):
     queries = ["invalid"]
     with pytest.raises(TypeError):
         client.batch_search(queries=queries)
 
+
 # Close
 
+
 def test_close_closes_connection(client, mock_connection):
     client.close()
     mock_connection.close.assert_called_once()
 
+
 def test_context_manager_closes_connection(monkeypatch):
     conn = Mock(spec=GRPCConnection)
     monkeypatch.setattr("vortexdb.client.GRPCConnection", lambda _: conn)

client/python/tests/test_config.py

@@ -16,6 +16,7 @@ def clean_env(monkeypatch):
 
 # Checking from_env
 
+
 def test_config_requires_api_key(clean_env):
     with pytest.raises(ConfigurationError):
         VortexDBConfig.from_env()
@@ -32,8 +33,10 @@ def test_config_from_explicit_args(clean_env):
     assert cfg.api_key == "secret"
     assert cfg.timeout == 10.0
 
+
 # Env vars fallback
 
+
 def test_config_from_env_vars(clean_env, monkeypatch):
     monkeypatch.setenv("VORTEXDB_GRPC_URL", "127.0.0.1:1234")
     monkeypatch.setenv("VORTEXDB_API_KEY", "env-secret")
@@ -48,6 +51,7 @@ def test_config_from_env_vars(clean_env, monkeypatch):
 
 # Defaults
 
+
 def test_config_default_grpc_url(clean_env, monkeypatch):
     monkeypatch.setenv("VORTEXDB_API_KEY", "secret")
 
@@ -66,6 +70,7 @@ def test_config_default_timeout(clean_env, monkeypatch):
 
 # Invalid Timeout
 
+
 def test_config_invalid_timeout(clean_env, monkeypatch):
     monkeypatch.setenv("VORTEXDB_API_KEY", "secret")
     monkeypatch.setenv("VORTEXDB_TIMEOUT", "not-a-number")