chore(cloudsql): format comments into doc strings (GoogleCloudPlatform#8803)

jackwotherspoon · nicain · web-flow · commit 8b5ae7701edf · 2022-12-30T09:26:26.000-08:00
* chore: format comments into doc strings

* chore: lint

* chore: lint

Co-authored-by: nicain &lt;nicholascain@google.com&gt;
diff --git a/cloud-sql/mysql/sqlalchemy/connect_connector.py b/cloud-sql/mysql/sqlalchemy/connect_connector.py
@@ -21,9 +21,12 @@
 import sqlalchemy
 
 
-# connect_with_connector initializes a connection pool for a
-# Cloud SQL instance of MySQL using the Cloud SQL Python Connector.
 def connect_with_connector() -> sqlalchemy.engine.base.Engine:
+    """
+    Initializes a connection pool for a Cloud SQL instance of MySQL.
+
+    Uses the Cloud SQL Python Connector package.
+    """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/mysql/sqlalchemy/connect_connector_auto_iam_authn.py b/cloud-sql/mysql/sqlalchemy/connect_connector_auto_iam_authn.py
@@ -21,10 +21,12 @@
 import sqlalchemy
 
 
-# connect_with_connector_auto_iam_authn initializes a connection pool for
-# a Cloud SQL instance of MySQL using the Cloud SQL Python Connector
-# with Automatic IAM Database Authentication.
 def connect_with_connector_auto_iam_authn() -> sqlalchemy.engine.base.Engine:
+    """
+    Initializes a connection pool for a Cloud SQL instance of MySQL.
+
+    Uses the Cloud SQL Python Connector with Automatic IAM Database Authentication.
+    """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/mysql/sqlalchemy/connect_tcp.py b/cloud-sql/mysql/sqlalchemy/connect_tcp.py
@@ -21,9 +21,8 @@
 import sqlalchemy
 
 
-# connect_tcp_socket initializes a TCP connection pool
-# for a Cloud SQL instance of MySQL.
 def connect_tcp_socket() -> sqlalchemy.engine.base.Engine:
+    """ Initializes a TCP connection pool for a Cloud SQL instance of MySQL. """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/mysql/sqlalchemy/connect_unix.py b/cloud-sql/mysql/sqlalchemy/connect_unix.py
@@ -18,9 +18,8 @@
 import sqlalchemy
 
 
-# connect_unix_socket initializes a Unix socket connection pool for
-# a Cloud SQL instance of MySQL.
 def connect_unix_socket() -> sqlalchemy.engine.base.Engine:
+    """ Initializes a Unix socket connection pool for a Cloud SQL instance of MySQL. """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/postgres/sqlalchemy/connect_connector.py b/cloud-sql/postgres/sqlalchemy/connect_connector.py
@@ -21,9 +21,12 @@
 import sqlalchemy
 
 
-# connect_with_connector initializes a connection pool for a
-# Cloud SQL instance of Postgres using the Cloud SQL Python Connector.
 def connect_with_connector() -> sqlalchemy.engine.base.Engine:
+    """
+    Initializes a connection pool for a Cloud SQL instance of Postgres.
+
+    Uses the Cloud SQL Python Connector package.
+    """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/postgres/sqlalchemy/connect_connector_auto_iam_authn.py b/cloud-sql/postgres/sqlalchemy/connect_connector_auto_iam_authn.py
@@ -21,10 +21,12 @@
 import sqlalchemy
 
 
-# connect_with_connector_auto_iam_authn initializes a connection pool for
-# a Cloud SQL instance of Postgres using the Cloud SQL Python Connector
-# with Automatic IAM Database Authentication.
 def connect_with_connector_auto_iam_authn() -> sqlalchemy.engine.base.Engine:
+    """
+    Initializes a connection pool for a Cloud SQL instance of Postgres.
+
+    Uses the Cloud SQL Python Connector with Automatic IAM Database Authentication.
+    """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/postgres/sqlalchemy/connect_tcp.py b/cloud-sql/postgres/sqlalchemy/connect_tcp.py
@@ -22,9 +22,8 @@
 import sqlalchemy
 
 
-# connect_tcp_socket initializes a TCP connection pool
-# for a Cloud SQL instance of Postgres.
 def connect_tcp_socket() -> sqlalchemy.engine.base.Engine:
+    """ Initializes a TCP connection pool for a Cloud SQL instance of Postgres. """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/postgres/sqlalchemy/connect_unix.py b/cloud-sql/postgres/sqlalchemy/connect_unix.py
@@ -18,9 +18,8 @@
 import sqlalchemy
 
 
-# connect_unix_socket initializes a Unix socket connection pool for
-# a Cloud SQL instance of Postgres.
 def connect_unix_socket() -> sqlalchemy.engine.base.Engine:
+    """ Initializes a Unix socket connection pool for a Cloud SQL instance of Postgres. """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/sql-server/sqlalchemy/connect_connector.py b/cloud-sql/sql-server/sqlalchemy/connect_connector.py
@@ -21,9 +21,12 @@
 import sqlalchemy
 
 
-# connect_with_connector initializes a connection pool for a
-# Cloud SQL instance of SQL Server using the Cloud SQL Python Connector.
 def connect_with_connector() -> sqlalchemy.engine.base.Engine:
+    """
+    Initializes a connection pool for a Cloud SQL instance of SQL Server.
+
+    Uses the Cloud SQL Python Connector package.
+    """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
diff --git a/cloud-sql/sql-server/sqlalchemy/connect_tcp.py b/cloud-sql/sql-server/sqlalchemy/connect_tcp.py
@@ -21,9 +21,8 @@
 import sqlalchemy
 
 
-# connect_tcp_socket initializes a TCP connection pool
-# for a Cloud SQL instance of SQL Server.
 def connect_tcp_socket() -> sqlalchemy.engine.base.Engine:
+    """ Initializes a TCP connection pool for a Cloud SQL instance of SQL Server. """
     # Note: Saving credentials in environment variables is convenient, but not
     # secure - consider a more secure solution such as
     # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
