Skip to content

fix: type hinting in collection.py #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2023
Merged

fix: type hinting in collection.py #688

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a922f0
fix: Fix type hinting in collection.py
Sugihiru Feb 8, 2023
069f69f
fix: Use Union in type hinting
Feb 15, 2023
90d3d26
Merge branch 'main' into patch-1
Mariatta Feb 17, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions google/cloud/firestore_v1/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from google.cloud.firestore_v1 import aggregation
from google.cloud.firestore_v1.watch import Watch
from google.cloud.firestore_v1 import document
from typing import Any, Callable, Generator, Tuple
from typing import Any, Callable, Generator, Tuple, Union

# Types needed only for Type Hints
from google.cloud.firestore_v1.transaction import Transaction
Expand Down Expand Up @@ -79,9 +79,9 @@ def _aggregation_query(self) -> aggregation.AggregationQuery:
def add(
self,
document_data: dict,
document_id: str = None,
document_id: Union[str, None] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Union[float, None] = None,
) -> Tuple[Any, Any]:
"""Create a document in the Firestore database with the provided data.

Expand Down Expand Up @@ -121,9 +121,9 @@ def add(

def list_documents(
self,
page_size: int = None,
page_size: Union[int, None] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Union[float, None] = None,
) -> Generator[Any, Any, None]:
"""List all subdocuments of the current collection.

Expand Down Expand Up @@ -156,9 +156,9 @@ def _chunkify(self, chunk_size: int):

def get(
self,
transaction: Transaction = None,
transaction: Union[Transaction, None] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Union[float, None] = None,
) -> list:
"""Read the documents in this collection.

Expand Down Expand Up @@ -187,9 +187,9 @@ def get(

def stream(
self,
transaction: Transaction = None,
transaction: Union[Transaction, None] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
timeout: Union[float, None] = None,
) -> Generator[document.DocumentSnapshot, Any, None]:
"""Read the documents in this collection.

Expand Down