anyscale 0.24.87__py3-none-any.whl → 0.24.91__py3-none-any.whl

anyscale/project/models.py

@@ -0,0 +1,91 @@
+from dataclasses import dataclass, field
+from typing import Any, Dict, List
+
+from anyscale._private.models import ModelBase, ModelEnum
+
+
+class ProjectPermissionLevel(ModelEnum):
+    OWNER = "OWNER"
+    WRITE = "WRITE"
+    READONLY = "READONLY"
+
+    __docstrings__ = {
+        OWNER: "Owner permission level for the project",
+        WRITE: "Write permission level for the project",
+        READONLY: "Readonly permission level for the project",
+    }
+
+
+@dataclass(frozen=True)
+class CreateProjectCollaborator(ModelBase):
+    """User to be added as a collaborator to a project.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.project.models import ProjectPermissionLevel, CreateProjectCollaborator
+create_project_collaborator = CreateProjectCollaborator(
+   # Email of the user to be added as a collaborator
+    email="test@anyscale.com",
+    # Permission level for the user to the project (ProjectPermissionLevel.OWNER, ProjectPermissionLevel.WRITE, ProjectPermissionLevel.READONLY)
+    permission_level=ProjectPermissionLevel.READONLY,
+)
+"""
+
+    def _validate_email(self, email: str):
+        if not isinstance(email, str):
+            raise TypeError("Email must be a string.")
+
+    email: str = field(
+        metadata={"docstring": "Email of the user to be added as a collaborator."},
+    )
+
+    def _validate_permission_level(
+        self, permission_level: ProjectPermissionLevel
+    ) -> ProjectPermissionLevel:
+        if isinstance(permission_level, str):
+            return ProjectPermissionLevel.validate(permission_level)
+        elif isinstance(permission_level, ProjectPermissionLevel):
+            return permission_level
+        else:
+            raise TypeError(
+                f"'permission_level' must be a 'ProjectPermissionLevel' (it is {type(permission_level)})."
+            )
+
+    permission_level: ProjectPermissionLevel = field(  # type: ignore
+        default=ProjectPermissionLevel.READONLY,  # type: ignore
+        metadata={
+            "docstring": "Permission level the added user should have for the project"  # type: ignore
+            f"(one of: {','.join([str(m.value) for m in ProjectPermissionLevel])}",  # type: ignore
+        },
+    )
+
+
+@dataclass(frozen=True)
+class CreateProjectCollaborators(ModelBase):
+    """List of users to be added as collaborators to a project.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.project.models import ProjectPermissionLevel, CreateProjectCollaborator, CreateProjectCollaborators
+create_project_collaborator = CreateProjectCollaborator(
+   # Email of the user to be added as a collaborator
+    email="test@anyscale.com",
+    # Permission level for the user to the project (ProjectPermissionLevel.OWNER, ProjectPermissionLevel.WRITE, ProjectPermissionLevel.READONLY)
+    permission_level=ProjectPermissionLevel.READONLY,
+)
+create_project_collaborators = CreateProjectCollaborators(
+    collaborators=[create_project_collaborator]
+)
+"""
+
+    collaborators: List[Dict[str, Any]] = field(
+        metadata={
+            "docstring": "List of users to be added as collaborators to a project."
+        },
+    )
+
+    def _validate_collaborators(self, collaborators: List[Dict[str, Any]]):
+        if not isinstance(collaborators, list):
+            raise TypeError("Collaborators must be a list.")

anyscale/{project.py → project_utils.py}

@@ -5,12 +5,11 @@ import click
 from click import ClickException
 import yaml
 
-import anyscale
 from anyscale.authenticate import get_auth_api_client
 from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client import Project
 from anyscale.client.openapi_client.api.default_api import DefaultApi
-from anyscale.cloud import get_cloud_id_and_name
+from anyscale.cloud_utils import get_cloud_id_and_name
 from anyscale.cluster_compute import (
     get_cluster_compute_from_name,
     get_selected_cloud_id_or_default,
@@ -301,13 +300,13 @@ def create_new_proj_def(
         name = slugify(name)
         log.info(f"Normalized project name to {name}")
 
-    project_definition = anyscale.project.ProjectDefinition(os.getcwd())
+    project_definition = ProjectDefinition(os.getcwd())
     project_definition.config["name"] = name
     return name, project_definition
 
 
 def _do_attach(project_id: str, is_create_project: bool) -> None:
-    with open(anyscale.project.ANYSCALE_PROJECT_FILE, "w") as f:
+    with open(ANYSCALE_PROJECT_FILE, "w") as f:
         yaml.dump(
             {"project_id": project_id}, f,
         )

anyscale/resource_quota/__init__.py

@@ -0,0 +1,99 @@
+from typing import List, Optional
+
+from anyscale._private.anyscale_client import AnyscaleClientInterface
+from anyscale._private.sdk import sdk_docs
+from anyscale._private.sdk.base_sdk import Timer
+from anyscale.cli_logger import BlockLogger
+from anyscale.resource_quota._private.resource_quota_sdk import PrivateResourceQuotaSDK
+from anyscale.resource_quota.commands import (
+    _CREATE_DOCSTRINGS,
+    _CREATE_EXAMPLE,
+    _DELETE_DOCSTRINGS,
+    _DELETE_EXAMPLE,
+    _DISABLE_DOCSTRINGS,
+    _DISABLE_EXAMPLE,
+    _ENABLE_DOCSTRINGS,
+    _ENABLE_EXAMPLE,
+    _LIST_DOCSTRINGS,
+    _LIST_EXAMPLE,
+    create,
+    delete,
+    disable,
+    enable,
+    list,
+)
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
+
+
+class ResourceQuotaSDK:
+    def __init__(
+        self,
+        *,
+        client: Optional[AnyscaleClientInterface] = None,
+        logger: Optional[BlockLogger] = None,
+        timer: Optional[Timer] = None,
+    ):
+        self._private_sdk = PrivateResourceQuotaSDK(
+            client=client, logger=logger, timer=timer
+        )
+
+    @sdk_docs(
+        doc_py_example=_CREATE_EXAMPLE, arg_docstrings=_CREATE_DOCSTRINGS,
+    )
+    def create(  # noqa: F811
+        self, create_resource_quota: CreateResourceQuota,
+    ) -> ResourceQuota:
+        """Create a resource quota.
+        """
+        return self._private_sdk.create(create_resource_quota)
+
+    @sdk_docs(
+        doc_py_example=_LIST_EXAMPLE, arg_docstrings=_LIST_DOCSTRINGS,
+    )
+    def list(  # noqa: F811
+        self,
+        name: Optional[str] = None,
+        cloud: Optional[str] = None,
+        creator_id: Optional[str] = None,
+        is_enabled: Optional[bool] = None,
+        max_items: int = 20,
+    ) -> List[ResourceQuota]:
+        """List resource quotas.
+        """
+        return self._private_sdk.list(
+            name=name,
+            cloud=cloud,
+            creator_id=creator_id,
+            is_enabled=is_enabled,
+            max_items=max_items,
+        )
+
+    @sdk_docs(
+        doc_py_example=_DELETE_EXAMPLE, arg_docstrings=_DELETE_DOCSTRINGS,
+    )
+    def delete(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Delete a resource quota.
+        """
+        return self._private_sdk.delete(resource_quota_id)
+
+    @sdk_docs(
+        doc_py_example=_ENABLE_EXAMPLE, arg_docstrings=_ENABLE_DOCSTRINGS,
+    )
+    def enable(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Enable a resource quota.
+        """
+        return self._private_sdk.set_status(resource_quota_id, True)
+
+    @sdk_docs(
+        doc_py_example=_DISABLE_EXAMPLE, arg_docstrings=_DISABLE_DOCSTRINGS,
+    )
+    def disable(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Disable a resource quota.
+        """
+        return self._private_sdk.set_status(resource_quota_id, False)

anyscale/resource_quota/_private/resource_quota_sdk.py

@@ -0,0 +1,111 @@
+from typing import List, Optional
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.client.openapi_client.models.create_resource_quota import (
+    CreateResourceQuota as CreateResourceQuotaModel,
+)
+from anyscale.client.openapi_client.models.quota import Quota as QuotaModel
+from anyscale.resource_quota.models import CreateResourceQuota, Quota, ResourceQuota
+
+
+class PrivateResourceQuotaSDK(BaseSDK):
+    def create(self, create_resource_quota: CreateResourceQuota) -> ResourceQuota:
+        cloud_id = self.client.get_cloud_id(
+            cloud_name=create_resource_quota.cloud, compute_config_id=None
+        )
+
+        project_id = (
+            self.client.get_project_id(
+                parent_cloud_id=cloud_id, name=create_resource_quota.project
+            )
+            if create_resource_quota.project
+            else None
+        )
+
+        user_id = (
+            self.client.get_organization_collaborator(
+                email=create_resource_quota.user_email
+            ).user_id
+            if create_resource_quota.user_email
+            else None
+        )
+
+        create_resource_quota_model = CreateResourceQuotaModel(
+            name=create_resource_quota.name,
+            cloud_id=cloud_id,
+            project_id=project_id,
+            user_id=user_id,
+            quota=QuotaModel(
+                num_cpus=create_resource_quota.num_cpus,
+                num_instances=create_resource_quota.num_instances,
+                num_gpus=create_resource_quota.num_gpus,
+                num_accelerators=create_resource_quota.num_accelerators,
+            ),
+        )
+
+        resource_quota = self.client.create_resource_quota(
+            create_resource_quota=create_resource_quota_model
+        )
+
+        return ResourceQuota(
+            id=resource_quota.id,
+            name=resource_quota.name,
+            cloud_id=resource_quota.cloud_id,
+            project_id=resource_quota.project_id,
+            user_id=resource_quota.user_id,
+            is_enabled=resource_quota.is_enabled,
+            created_at=resource_quota.created_at,
+            deleted_at=resource_quota.deleted_at,
+            quota=Quota(
+                num_cpus=resource_quota.quota.num_cpus,
+                num_instances=resource_quota.quota.num_instances,
+                num_gpus=resource_quota.quota.num_gpus,
+                num_accelerators=resource_quota.quota.num_accelerators,
+            ),
+        )
+
+    def list(
+        self,
+        name: Optional[str] = None,
+        cloud: Optional[str] = None,
+        creator_id: Optional[str] = None,
+        is_enabled: Optional[bool] = None,
+        max_items: int = 20,
+    ) -> List[ResourceQuota]:
+        cloud_id = (
+            self.client.get_cloud_id(cloud_name=cloud, compute_config_id=None)
+            if cloud
+            else None
+        )
+
+        resource_quotas = self.client.list_resource_quotas(
+            name, cloud_id, creator_id, is_enabled, max_items,
+        )
+
+        return [
+            ResourceQuota(
+                id=resource_quota.id,
+                name=resource_quota.name,
+                cloud_id=resource_quota.cloud_id,
+                project_id=resource_quota.project_id,
+                user_id=resource_quota.user_id,
+                is_enabled=resource_quota.is_enabled,
+                created_at=resource_quota.created_at,
+                deleted_at=resource_quota.deleted_at,
+                quota=Quota(
+                    num_cpus=resource_quota.quota.num_cpus,
+                    num_instances=resource_quota.quota.num_instances,
+                    num_gpus=resource_quota.quota.num_gpus,
+                    num_accelerators=resource_quota.quota.num_accelerators,
+                ),
+            )
+            for resource_quota in resource_quotas
+        ]
+
+    def delete(self, resource_quota_id: str) -> None:
+        self.client.delete_resource_quota(resource_quota_id=resource_quota_id)
+
+    def set_status(self, resource_quota_id: str, is_enabled: bool) -> None:
+        self.client.set_resource_quota_status(
+            resource_quota_id=resource_quota_id, is_enabled=is_enabled
+        )

anyscale/resource_quota/commands.py

@@ -0,0 +1,150 @@
+from typing import List, Optional
+
+from anyscale._private.sdk import sdk_command
+from anyscale.resource_quota._private.resource_quota_sdk import PrivateResourceQuotaSDK
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
+
+
+_RESOURCE_QUOTA_SDK_SINGLETON_KEY = "resource_quota_sdk"
+
+_CREATE_EXAMPLE = """
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota
+
+anyscale.resource_quota.create(
+    ResourceQuota(
+        name="my-resource-quota",
+        cloud="my-cloud",
+        project="my-project",
+        num_cpus=2,
+    ),
+)
+"""
+
+_CREATE_DOCSTRINGS = {"create_resource_quota": "The resource quota to be created."}
+
+_LIST_EXAMPLE = """
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota
+
+anyscale.resource_quota.list(
+    name="my-resource-quota",
+    cloud="my-cloud",
+    creator_id="usr_123",
+    is_enabled=True,
+    max_items=20,
+)
+"""
+
+_LIST_DOCSTRINGS = {
+    "name": "Name of the resource quota.",
+    "cloud": "Name of the cloud that this resource quota applies to.",
+    "creator_id": "ID of the creator of the resource quota.",
+    "is_enabled": "Whether the resource quota is enabled.",
+    "max_items": "Maximum number of items to return.",
+}
+
+_DELETE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.delete(
+    resource_quota_id="rq_123",
+)
+"""
+
+_DELETE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to delete.",
+}
+
+_ENABLE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.enable(
+    resource_quota_id="rq_123",
+)
+"""
+
+_ENABLE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to enable.",
+}
+
+_DISABLE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.disable(
+    resource_quota_id="rq_123",
+)
+"""
+
+_DISABLE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to disable.",
+}
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_CREATE_EXAMPLE,
+    arg_docstrings=_CREATE_DOCSTRINGS,
+)
+def create(
+    create_resource_quota: CreateResourceQuota, *, _sdk: PrivateResourceQuotaSDK
+) -> ResourceQuota:
+    """Create a resource quota.
+    """
+    return _sdk.create(create_resource_quota)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_LIST_EXAMPLE,
+    arg_docstrings=_LIST_DOCSTRINGS,
+)
+def list(  # noqa: A001
+    name: Optional[str] = None,
+    cloud: Optional[str] = None,
+    creator_id: Optional[str] = None,
+    is_enabled: Optional[bool] = None,
+    max_items: int = 20,
+    *,
+    _sdk: PrivateResourceQuotaSDK
+) -> List[ResourceQuota]:
+    """List resource quotas. """
+    return _sdk.list(name, cloud, creator_id, is_enabled, max_items,)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_DELETE_EXAMPLE,
+    arg_docstrings=_DELETE_DOCSTRINGS,
+)
+def delete(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Delete a resource quota.
+    """
+    return _sdk.delete(resource_quota_id)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_ENABLE_EXAMPLE,
+    arg_docstrings=_ENABLE_DOCSTRINGS,
+)
+def enable(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Enable a resource quota.
+    """
+    return _sdk.set_status(resource_quota_id, True)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_DISABLE_EXAMPLE,
+    arg_docstrings=_DISABLE_DOCSTRINGS,
+)
+def disable(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Disable a resource quota.
+    """
+    return _sdk.set_status(resource_quota_id, False)