cloud-sql-python-connector 1.9.1__py2.py3-none-any.whl → 1.9.2__py2.py3-none-any.whl

{cloud_sql_python_connector-1.9.1.dist-info → cloud_sql_python_connector-1.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloud-sql-python-connector
-Version: 1.9.1
+Version: 1.9.2
 Summary: The Cloud SQL Python Connector is a library that can be used alongside a database driver to allow users with sufficient permissions to connect to a Cloud SQL database without having to manually allowlist IPs or manage SSL certificates.
 Home-page: https://github.com/GoogleCloudPlatform/cloud-sql-python-connector
 Author: Google LLC

{cloud_sql_python_connector-1.9.1.dist-info → cloud_sql_python_connector-1.9.2.dist-info}/RECORD

@@ -1,9 +1,9 @@
 google/cloud/sql/connector/__init__.py,sha256=Z3AkPOQwjNF1ogo2DR18GN-CnYvI4MTmhsCe8hURKUo,883
 google/cloud/sql/connector/asyncpg.py,sha256=c4lAlvEgGf_eBq0G8MVNPRAJQQvo6DcwybiXDW36qkU,1838
 google/cloud/sql/connector/client.py,sha256=NZZnPqE_f13S04tpRCs0UGF-RxR4EL-_vH7ebQBXTaA,8494
-google/cloud/sql/connector/connector.py,sha256=WYWP5zUqGSgxWNARaVHO1720REVX-EdD5D4rmBw0Mbw,19188
+google/cloud/sql/connector/connector.py,sha256=q1P0lqDjU5O5U8FQjNa9punrdExwcjvVz7SodbaVmSw,19147
 google/cloud/sql/connector/exceptions.py,sha256=rTBtbCoiZ3U5IFVsyXPw5baHbCODixx2hPDQeXUzgzs,1524
-google/cloud/sql/connector/instance.py,sha256=G7-SCqsLjZiOYZ-Ds2RIErs6oaT0ewnAN683fs7EebI,14920
+google/cloud/sql/connector/instance.py,sha256=Oed1kFTaVolce74DzsSRbooj6mUthwZtt75OamTfOQs,14966
 google/cloud/sql/connector/pg8000.py,sha256=EZuO7XgCkG_Y79NQlh3Vv8Ff2w85BFJyFVO237hx1GM,1814
 google/cloud/sql/connector/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 google/cloud/sql/connector/pymysql.py,sha256=wldUgwDPlPa8Nj5F3JaipuP8hJyvzlgOAJbRnOoaB1U,2105
@@ -11,9 +11,9 @@ google/cloud/sql/connector/pytds.py,sha256=vKJoE7E2P0GrhZojg8bGZkqCMLc8dgKAcXE4e
 google/cloud/sql/connector/rate_limiter.py,sha256=bPTupfM4f5QRSCmCAWMqjQylEB7bUM-50plVBU3W2CA,2993
 google/cloud/sql/connector/refresh_utils.py,sha256=P2ye3qDymdK1iOlGCXby4VIaqwvHdc9GEmuUsMcufxY,3680
 google/cloud/sql/connector/utils.py,sha256=FQs7RgoViJLIFgJIynVT-_DwAVWnpyXIKu5WZ4m10Ts,3448
-google/cloud/sql/connector/version.py,sha256=BLyvPy5gMbwJnZbylhRyvx8K8-8D6alSXCX5TWYYrFM,597
-cloud_sql_python_connector-1.9.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cloud_sql_python_connector-1.9.1.dist-info/METADATA,sha256=9H_fcLVcDRiaFgoOslXPn6BPtoF19RHJwJMvNiKmxNI,24113
-cloud_sql_python_connector-1.9.1.dist-info/WHEEL,sha256=bb2Ot9scclHKMOLDEHY6B2sicWOgugjFKaJsT7vwMQo,110
-cloud_sql_python_connector-1.9.1.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
-cloud_sql_python_connector-1.9.1.dist-info/RECORD,,
+google/cloud/sql/connector/version.py,sha256=x6crtIS26FuBXZ_fZ636i8UD16NlwWdlYJf5SEIqLIc,597
+cloud_sql_python_connector-1.9.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cloud_sql_python_connector-1.9.2.dist-info/METADATA,sha256=5ufJWE8PP34QHa8_1oh1vPJmzaOY-Byqfso7o_BbCnw,24113
+cloud_sql_python_connector-1.9.2.dist-info/WHEEL,sha256=bb2Ot9scclHKMOLDEHY6B2sicWOgugjFKaJsT7vwMQo,110
+cloud_sql_python_connector-1.9.2.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
+cloud_sql_python_connector-1.9.2.dist-info/RECORD,,

google/cloud/sql/connector/connector.py

@@ -32,8 +32,8 @@ import google.cloud.sql.connector.asyncpg as asyncpg
 from google.cloud.sql.connector.client import CloudSQLClient
 from google.cloud.sql.connector.exceptions import ConnectorLoopError
 from google.cloud.sql.connector.exceptions import DnsNameResolutionError
-from google.cloud.sql.connector.instance import Instance
 from google.cloud.sql.connector.instance import IPTypes
+from google.cloud.sql.connector.instance import RefreshAheadCache
 import google.cloud.sql.connector.pg8000 as pg8000
 import google.cloud.sql.connector.pymysql as pymysql
 import google.cloud.sql.connector.pytds as pytds
@@ -113,7 +113,7 @@ class Connector:
                 asyncio.run_coroutine_threadsafe(generate_keys(), self._loop),
                 loop=self._loop,
             )
