Files
ray-project--ray/python/ray/util/client_connect.py
T
2026-07-13 13:17:40 +08:00

82 lines
2.7 KiB
Python

import logging
from typing import Any, Dict, List, Optional, Tuple
from ray._private.client_mode_hook import (
_explicitly_enable_client_mode,
_set_client_hook_status,
)
from ray._private.utils import get_ray_doc_version
from ray.job_config import JobConfig
from ray.util.annotations import Deprecated
from ray.util.client import ray
logger = logging.getLogger(__name__)
@Deprecated(
message="Use ray.init(ray://<head_node_ip_address>:<ray_client_server_port>) "
"instead. See detailed usage at {}.".format(
f"https://docs.ray.io/en/{get_ray_doc_version()}/ray-core/package-ref.html#ray-init" # noqa: E501
)
)
def connect(
conn_str: str,
secure: bool = False,
metadata: List[Tuple[str, str]] = None,
connection_retries: int = 3,
job_config: JobConfig = None,
namespace: str = None,
*,
ignore_version: bool = False,
_credentials: Optional["grpc.ChannelCredentials"] = None, # noqa: F821
ray_init_kwargs: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
# Check if Ray is already connected (any type of connection)
if ray.is_connected():
ignore_reinit_error = (
ray_init_kwargs.get("ignore_reinit_error", False)
if ray_init_kwargs is not None
else False
)
if ignore_reinit_error:
logger.info(
"Calling ray.init() again after it has already been called. "
"Reusing the existing Ray client connection."
)
return ray.get_context().client_worker.connection_info()
raise RuntimeError(
"Ray Client is already connected. Maybe you called "
'ray.init("ray://<address>") twice by accident?'
)
# Enable the same hooks that RAY_CLIENT_MODE does, as calling
# ray.init("ray://<address>") is specifically for using client mode.
_set_client_hook_status(True)
_explicitly_enable_client_mode()
# TODO(barakmich): https://github.com/ray-project/ray/issues/13274
# for supporting things like cert_path, ca_path, etc and creating
# the correct metadata
conn = ray.connect(
conn_str,
job_config=job_config,
secure=secure,
metadata=metadata,
connection_retries=connection_retries,
namespace=namespace,
ignore_version=ignore_version,
_credentials=_credentials,
ray_init_kwargs=ray_init_kwargs,
)
return conn
@Deprecated(
message="Use ray.shutdown() instead. See detailed usage at {}.".format(
f"https://docs.ray.io/en/{get_ray_doc_version()}/ray-core/package-ref.html#ray-shutdown" # noqa: E501
)
)
def disconnect():
"""Disconnects from server; is idempotent."""
return ray.disconnect()