Skip to content

chore: Add missing doc strings for spark client functions #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chahatsagarmain wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Add missing doc strings for spark client functions #463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions kubeflow/spark/api/spark_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,52 @@ def connect(
)

def list_sessions(self) -> list[SparkConnectInfo]:
"""List all SparkConnect sessions."""
"""List all SparkConnect sessions.

Returns:
List of SparkConnectInfo objects for all sessions in the namespace.
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

list_sessions() docstring documents Returns but omits Raises, even though the backend can raise TimeoutError and RuntimeError (see RuntimeBackend.list_sessions). Add a Raises: section to keep the public API docs complete and consistent with the documented backend behavior.

Suggested change
List of SparkConnectInfo objects for all sessions in the namespace.
List of SparkConnectInfo objects for all sessions in the namespace.
Raises:
RuntimeError: If the sessions cannot be retrieved.
TimeoutError: If the request to the Kubernetes API times out.

Copilot uses AI. Check for mistakes.
"""
return self.backend.list_sessions()

def get_session(self, name: str) -> SparkConnectInfo:
"""Get session info by name."""
"""Get information about a specific SparkConnect session.

Args:
name: The name of the SparkConnect session to retrieve.

Returns:
SparkConnectInfo object containing session details.

Raises:
RuntimeError: If the session cannot be retrieved or found.
TimeoutError: If the request to the Kubernetes API times out.
"""
return self.backend.get_session(name)

def delete_session(self, name: str) -> None:
"""Delete a SparkConnect session."""
"""Delete a SparkConnect session.

Args:
name: The name of the SparkConnect session to delete.

Raises:
RuntimeError: If the session cannot be deleted or found.
TimeoutError: If the request to the Kubernetes API times out.
"""
self.backend.delete_session(name)

def get_session_logs(self, name: str, follow: bool = False) -> Iterator[str]:
"""Get logs from a session."""
"""Get logs from a SparkConnect session's server pod.

Args:
name: The name of the SparkConnect session.
follow: Whether to continuously follow the log stream. Defaults to False.

Returns:
An iterator over the log lines from the session's pod.

Raises:
RuntimeError: If the session has no pod or logs cannot be retrieved.
TimeoutError: If the request to the Kubernetes API times out.
"""
return self.backend.get_session_logs(name, follow=follow)
Loading