-        self._instances: Dict[str, Instance] = {}
+        self._cache: Dict[str, RefreshAheadCache] = {}
         self._client: Optional[CloudSQLClient] = None
 
         # initialize credentials
@@ -255,23 +255,23 @@ class Connector:
                 driver=driver,
             )
         enable_iam_auth = kwargs.pop("enable_iam_auth", self._enable_iam_auth)
-        if instance_connection_string in self._instances:
-            instance = self._instances[instance_connection_string]
-            if enable_iam_auth != instance._enable_iam_auth:
+        if instance_connection_string in self._cache:
+            cache = self._cache[instance_connection_string]
+            if enable_iam_auth != cache._enable_iam_auth:
                 raise ValueError(
                     f"connect() called with 'enable_iam_auth={enable_iam_auth}', "
-                    f"but previously used 'enable_iam_auth={instance._enable_iam_auth}'. "
+                    f"but previously used 'enable_iam_auth={cache._enable_iam_auth}'. "
                     "If you require both for your use case, please use a new "
                     "connector.Connector object."
                 )
         else:
-            instance = Instance(
+            cache = RefreshAheadCache(
                 instance_connection_string,
                 self._client,
                 self._keys,
                 enable_iam_auth,
             )
-            self._instances[instance_connection_string] = instance
+            self._cache[instance_connection_string] = cache
 
         connect_func = {
             "pymysql": pymysql.connect,
@@ -300,7 +300,7 @@ class Connector:
 
         # attempt to make connection to Cloud SQL instance
         try:
-            instance_data, ip_address = await instance.connect_info(ip_type)
+            instance_data, ip_address = await cache.connect_info(ip_type)
             # resolve DNS name into IP address for PSC
             if ip_type.value == "PSC":
                 addr_info = await self._loop.getaddrinfo(
@@ -339,7 +339,7 @@ class Connector:
 
         except Exception:
             # with any exception, we attempt a force refresh, then throw the error
-            await instance.force_refresh()
+            await cache.force_refresh()
             raise
 
     def __enter__(self) -> Any:
@@ -385,11 +385,9 @@ class Connector:
             self._thread.join()
 
     async def close_async(self) -> None:
-        """Helper function to cancel Instances' tasks
+        """Helper function to cancel the cache's tasks
         and close aiohttp.ClientSession."""
-        await asyncio.gather(
-            *[instance.close() for instance in self._instances.values()]
-        )
+        await asyncio.gather(*[cache.close() for cache in self._cache.values()])
         if self._client:
             await self._client.close()
 

google/cloud/sql/connector/instance.py

@@ -144,32 +144,13 @@ class ConnectionInfo:
         )
 
 
-class Instance:
-    """A class to manage the details of the connection to a Cloud SQL
-    instance, including refreshing the credentials.
-
-    :param instance_connection_string:
-        The Google Cloud SQL Instance's connection
-        string.
-    :type instance_connection_string: str
-
-    :param enable_iam_auth
-        Enables automatic IAM database authentication for Postgres or MySQL
-        instances.
-    :type enable_iam_auth: bool
-    """
-
-    _enable_iam_auth: bool
-    _keys: asyncio.Future
-    _instance_connection_string: str
-    _instance: str
-    _project: str
-    _region: str
+class RefreshAheadCache:
+    """Cache that refreshes connection info in the background prior to expiration.
 
-    _refresh_rate_limiter: AsyncRateLimiter
-    _refresh_in_progress: asyncio.locks.Event
-    _current: asyncio.Task  # task wraps coroutine that returns ConnectionInfo
-    _next: asyncio.Task  # task wraps coroutine that returns another task
+    Background tasks are used to schedule refresh attempts to get a new
+    ephemeral certificate and Cloud SQL metadata (IP addresses, etc.) ahead of
+    expiration.
+    """
 
     def __init__(
         self,
@@ -178,6 +159,18 @@ class Instance:
         keys: asyncio.Future,
         enable_iam_auth: bool = False,
     ) -> None:
+        """Initializes a RefreshAheadCache instance.
+
+        Args:
+            instance_connection_string (str): The Cloud SQL Instance's
+                connection string (also known as an instance connection name).
+            client (CloudSQLClient): The Cloud SQL Client instance.
+            keys (asyncio.Future): A future to the client's public-private key
+                pair.
+            enable_iam_auth (bool): Enables automatic IAM database authentication
+                (Postgres and MySQL) as the default authentication method for all
+                connections.
+        """
         # validate and parse instance connection name
         self._project, self._region, self._instance = _parse_instance_connection_name(
             instance_connection_string
@@ -192,8 +185,8 @@ class Instance:
             rate=1 / 30,
         )
         self._refresh_in_progress = asyncio.locks.Event()
-        self._current = self._schedule_refresh(0)
-        self._next = self._current
+        self._current: asyncio.Task = self._schedule_refresh(0)
+        self._next: asyncio.Task = self._current
 
     async def force_refresh(self) -> None:
         """
@@ -211,10 +204,11 @@ class Instance:
         """Retrieves instance metadata and ephemeral certificate from the
         Cloud SQL Instance.
 
-        :rtype: ConnectionInfo
-        :returns: A dataclass containing a string representing the ephemeral certificate, a dict
-            containing the instances IP adresses, a string representing a PEM-encoded private key
-            and a string representing a PEM-encoded certificate authority.
+        Returns:
+            A ConnectionInfo instance containing a string representing the
+            ephemeral certificate, a dict containing the instances IP adresses,
+            a string representing a PEM-encoded private key and a string
+            representing a PEM-encoded certificate authority.
         """
         self._refresh_in_progress.set()
         logger.debug(
@@ -290,15 +284,14 @@ class Instance:
         """
         Schedule task to sleep and then perform refresh to get ConnectionInfo.
 
-        :type delay: int
-        :param delay
-            Time in seconds to sleep before running _perform_refresh.
+        Args:
+            delay (int): Time in seconds to sleep before performing a refresh.
 
-        :rtype: asyncio.Task
-        :returns: A Task representing the scheduled _perform_refresh.
+        Returns:
+            An asyncio.Task representing the scheduled refresh.
         """
 
-        async def _refresh_task(self: Instance, delay: int) -> ConnectionInfo:
+        async def _refresh_task(self: RefreshAheadCache, delay: int) -> ConnectionInfo:
             """
             A coroutine that sleeps for the specified amount of time before
             running _perform_refresh.
@@ -349,16 +342,14 @@ class Instance:
         """Retrieve instance metadata and ip address required
         for making connection to Cloud SQL instance.
 
-        :type ip_type: IPTypes
-        :param ip_type: Enum specifying whether to look for public
-            or private IP address.
-
-        :rtype instance_data: ConnectionInfo
-        :returns: Instance metadata for Cloud SQL instance.
+        Args:
+            ip_type (IPTypes): Enum specifying type of IP address to lookup and
+                use for connection.
 
-        :rtype ip_address: str
-        :returns: A string representing the IP address of
-            the given Cloud SQL instance.
+        Returns:
+            A tuple with the first item being the ConnectionInfo instance for
+            establishing the connection, and the second item being the IP
+            address of the Cloud SQL instance matching the specified IP type.
         """
         logger.debug(
             f"['{self._instance_connection_string}']: Entered connect_info method"

google/cloud/sql/connector/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "1.9.1"
+__version__ = "1.9.2"