FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: update the async transactional types (#1066) · googleapis/python-firestore@210a14a · GitHub

This repository was archived by the owner on Mar 2, 2026. It is now read-only.
/ python-firestore Public archive

Commit 210a14a

Browse files
authored
fix: update the async transactional types (#1066)
* fix: update the async transactional types to not require extra awaits * add typing extensions * python <3.10 compat * use a protocol * moved back to ParamSpec implementation * updated mypy.ini * fixed some types * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Jillian Kozyra <jillian.kozyra@gmail.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 7f96290 commit 210a14a

2 files changed

Lines changed: 29 additions & 14 deletions

File tree

‎google/cloud/firestore_v1/async_transaction.py‎

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,14 @@
1515
"""Helpers for applying Google Cloud Firestore changes in a transaction."""
1616
from __future__ import annotations
1717

18-
from typing import TYPE_CHECKING, Any, AsyncGenerator, Callable, Coroutine, Optional
18+
from typing import (
19+
TYPE_CHECKING,
20+
Any,
21+
AsyncGenerator,
22+
Awaitable,
23+
Callable,
24+
Optional,
25+
)
1926

2027
from google.api_core import exceptions, gapic_v1
2128
from google.api_core import retry_async as retries
@@ -37,11 +44,15 @@
3744
# Types needed only for Type Hints
3845
if TYPE_CHECKING: # pragma: NO COVER
3946
import datetime
47+
from typing_extensions import TypeVar, ParamSpec, Concatenate
4048

4149
from google.cloud.firestore_v1.async_stream_generator import AsyncStreamGenerator
4250
from google.cloud.firestore_v1.base_document import DocumentSnapshot
4351
from google.cloud.firestore_v1.query_profile import ExplainOptions
4452

53+
T = TypeVar("T")
54+
P = ParamSpec("P")
55+
4556

4657
class AsyncTransaction(async_batch.AsyncWriteBatch, BaseTransaction):
4758
"""Accumulate read-and-write operations to be sent in a transaction.
@@ -253,12 +264,14 @@ class _AsyncTransactional(_BaseTransactional):
253264
A coroutine that should be run (and retried) in a transaction.
254265
"""
255266

256-
def __init__(self, to_wrap) -> None:
267+
def __init__(
268+
self, to_wrap: Callable[Concatenate[AsyncTransaction, P], Awaitable[T]]
269+
) -> None:
257270
super(_AsyncTransactional, self).__init__(to_wrap)
258271

259272
async def _pre_commit(
260-
self, transaction: AsyncTransaction, *args, **kwargs
261-
) -> Coroutine:
273+
self, transaction: AsyncTransaction, *args: P.args, **kwargs: P.kwargs
274+
) -> T:
262275
"""Begin transaction and call the wrapped coroutine.
263276
264277
Args:
@@ -271,7 +284,7 @@ async def _pre_commit(
271284
along to the wrapped coroutine.
272285
273286
Returns:
274-
Any: result of the wrapped coroutine.
287+
T: result of the wrapped coroutine.
275288
276289
Raises:
277290
Exception: Any failure caused by ``to_wrap``.
@@ -286,20 +299,22 @@ async def _pre_commit(
286299
self.retry_id = self.current_id
287300
return await self.to_wrap(transaction, *args, **kwargs)
288301

289-
async def __call__(self, transaction, *args, **kwargs):
302+
async def __call__(
303+
self, transaction: AsyncTransaction, *args: P.args, **kwargs: P.kwargs
304+
) -> T:
290305
"""Execute the wrapped callable within a transaction.
291306
292307
Args:
293308
transaction
294-
(:class:`~google.cloud.firestore_v1.transaction.Transaction`):
309+
(:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`):
295310
A transaction to execute the callable within.
296311
args (Tuple[Any, ...]): The extra positional arguments to pass
297312
along to the wrapped callable.
298313
kwargs (Dict[str, Any]): The extra keyword arguments to pass
299314
along to the wrapped callable.
300315
301316
Returns:
302-
Any: The result of the wrapped callable.
317+
T: The result of the wrapped callable.
303318
304319
Raises:
305320
ValueError: If the transaction does not succeed in
@@ -313,7 +328,7 @@ async def __call__(self, transaction, *args, **kwargs):
313328

314329
try:
315330
for attempt in range(transaction._max_attempts):
316-
result = await self._pre_commit(transaction, *args, **kwargs)
331+
result: T = await self._pre_commit(transaction, *args, **kwargs)
317332
try:
318333
await transaction._commit()
319334
return result
@@ -338,17 +353,17 @@ async def __call__(self, transaction, *args, **kwargs):
338353

339354

340355
def async_transactional(
341-
to_wrap: Callable[[AsyncTransaction], Any]
342-
) -> _AsyncTransactional:
356+
to_wrap: Callable[Concatenate[AsyncTransaction, P], Awaitable[T]]
357+
) -> Callable[Concatenate[AsyncTransaction, P], Awaitable[T]]:
343358
"""Decorate a callable so that it runs in a transaction.
344359
345360
Args:
346361
to_wrap
347-
(Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]):
362+
(Callable[[:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`, ...], Awaitable[Any]]):
348363
A callable that should be run (and retried) in a transaction.
349364
350365
Returns:
351-
Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]:
366+
Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Awaitable[Any]]:
352367
the wrapped callable.
353368
"""
354369
return _AsyncTransactional(to_wrap)

‎mypy.ini‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[mypy]
2-
python_version = 3.6
2+
python_version = 3.8
33
namespace_packages = True

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL