anyscale 0.26.51__py3-none-any.whl → 0.26.53__py3-none-any.whl

anyscale/_private/docgen/__main__.py

@@ -13,9 +13,9 @@ from anyscale.aggregated_instance_usage.models import DownloadCSVFilters
 from anyscale.cloud.models import (
     AWSConfig,
     Cloud,
-    CloudDeployment,
     CloudPermissionLevel,
     CloudProvider,
+    CloudResource,
     ComputeStack,
     CreateCloudCollaborator,
     FileStorage,
@@ -53,7 +53,7 @@ from anyscale.compute_config.models import (
     ComputeConfigVersion,
     HeadNodeConfig,
     MarketType,
-    MultiDeploymentComputeConfig,
+    MultiResourceComputeConfig,
     WorkerNodeGroupConfig,
 )
 from anyscale.image.models import ImageBuild, ImageBuildStatus
@@ -69,7 +69,13 @@ from anyscale.job.models import (
     JobStatus,
 )
 from anyscale.organization_invitation.models import OrganizationInvitation
-from anyscale.project.models import CreateProjectCollaborator, ProjectPermissionLevel
+from anyscale.project.models import (
+    CreateProjectCollaborator,
+    Project,
+    ProjectPermissionLevel,
+    ProjectSortField,
+    ProjectSortOrder,
+)
 from anyscale.resource_quota.models import CreateResourceQuota, Quota, ResourceQuota
 from anyscale.schedule.models import ScheduleConfig, ScheduleState, ScheduleStatus
 from anyscale.service.models import (
@@ -110,25 +116,33 @@ ALL_MODULES = [
         title="Project",
         filename="project-api.md",
         cli_prefix="anyscale project",
-        cli_commands=[project_commands.add_collaborators,],
+        cli_commands=[
+            project_commands.get,
+            project_commands.list,
+            project_commands.create,
+            project_commands.delete,
+            project_commands.get_default,
+            project_commands.add_collaborators,
+        ],
         sdk_prefix="anyscale.project",
-        sdk_commands=[anyscale.project.add_collaborators,],
-        models=[ProjectPermissionLevel, CreateProjectCollaborator],
-        legacy_cli_commands=[project_commands.create, project_commands.list,],
-        legacy_sdk_commands={
-            "create_project": None,
-            "delete_project": None,
-            "get_default_project": None,
-            "get_project": None,
-            "search_projects": None,
-        },
-        legacy_sdk_models=[
-            "CreateProject",
-            "Project",
-            "ProjectListResponse",
-            "ProjectResponse",
-            "ProjectsQuery",
+        sdk_commands=[
+            anyscale.project.get,
+            anyscale.project.list,
+            anyscale.project.create,
+            anyscale.project.delete,
+            anyscale.project.get_default,
+            anyscale.project.add_collaborators,
         ],
+        models=[
+            Project,
+            ProjectSortField,
+            ProjectSortOrder,
+            CreateProjectCollaborator,
+            ProjectPermissionLevel,
+        ],
+        legacy_cli_commands=[],
+        legacy_sdk_commands={},
+        legacy_sdk_models=[],
     ),
     Module(
         title="Job",
@@ -316,12 +330,11 @@ ALL_MODULES = [
         ],
         models=[
             ComputeConfig,
-            MultiDeploymentComputeConfig,
+            MultiResourceComputeConfig,
             HeadNodeConfig,
             WorkerNodeGroupConfig,
             MarketType,
             CloudDeploymentSelector,
-            MultiDeploymentComputeConfig,
             ComputeConfigVersion,
         ],
         legacy_sdk_commands={
@@ -435,10 +448,9 @@ ALL_MODULES = [
             cloud_commands.cloud_delete,
             cloud_commands.cloud_verify,
             cloud_commands.list_cloud,
-            cloud_commands.cloud_deployment_create,
-            cloud_commands.cloud_deployment_get,
-            cloud_commands.cloud_deployment_update,
-            cloud_commands.cloud_deployment_delete,
+            cloud_commands.cloud_resource_create,
+            cloud_commands.cloud_resource_delete,
+            cloud_commands.cloud_config_get,
             cloud_commands.cloud_config_update,
             cloud_commands.cloud_set_default,
             cloud_commands.add_collaborators,
@@ -457,7 +469,7 @@ ALL_MODULES = [
             Cloud,
             CloudPermissionLevel,
             CreateCloudCollaborator,
-            CloudDeployment,
+            CloudResource,
             ComputeStack,
             CloudProvider,
             NetworkingMode,
@@ -469,10 +481,9 @@ ALL_MODULES = [
             KubernetesConfig,
         ],
         cli_command_group_prefix={
-            cloud_commands.cloud_deployment_create: "deployment",
-            cloud_commands.cloud_deployment_get: "deployment",
-            cloud_commands.cloud_deployment_update: "deployment",
-            cloud_commands.cloud_deployment_delete: "deployment",
+            cloud_commands.cloud_resource_create: "resource",
+            cloud_commands.cloud_resource_delete: "resource",
+            cloud_commands.cloud_config_get: "config",
             cloud_commands.cloud_config_update: "config",
         },
         legacy_sdk_commands={

anyscale/_private/docgen/generator.py

@@ -15,8 +15,16 @@ from anyscale._private.docgen.generator_legacy import (
     LegacySDK,
     parse_legacy_sdks,
 )
-from anyscale._private.models.model_base import ModelBaseType, ModelEnumType
-from anyscale.commands.util import AnyscaleCommand, LegacyAnyscaleCommand
+from anyscale._private.models.model_base import (
+    ModelBaseType,
+    ModelEnumType,
+    ResultIterator,
+)
+from anyscale.commands.util import (
+    AnyscaleCommand,
+    DeprecatedAnyscaleCommand,
+    LegacyAnyscaleCommand,
+)
 
 
 ModelType = Union[ModelBaseType, ModelEnumType]
@@ -48,7 +56,7 @@ CUSTOMER_HOSTED_QUALIFIER = (
 
 def _escape_mdx_content(text: str) -> str:
     """Escape content for MDX compatibility.
-    
+
     This function escapes angle brackets that could be interpreted as HTML tags
     by MDX, converting them to escaped versions.
     """
@@ -226,26 +234,19 @@ class MarkdownGenerator:
         if origin is Union:
             return " | ".join(self._model_type_to_string(arg) for arg in args)
 
-        if origin is dict:
-            arg_str = ", ".join([self._model_type_to_string(arg) for arg in args])
-            if args:
-                return f"Dict[{arg_str}]"
-            else:
-                return "Dict"
-
-        if origin is list:
-            arg_str = ", ".join([self._model_type_to_string(arg) for arg in args])
-            if arg_str:
-                return f"List[{arg_str}]"
-            else:
-                return "List"
+        origin_name_map = {
+            dict: "Dict",
+            list: "List",
+            tuple: "Tuple",
+            ResultIterator: "ResultIterator",
+        }
 
-        if origin is tuple:
+        if origin in origin_name_map:
             arg_str = ", ".join([self._model_type_to_string(arg) for arg in args])
             if arg_str:
-                return f"Tuple[{arg_str}]"
+                return f"{origin_name_map[origin]}[{arg_str}]"
             else:
-                return "Tuple"
+                return origin_name_map[origin]
 
         raise NotImplementedError(f"Unhandled type: {t}")
 
@@ -304,13 +305,20 @@ class MarkdownGenerator:
                 raise ValueError(
                     f"Config model '{t.__name__}' is missing a '__doc_yaml_example__'."
                 )
-        if isinstance(t, AnyscaleCommand) and not cli_example:
+        if (
+            isinstance(
+                t, (AnyscaleCommand, DeprecatedAnyscaleCommand, LegacyAnyscaleCommand)
+            )
+            and not cli_example
+        ):
             raise ValueError(
                 f"CLI command '{t.name}' is missing a '__doc_cli_example__'."
             )
         if (
             not isinstance(t, ModelBaseType)
-            and not isinstance(t, AnyscaleCommand)
+            and not isinstance(
+                t, (AnyscaleCommand, DeprecatedAnyscaleCommand, LegacyAnyscaleCommand)
+            )
             and not py_example
         ):
             raise ValueError(
@@ -324,8 +332,10 @@ class MarkdownGenerator:
             try:
                 yaml.safe_load(yaml_example)
             except Exception as e:  # noqa: BLE001
+                # For CLI commands, use t.name; for SDK functions/models, use t.__name__
+                name = getattr(t, "name", getattr(t, "__name__", str(t)))
                 raise ValueError(
-                    f"'{t.__name__}.__doc_yaml_example__' is not valid YAML syntax"
+                    f"'{name}.__doc_yaml_example__' is not valid YAML syntax"
                 ) from e
 
             yaml_example = yaml_example.strip("\n")
@@ -337,8 +347,10 @@ class MarkdownGenerator:
             try:
                 ast.parse(py_example)
             except Exception as e:  # noqa: BLE001
+                # For CLI commands, use t.name; for SDK functions/models, use t.__name__
+                name = getattr(t, "name", getattr(t, "__name__", str(t)))
                 raise ValueError(
-                    f"'{t.__name__}.__doc_py_example__' is not valid Python syntax"
+                    f"'{name}.__doc_py_example__' is not valid Python syntax"
                 ) from e
 
             py_example = py_example.strip("\n")
@@ -416,7 +428,7 @@ class MarkdownGenerator:
 
         return md
 
-    def _gen_markdown_for_cli_command(
+    def _gen_markdown_for_cli_command(  # noqa: PLR0912
         self, c: click.Command, *, cli_prefix: str
     ) -> str:
         """Generate a markdown section for a CLI command.
@@ -441,9 +453,31 @@ class MarkdownGenerator:
             else:
                 new_c = c.get_new_cli()
                 new_cli_prefix = c.get_new_prefix()
-                md += ":::warning\n"
-                md += f"This command is deprecated. Upgrade to [{new_cli_prefix} {new_c.name}]({self._get_cli_anchor(new_c, new_cli_prefix)}). \n"
-                md += ":::\n"
+                if new_c and new_cli_prefix:
+                    md += ":::warning\n"
+                    md += f"This command is deprecated. Upgrade to [{new_cli_prefix} {new_c.name}]({self._get_cli_anchor(new_c, new_cli_prefix)}). \n"
+                    md += ":::\n"
+        elif isinstance(c, DeprecatedAnyscaleCommand):
+            md = f'### `{cli_prefix} {c.name}` <span class="label-h3 label-deprecated">Deprecated</span>\n'
+            md += ":::warning[Deprecated]\n"
+            # Build deprecation message similar to the command itself
+            parts = []
+            if hasattr(c, "__deprecation_message__") and c.__deprecation_message__:
+                parts.append(c.__deprecation_message__)
+            else:
+                parts.append(f"Command '{c.name}' is deprecated")
+
+            if hasattr(c, "__removal_date__") and c.__removal_date__:
+                date_str = c._format_removal_date(c.__removal_date__)  # noqa: SLF001
+                if date_str:
+                    parts.append(f"and will be removed on {date_str}")
+
+            if hasattr(c, "__alternative__") and c.__alternative__:
+                parts.append(f"Please {c.__alternative__}")
+
+            deprecation_msg = ". ".join(parts) + "."
+            md += deprecation_msg + "\n"
+            md += ":::\n"
         elif isinstance(c, AnyscaleCommand) and c.is_alpha:
             md = f'### `{cli_prefix} {c.name}` <span class="label-h3 label-alpha">Alpha</span>\n'
             md += ":::warning\n"
@@ -481,7 +515,8 @@ class MarkdownGenerator:
             md += "\n"
 
         should_have_example = not (
-            isinstance(c, LegacyAnyscaleCommand) or cli_prefix in CLI_NO_EXAMPLES
+            isinstance(c, (LegacyAnyscaleCommand, DeprecatedAnyscaleCommand))
+            or cli_prefix in CLI_NO_EXAMPLES
         )
         has_cli_example = hasattr(c, "__doc_cli_example__")
         if should_have_example or has_cli_example: