fixed doc string

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

Author: saishreeeee

src/databricks/sql/telemetry/telemetry_event.py

@@ -12,34 +12,29 @@
 
 @dataclass
 class HostDetails:
-    host_url: str
-    port: int
+    """
+    Part of DriverConnectionParameters
 
-    """ Part of DriverConnectionParameters
+    Example:
     HostDetails hostDetails = new HostDetails(
         hostUrl = "https://my-workspace.cloud.databricks.com",
         port = 443
     )
     """
 
+    host_url: str
+    port: int
+
     def to_json(self):
         return json.dumps(asdict(self))
 
 
 @dataclass
 class DriverConnectionParameters:
-    http_path: str
-    mode: DatabricksClientType
-    host_info: HostDetails
-    auth_mech: AuthMech
-    auth_flow: AuthFlow
-    auth_scope: str
-    discovery_url: str
-    allowed_volume_ingestion_paths: str
-    azure_tenant_id: str
-    socket_timeout: int
+    """
+    Part of TelemetryEvent
 
-    """ Part of TelemetryEvent
+    Example:
     DriverConnectionParameters connectionParams = new DriverConnectionParameters(
         httpPath = " /sql/1.0/endpoints/1234567890abcdef",
         driverMode = "THRIFT",
@@ -54,27 +49,30 @@ class DriverConnectionParameters:
         allowedVolumeIngestionPaths = "[]",
         azureTenantId = "1234567890abcdef",
         socketTimeout = 10000
-    )"""
+    )
+    """
+
+    http_path: str
+    mode: DatabricksClientType
+    host_info: HostDetails
+    auth_mech: AuthMech
+    auth_flow: AuthFlow
+    auth_scope: str
+    discovery_url: str
+    allowed_volume_ingestion_paths: str
+    azure_tenant_id: str
+    socket_timeout: int
 
     def to_json(self):
         return json.dumps(asdict(self))
 
 
 @dataclass
 class DriverSystemConfiguration:
-    driver_version: str
-    os_name: str
-    os_version: str
-    os_arch: str
-    runtime_name: str
-    runtime_version: str
-    runtime_vendor: str
-    client_app_name: str
-    locale_name: str
-    driver_name: str
-    char_set_encoding: str
+    """
+    Part of TelemetryEvent
 
-    """Part of TelemetryEvent
+    Example:
     DriverSystemConfiguration systemConfig = new DriverSystemConfiguration(
         driver_version = "2.9.3",
         os_name = "Darwin",
@@ -90,32 +88,47 @@ class DriverSystemConfiguration:
     )
     """
 
+    driver_version: str
+    os_name: str
+    os_version: str
+    os_arch: str
+    runtime_name: str
+    runtime_version: str
+    runtime_vendor: str
+    client_app_name: str
+    locale_name: str
+    driver_name: str
+    char_set_encoding: str
+
     def to_json(self):
         return json.dumps(asdict(self))
 
 
 @dataclass
 class DriverVolumeOperation:
-    volume_operation_type: DriverVolumeOperationType
-    volume_path: str
+    """
+    Part of TelemetryEvent
 
-    """ Part of TelemetryEvent
+    Example:
     DriverVolumeOperation volumeOperation = new DriverVolumeOperation(
         volumeOperationType = "LIST",
         volumePath = "/path/to/volume"
     )
     """
 
+    volume_operation_type: DriverVolumeOperationType
+    volume_path: str
+
     def to_json(self):
         return json.dumps(asdict(self))
 
 
 @dataclass
 class DriverErrorInfo:
-    error_name: str
-    stack_trace: str
+    """
+    Required for ErrorLogs
 
-    """Required for ErrorLogs
+    Example:
     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" +
@@ -124,27 +137,35 @@ class DriverErrorInfo:
                 "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)")
+                "at databricks.sql.client.connect(connection.py:123)"
+    )
     """
 
+    error_name: str
+    stack_trace: str
+
     def to_json(self):
         return json.dumps(asdict(self))
 
 
 @dataclass
 class SqlExecutionEvent:
-    statement_type: StatementType
-    is_compressed: bool
-    execution_result: ExecutionResultFormat
-    retry_count: int
+    """
+    Part of TelemetryEvent
 
-    """Part of TelemetryEvent
+    Example:
     SqlExecutionEvent sqlExecutionEvent = new SqlExecutionEvent(
         statementType = "QUERY",
         isCompressed = true,
         executionResult = "INLINE_ARROW",
         retryCount = 0
-    )"""
+    )
+    """
+
+    statement_type: StatementType
+    is_compressed: bool
+    execution_result: ExecutionResultFormat
+    retry_count: int
 
     def to_json(self):
         return json.dumps(asdict(self))

src/databricks/sql/telemetry/telemetry_frontend_log.py

@@ -5,14 +5,18 @@
 
 @dataclass
 class TelemetryClientContext:
-    timestamp_millis: int
-    user_agent: str
+    """
+    Used in FrontendLogContext
 
-    """used in FrontendLogContext
+    Example:
     TelemetryClientContext clientContext = new TelemetryClientContext(
         timestampMillis = 1716489600000,
         userAgent = "databricks-sql-python-test"
-    )"""
+    )
+    """
+
+    timestamp_millis: int
+    user_agent: str
 
     def to_json(self):
         return json.dumps(asdict(self))