support tuples in pipelin_source.collection

Author: daniel-sanche

google/cloud/firestore_v1/pipeline_source.py

@@ -16,6 +16,7 @@
 from typing import Generic, TypeVar, TYPE_CHECKING
 from google.cloud.firestore_v1 import pipeline_stages as stages
 from google.cloud.firestore_v1.base_pipeline import _BasePipeline
+from google.cloud.firestore_v1._helpers import DOCUMENT_PATH_DELIMITER
 
 if TYPE_CHECKING:
     from google.cloud.firestore_v1.client import Client
@@ -44,15 +45,19 @@ def __init__(self, client: Client | AsyncClient):
     def _create_pipeline(self, source_stage):
         return self.client._pipeline_cls(self.client, source_stage)
 
-    def collection(self, path: str) -> PipelineType:
+    def collection(self, path: str | tuple[str]) -> PipelineType:
         """
         Creates a new Pipeline that operates on a specified Firestore collection.
 
         Args:
-            path: The path to the Firestore collection (e.g., "users")
+            path: The path to the Firestore collection (e.g., "users"). Can either be:
+                * A single ``/``-delimited path to a collection
+                * A tuple of collection path segment
         Returns:
             a new pipeline instance targeting the specified collection
         """
+        if isinstance(path, tuple):
+            path = DOCUMENT_PATH_DELIMITER.join(path)
         return self._create_pipeline(stages.Collection(path))
 
     def collection_group(self, collection_id: str) -> PipelineType:

tests/unit/v1/test_base_query.py

@@ -2005,7 +2005,8 @@ def test__query_pipeline_no_decendants(in_path, out_path):
     from google.cloud.firestore_v1 import pipeline_stages
 
     client = make_client()
-    query = client.collection(in_path)
+    collection = client.collection(in_path)
+    query = collection._query()
     pipeline = query.pipeline()
 
     assert len(pipeline.stages) == 1
@@ -2113,7 +2114,7 @@ def test__query_pipeline_order_sorts():
     assert sort_stage.orders[1].order_dir == expr.Ordering.Direction.DESCENDING
 
 
-def test__query_pipeline_cursor():
+def test__query_pipeline_unsupported():
     client = make_client()
     query_start = client.collection("my_col").start_at({"field_a": "value"})
     with pytest.raises(NotImplementedError, match="cursors"):

tests/unit/v1/test_pipeline_source.py

@@ -44,6 +44,16 @@ def test_collection(self):
         assert isinstance(first_stage, stages.Collection)
         assert first_stage.path == "/path"
 
+    def test_collection_w_tuple(self):
+        instance = self._make_client().pipeline()
+        ppl = instance.collection(("a", "b", "c"))
+        assert isinstance(ppl, self._expected_pipeline_type)
+        assert len(ppl.stages) == 1
+        first_stage = ppl.stages[0]
+        assert isinstance(first_stage, stages.Collection)
+        assert first_stage.path == "/a/b/c"
+
+
     def test_collection_group(self):
         instance = self._make_client().pipeline()
         ppl = instance.collection_group("id")