changed to doc string

Signed-off-by: Sai Shree Pradhan <[email protected]>

Author: saishreeeee

src/databricks/sql/telemetry/DriverConnectionParameters.py

@@ -23,19 +23,19 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Part of TelemetryEvent
-# DriverConnectionParameters connectionParams = new DriverConnectionParameters(
-#     httpPath = " /sql/1.0/endpoints/1234567890abcdef",
-#     driverMode = "THRIFT",
-#     hostDetails = new HostDetails(
-#         hostUrl = "https://my-workspace.cloud.databricks.com",
-#         port = 443
-#     ),
-#     authMech = "OAUTH",
-#     authFlow = "AZURE_MANAGED_IDENTITIES",
-#     authScope = "sql",
-#     discoveryUrl = "https://example-url",
-#     allowedVolumeIngestionPaths = "[]",
-#     azureTenantId = "1234567890abcdef",
-#     socketTimeout = 10000
-# )
+""" Part of TelemetryEvent
+DriverConnectionParameters connectionParams = new DriverConnectionParameters(
+    httpPath = " /sql/1.0/endpoints/1234567890abcdef",
+    driverMode = "THRIFT",
+    hostDetails = new HostDetails(
+        hostUrl = "https://my-workspace.cloud.databricks.com",
+        port = 443
+    ),
+    authMech = "OAUTH",
+    authFlow = "AZURE_MANAGED_IDENTITIES",
+    authScope = "sql",
+    discoveryUrl = "https://example-url",
+    allowedVolumeIngestionPaths = "[]",
+    azureTenantId = "1234567890abcdef",
+    socketTimeout = 10000
+)"""

src/databricks/sql/telemetry/DriverErrorInfo.py

@@ -11,13 +11,14 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Required for ErrorLogs
-# DriverErrorInfo errorInfo = new DriverErrorInfo(
-#     errorName="CONNECTION_ERROR",
-#     stackTrace="Connection failure while using the Databricks SQL Python connector. Failed to connect to server: https://my-workspace.cloud.databricks.com\n" +
-#               "databricks.sql.exc.OperationalError: Connection refused: connect\n" +
-#               "at databricks.sql.thrift_backend.ThriftBackend.make_request(ThriftBackend.py:329)\n" +
-#               "at databricks.sql.thrift_backend.ThriftBackend.attempt_request(ThriftBackend.py:366)\n" +
-#               "at databricks.sql.thrift_backend.ThriftBackend.open_session(ThriftBackend.py:575)\n" +
-#               "at databricks.sql.client.Connection.__init__(client.py:69)\n" +
-#               "at databricks.sql.client.connect(connection.py:123)")
+"""Required for ErrorLogs
+DriverErrorInfo errorInfo = new DriverErrorInfo(
+    errorName="CONNECTION_ERROR",
+    stackTrace="Connection failure while using the Databricks SQL Python connector. Failed to connect to server: https://my-workspace.cloud.databricks.com\n" +
+              "databricks.sql.exc.OperationalError: Connection refused: connect\n" +
+              "at databricks.sql.thrift_backend.ThriftBackend.make_request(ThriftBackend.py:329)\n" +
+              "at databricks.sql.thrift_backend.ThriftBackend.attempt_request(ThriftBackend.py:366)\n" +
+              "at databricks.sql.thrift_backend.ThriftBackend.open_session(ThriftBackend.py:575)\n" +
+              "at databricks.sql.client.Connection.__init__(client.py:69)\n" +
+              "at databricks.sql.client.connect(connection.py:123)")
+"""

src/databricks/sql/telemetry/DriverSystemConfiguration.py

@@ -21,17 +21,18 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Part of TelemetryEvent
-# DriverSystemConfiguration systemConfig = new DriverSystemConfiguration(
-#     driver_version = "2.9.3",
-#     os_name = "Darwin",
-#     os_version = "24.4.0",
-#     os_arch = "arm64",
-#     runtime_name = "CPython",
-#     runtime_version = "3.13.3",
-#     runtime_vendor = "cpython",
-#     client_app_name = "databricks-sql-python",
-#     locale_name = "en_US",
-#     driver_name = "databricks-sql-python",
-#     char_set_encoding = "UTF-8"
-# )
+"""Part of TelemetryEvent
+DriverSystemConfiguration systemConfig = new DriverSystemConfiguration(
+    driver_version = "2.9.3",
+    os_name = "Darwin",
+    os_version = "24.4.0",
+    os_arch = "arm64",
+    runtime_name = "CPython",
+    runtime_version = "3.13.3",
+    runtime_vendor = "cpython",
+    client_app_name = "databricks-sql-python",
+    locale_name = "en_US",
+    driver_name = "databricks-sql-python",
+    char_set_encoding = "UTF-8"
+)
+"""

src/databricks/sql/telemetry/DriverVolumeOperation.py

@@ -14,8 +14,9 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Part of TelemetryEvent
-# DriverVolumeOperation volumeOperation = new DriverVolumeOperation(
-#     volumeOperationType = "LIST",
-#     volumePath = "/path/to/volume"
-# )
+""" Part of TelemetryEvent
+DriverVolumeOperation volumeOperation = new DriverVolumeOperation(
+    volumeOperationType = "LIST",
+    volumePath = "/path/to/volume"
+)
+"""

src/databricks/sql/telemetry/FrontendLogContext.py

@@ -11,10 +11,11 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# used in TelemetryFrontendLog
-# FrontendLogContext frontendLogContext = new FrontendLogContext(
-#     clientContext = new TelemetryClientContext(
-#         timestampMillis = 1716489600000,
-#         userAgent = "databricks-sql-python-test"
-#     )
-# )
+"""used in TelemetryFrontendLog
+FrontendLogContext frontendLogContext = new FrontendLogContext(
+    clientContext = new TelemetryClientContext(
+        timestampMillis = 1716489600000,
+        userAgent = "databricks-sql-python-test"
+    )
+)
+"""

src/databricks/sql/telemetry/HostDetails.py

@@ -11,8 +11,9 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Part of DriverConnectionParameters
-# HostDetails hostDetails = new HostDetails(
-#     hostUrl = "https://my-workspace.cloud.databricks.com",
-#     port = 443
-# )
+""" Part of DriverConnectionParameters
+HostDetails hostDetails = new HostDetails(
+    hostUrl = "https://my-workspace.cloud.databricks.com",
+    port = 443
+)
+"""

src/databricks/sql/telemetry/SqlExecutionEvent.py

@@ -15,10 +15,10 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# Part of TelemetryEvent
-# SqlExecutionEvent sqlExecutionEvent = new SqlExecutionEvent(
-#     statementType = "QUERY",
-#     isCompressed = true,
-#     executionResult = "INLINE_ARROW",
-#     retryCount = 0
-# )
+"""Part of TelemetryEvent
+SqlExecutionEvent sqlExecutionEvent = new SqlExecutionEvent(
+    statementType = "QUERY",
+    isCompressed = true,
+    executionResult = "INLINE_ARROW",
+    retryCount = 0
+)"""

src/databricks/sql/telemetry/TelemetryClientContext.py

@@ -11,8 +11,8 @@ def to_json(self):
         return json.dumps(asdict(self))
 
 
-# used in FrontendLogContext
-# TelemetryClientContext clientContext = new TelemetryClientContext(
-#     timestampMillis = 1716489600000,
-#     userAgent = "databricks-sql-python-test"
-# )
+"""used in FrontendLogContext
+TelemetryClientContext clientContext = new TelemetryClientContext(
+    timestampMillis = 1716489600000,
+    userAgent = "databricks-sql-python-test"
+)"""