docs(async): mark new AsyncIO APIs as experimental (#1533) · googleapis/google-cloud-python@3909c04
@@ -72,9 +72,16 @@ async def __aexit__(self, exc_type, exc_value, traceback):
7272await self._pool.put(self._session)
7373747475-@CrossSync.convert_class
75+@CrossSync.convert_class(
76+ docstring_format_vars={
77+ "experimental_api": (
78+ "\n\n .. warning::\n The Spanner AsyncIO API is experimental and may be subject to breaking changes.\n",
79+ "",
80+ )
81+ }
82+)
7683class AbstractSessionPool(object):
77-"""Specifies required API for concrete session pool implementations.
84+"""{experimental_api}Specifies required API for concrete session pool implementations.
78857986 :type labels: dict (str -> str) or None
8087 :param labels: (Optional) user-assigned labels for sessions created
@@ -208,9 +215,16 @@ def session(self, **kwargs):
208215return SessionCheckout(self, **kwargs)
209216210217211-@CrossSync.convert_class
218+@CrossSync.convert_class(
219+ docstring_format_vars={
220+ "experimental_api": (
221+ "\n\n .. warning::\n The Spanner AsyncIO API is experimental and may be subject to breaking changes.\n",
222+ "",
223+ )
224+ }
225+)
212226class FixedSizePool(AbstractSessionPool):
213-"""Concrete session pool implementation:
227+"""{experimental_api}Concrete session pool implementation:
214228215229 - Pre-allocates / creates a fixed number of sessions.
216230@@ -474,9 +488,16 @@ async def clear(self):
474488await session.delete()
475489476490477-@CrossSync.convert_class
491+@CrossSync.convert_class(
492+ docstring_format_vars={
493+ "experimental_api": (
494+ "\n\n .. warning::\n The Spanner AsyncIO API is experimental and may be subject to breaking changes.\n",
495+ "",
496+ )
497+ }
498+)
478499class BurstyPool(AbstractSessionPool):
479-"""Concrete session pool implementation:
500+"""{experimental_api}Concrete session pool implementation:
480501481502 - "Pings" existing sessions via :meth:`session.exists` before returning
482503 them.
@@ -585,9 +606,16 @@ async def clear(self):
585606await session.delete()
586607587608588-@CrossSync.convert_class
609+@CrossSync.convert_class(
610+ docstring_format_vars={
611+ "experimental_api": (
612+ "\n\n .. warning::\n The Spanner AsyncIO API is experimental and may be subject to breaking changes.\n",
613+ "",
614+ )
615+ }
616+)
589617class PingingPool(FixedSizePool):
590-"""Concrete session pool implementation:
618+"""{experimental_api}Concrete session pool implementation:
591619592620 - Pre-allocates / creates a fixed number of sessions.
593621@@ -834,9 +862,16 @@ async def ping(self):
834862await self.put(session)
835863836864837-@CrossSync.convert_class
865+@CrossSync.convert_class(
866+ docstring_format_vars={
867+ "experimental_api": (
868+ "\n\n .. warning::\n The Spanner AsyncIO API is experimental and may be subject to breaking changes.\n",
869+ "",
870+ )
871+ }
872+)
838873class TransactionPingingPool(PingingPool):
839-"""Concrete session pool implementation:
874+"""{experimental_api}Concrete session pool implementation:
840875841876 Deprecated: TransactionPingingPool no longer begins a transaction for each of its sessions at startup.
842877 Hence the TransactionPingingPool is same as :class:`PingingPool` and maybe removed in the future.