Move import_attr util to _common/ (#51316)

Quarantining library dependencies out of `_private/`

---------

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>

Author: edoakes

python/ray/_common/__init__.py

@@ -0,0 +1,35 @@
+import importlib
+
+
+def import_attr(full_path: str, *, reload_module: bool = False):
+    """Given a full import path to a module attr, return the imported attr.
+
+    If `reload_module` is set, the module will be reloaded using `importlib.reload`.
+
+    For example, the following are equivalent:
+        MyClass = import_attr("module.submodule:MyClass")
+        MyClass = import_attr("module.submodule.MyClass")
+        from module.submodule import MyClass
+
+    Returns:
+        Imported attr
+    """
+    if full_path is None:
+        raise TypeError("import path cannot be None")
+
+    if ":" in full_path:
+        if full_path.count(":") > 1:
+            raise ValueError(
+                f'Got invalid import path "{full_path}". An '
+                "import path may have at most one colon."
+            )
+        module_name, attr_name = full_path.split(":")
+    else:
+        last_period_idx = full_path.rfind(".")
+        module_name = full_path[:last_period_idx]
+        attr_name = full_path[last_period_idx + 1 :]
+
+    module = importlib.import_module(module_name)
+    if reload_module:
+        importlib.reload(module)
+    return getattr(module, attr_name)

python/ray/_common/utils.py

@@ -4,6 +4,7 @@
 from abc import ABC
 from typing import List, Dict, Optional, Any, Type
 
+from ray._common.utils import import_attr
 from ray._private.runtime_env.context import RuntimeEnvContext
 from ray._private.runtime_env.uri_cache import URICache
 from ray._private.runtime_env.constants import (
@@ -15,7 +16,6 @@
     RAY_RUNTIME_ENV_PLUGIN_MAX_PRIORITY,
 )
 from ray.util.annotations import DeveloperAPI
-from ray._private.utils import import_attr
 
 default_logger = logging.getLogger(__name__)
 

python/ray/_private/runtime_env/plugin.py

@@ -1178,40 +1178,6 @@ def new_func(*args, **kwargs):
     return deprecated_wrapper
 
 
-def import_attr(full_path: str, *, reload_module: bool = False):
-    """Given a full import path to a module attr, return the imported attr.
-
-    If `reload_module` is set, the module will be reloaded using `importlib.reload`.
-
-    For example, the following are equivalent:
-        MyClass = import_attr("module.submodule:MyClass")
-        MyClass = import_attr("module.submodule.MyClass")
-        from module.submodule import MyClass
-
-    Returns:
-        Imported attr
-    """
-    if full_path is None:
-        raise TypeError("import path cannot be None")
-
-    if ":" in full_path:
-        if full_path.count(":") > 1:
-            raise ValueError(
-                f'Got invalid import path "{full_path}". An '
-                "import path may have at most one colon."
-            )
-        module_name, attr_name = full_path.split(":")
-    else:
-        last_period_idx = full_path.rfind(".")
-        module_name = full_path[:last_period_idx]
-        attr_name = full_path[last_period_idx + 1 :]
-
-    module = importlib.import_module(module_name)
-    if reload_module:
-        importlib.reload(module)
-    return getattr(module, attr_name)
-
-
 def get_wheel_filename(
     sys_platform: str = sys.platform,
     ray_version: str = ray.__version__,

python/ray/_private/utils.py

@@ -6,7 +6,7 @@
 # Third-party imports
 from pydantic import ValidationError as PydanticValidationError
 from ray import serve
-from ray._private.utils import import_attr
+from ray._common.utils import import_attr
 
 # Local imports
 from ray.llm._internal.serve.configs.constants import (

python/ray/llm/_internal/serve/deployments/llm/llm_server.py

@@ -10,7 +10,7 @@
 
 import ray
 from ray import cloudpickle
-from ray._private.utils import import_attr
+from ray._common.utils import import_attr
 from ray.exceptions import RuntimeEnvSetupError
 from ray.serve._private.build_app import BuiltApplication, build_app
 from ray.serve._private.common import (

python/ray/serve/_private/application_state.py

@@ -17,8 +17,9 @@
 
 import ray
 import ray.util.serialization_addons
+from ray._common.utils import import_attr
 from ray._private.resource_spec import HEAD_NODE_RESOURCE_NAME
-from ray._private.utils import get_random_alphanumeric_string, import_attr
+from ray._private.utils import get_random_alphanumeric_string
 from ray._private.worker import LOCAL_MODE, SCRIPT_MODE
 from ray._raylet import MessagePackSerializer
 from ray.actor import ActorHandle

python/ray/serve/_private/utils.py

@@ -14,7 +14,7 @@
     PrivateAttr,
     validator,
 )
-from ray._private.utils import import_attr
+from ray._common.utils import import_attr
 from ray.serve._private.constants import (
     DEFAULT_AUTOSCALING_POLICY,
     DEFAULT_GRPC_PORT,

python/ray/serve/config.py

@@ -14,7 +14,7 @@
 
 import ray
 from ray import serve
-from ray._private.utils import import_attr
+from ray._common.utils import import_attr
 from ray.autoscaler._private.cli_logger import cli_logger
 from ray.dashboard.modules.dashboard_sdk import parse_runtime_env_args
 from ray.dashboard.modules.serve.sdk import ServeSubmissionClient

python/ray/serve/scripts.py

@@ -205,7 +205,7 @@ def test_controller_deserialization_deployment_def(
     def run_graph():
         """Deploys a Serve application to the controller's Ray cluster."""
         from ray import serve
-        from ray._private.utils import import_attr
+        from ray._common.utils import import_attr
 
         # Import and build the graph
         graph = import_attr("test_config_files.pizza.serve_dag")