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

anyscale/controllers/job_controller.py

@@ -29,7 +29,7 @@ from anyscale.client.openapi_client.models.decorated_production_job import (
 from anyscale.client.openapi_client.models.ha_job_states import HaJobStates
 from anyscale.controllers.base_controller import BaseController
 from anyscale.models.job_model import JobConfig
-from anyscale.project import infer_project_id
+from anyscale.project_utils import infer_project_id
 from anyscale.sdk.anyscale_client.models.job import Job
 from anyscale.sdk.anyscale_client.models.jobs_query import JobsQuery
 from anyscale.sdk.anyscale_client.models.jobs_sort_field import JobsSortField
@@ -65,6 +65,8 @@ _PENDING_STATES = {
     HaJobStates.RESTARTING,
 }
 
+DEFAULT_PAGE_LIMIT = 500
+
 
 class MiniJobRun(BaseModel):
     last_job_run_id: str
@@ -292,6 +294,7 @@ class JobController(BaseController):
         project_id: Optional[str],
         include_archived: bool,
         max_items: int,
+        states: List[str],
     ) -> None:
         """
         This function will list jobs.
@@ -342,7 +345,8 @@ class JobController(BaseController):
                 creator_id=creator_id,
                 type_filter="BATCH_JOB",
                 archive_status="ALL" if include_archived else "NOT_ARCHIVED",
-                count=10,
+                count=DEFAULT_PAGE_LIMIT,
+                state_filter=states,
             )
             jobs_list.extend(resp.results)
             paging_token = resp.metadata.next_paging_token
@@ -354,8 +358,9 @@ class JobController(BaseController):
                     creator_id=creator_id,
                     type_filter="BATCH_JOB",
                     archive_status="ALL" if include_archived else "NOT_ARCHIVED",
-                    count=10,
+                    count=DEFAULT_PAGE_LIMIT,
                     paging_token=paging_token,
+                    state_filter=states,
                 )
                 jobs_list.extend(resp.results)
                 paging_token = resp.metadata.next_paging_token

anyscale/controllers/list_controller.py

@@ -9,10 +9,10 @@ from typing import Any, Dict, List, Optional, Tuple
 import tabulate
 
 from anyscale.cli_logger import BlockLogger
-from anyscale.cloud import get_cloud_json_from_id
+from anyscale.cloud_utils import get_cloud_json_from_id
 from anyscale.controllers.base_controller import BaseController
 from anyscale.formatters import clouds_formatter
-from anyscale.project import (
+from anyscale.project_utils import (
     get_project_id,
     load_project_or_throw,
 )

anyscale/controllers/machine_pool_controller.py

@@ -10,11 +10,13 @@ from anyscale.client.openapi_client.models import (
     CreateMachinePoolRequest,
     CreateMachinePoolResponse,
     DeleteMachinePoolRequest,
+    DescribeMachinePoolRequest,
+    DescribeMachinePoolResponse,
     DetachMachinePoolFromCloudRequest,
     ListMachinePoolsResponse,
     UpdateMachinePoolRequest,
 )
-from anyscale.cloud import get_cloud_id_and_name
+from anyscale.cloud_utils import get_cloud_id_and_name
 from anyscale.controllers.base_controller import BaseController
 
 
@@ -65,6 +67,15 @@ class MachinePoolController(BaseController):
             UpdateMachinePoolRequest(machine_pool_name=machine_pool_name, spec=spec,)
         )
 
+    def describe_machine_pool(
+        self, machine_pool_name: str,
+    ) -> DescribeMachinePoolResponse:
+        return self.api_client.describe_machine_pool_api_v2_machine_pools_describe_post(
+            describe_machine_pool_request=DescribeMachinePoolRequest(
+                machine_pool_name=machine_pool_name,
+            )
+        ).result
+
     def list_machine_pools(self,) -> ListMachinePoolsResponse:
         response = self.api_client.list_machine_pools_api_v2_machine_pools_get().result
         return response

anyscale/controllers/project_controller.py

@@ -8,9 +8,10 @@ import tabulate
 
 import anyscale
 from anyscale.cli_logger import BlockLogger
-from anyscale.cloud import get_cloud_id_and_name
+from anyscale.cloud_utils import get_cloud_id_and_name
 from anyscale.controllers.base_controller import BaseController
-from anyscale.project import (  # pylint:disable=private-import
+import anyscale.project_utils
+from anyscale.project_utils import (  # pylint:disable=private-import
     attach_to_project_with_id,
     create_new_proj_def,
     get_proj_id_from_name,
@@ -102,7 +103,7 @@ class ProjectController(BaseController):
                 "and compute configs."
             )
             self.log.warning(message)
-        project_id_path = anyscale.project.ANYSCALE_PROJECT_FILE
+        project_id_path = anyscale.project_utils.ANYSCALE_PROJECT_FILE
 
         if project_id:
             # Exactly one of project_id or name must be provided

anyscale/controllers/schedule_controller.py

@@ -22,7 +22,7 @@ from anyscale.client.openapi_client.models.schedule_config import (
 )
 from anyscale.controllers.base_controller import BaseController
 from anyscale.models.job_model import JobConfig
-from anyscale.project import infer_project_id
+from anyscale.project_utils import infer_project_id
 from anyscale.tables import SchedulesTable
 from anyscale.util import (
     AnyscaleEndpointFormatter,

anyscale/controllers/service_controller.py

@@ -19,7 +19,7 @@ from anyscale.client.openapi_client.models.decorated_production_service_v2_api_m
 )
 from anyscale.controllers.base_controller import BaseController
 from anyscale.models.service_model import ServiceConfig
-from anyscale.project import infer_project_id
+from anyscale.project_utils import infer_project_id
 from anyscale.sdk.anyscale_client.models import (
     ApplyServiceModel,
     RollbackServiceModel,

anyscale/controllers/workspace_controller.py

@@ -15,7 +15,7 @@ from anyscale.client.openapi_client.models.experimental_workspace import (
 )
 from anyscale.controllers.base_controller import BaseController
 from anyscale.feature_flags import FLAG_DEFAULT_WORKING_DIR_FOR_PROJ
-from anyscale.project import get_default_project
+from anyscale.project_utils import get_default_project
 from anyscale.util import get_endpoint
 from anyscale.utils.workspace_utils import (
     extract_workspace_parameters,

anyscale/models/job_model.py

@@ -23,7 +23,7 @@ from anyscale.cluster_env import (
     get_default_cluster_env_build,
     validate_successful_build,
 )
-from anyscale.project import (
+from anyscale.project_utils import (
     get_parent_cloud_id_and_name_of_project,
     get_proj_id_from_name,
 )

anyscale/organization_invitation/__init__.py

@@ -0,0 +1,61 @@
+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.organization_invitation._private.organization_invitation_sdk import (
+    PrivateOrganizationInvitationSDK,
+)
+from anyscale.organization_invitation.commands import (
+    _CREATE_ARG_DOCSTRINGS,
+    _CREATE_EXAMPLE,
+    _DELETE_ARG_DOCSTRINGS,
+    _DELETE_EXAMPLE,
+    _LIST_ARG_DOCSTRINGS,
+    _LIST_EXAMPLE,
+    create,
+    delete,
+    list,
+)
+
+
+class OrganizationInvitationSDK:
+    def __init__(
+        self,
+        *,
+        client: Optional[AnyscaleClientInterface] = None,
+        logger: Optional[BlockLogger] = None,
+        timer: Optional[Timer] = None,
+    ):
+        self._private_sdk = PrivateOrganizationInvitationSDK(
+            client=client, logger=logger, timer=timer
+        )
+
+    @sdk_docs(
+        doc_py_example=_CREATE_EXAMPLE, arg_docstrings=_CREATE_ARG_DOCSTRINGS,
+    )
+    def create(  # noqa: F811
+        self, emails: List[str],
+    ):
+        """Creates organization invitations for the provided emails
+        """
+        return self._private_sdk.create(emails=emails)
+
+    @sdk_docs(
+        doc_py_example=_LIST_EXAMPLE, arg_docstrings=_LIST_ARG_DOCSTRINGS,
+    )
+    def list(self):  # noqa: F811
+        """Lists organization invitations
+        """
+        return self._private_sdk.list()
+
+    @sdk_docs(
+        doc_py_example=_DELETE_EXAMPLE, arg_docstrings=_DELETE_ARG_DOCSTRINGS,
+    )
+    def delete(  # noqa: F811
+        self, email: str,
+    ):
+        """Deletes an organization invitation
+        """
+        return self._private_sdk.delete(email=email)

anyscale/organization_invitation/_private/organization_invitation_sdk.py

@@ -0,0 +1,24 @@
+from typing import List, Tuple
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.organization_invitation.models import OrganizationInvitation
+
+
+class PrivateOrganizationInvitationSDK(BaseSDK):
+    def create(self, emails: List[str]) -> Tuple[List[str], List[str]]:
+        return self.client.create_organization_invitations(emails=emails)
+
+    def list(self) -> List[OrganizationInvitation]:
+        invitations = self.client.list_organization_invitations()
+        return [
+            OrganizationInvitation(
+                id=invitation.id,
+                email=invitation.email,
+                created_at=invitation.created_at,
+                expires_at=invitation.expires_at,
+            )
+            for invitation in invitations
+        ]
+
+    def delete(self, email: str) -> str:
+        return self.client.delete_organization_invitation(email=email).email

anyscale/organization_invitation/commands.py

@@ -0,0 +1,84 @@
+from typing import Dict, List, Tuple
+
+from anyscale._private.sdk import sdk_command
+from anyscale.organization_invitation._private.organization_invitation_sdk import (
+    PrivateOrganizationInvitationSDK,
+)
+from anyscale.organization_invitation.models import OrganizationInvitation
+
+
+_ORGANIZATION_INVITATION_SDK_SINGLETON_KEY = "organization_invitation_sdk"
+
+_CREATE_EXAMPLE = """
+import anyscale
+
+anyscale.organization_invitation.create(emails=["test1@anyscale.com","test2@anyscale.com"])
+"""
+
+_CREATE_ARG_DOCSTRINGS = {
+    "emails": "The emails to send the organization invitations to."
+}
+
+_LIST_EXAMPLE = """
+import anyscale
+
+anyscale.organization_invitation.list()
+"""
+
+_LIST_ARG_DOCSTRINGS: Dict[str, str] = {}
+
+_DELETE_EXAMPLE = """
+import anyscale
+
+anyscale.organization_invitation.delete(email="test@anyscale.com")
+"""
+
+_DELETE_ARG_DOCSTRINGS = {
+    "email": "The email of the organization invitation to delete."
+}
+
+
+@sdk_command(
+    _ORGANIZATION_INVITATION_SDK_SINGLETON_KEY,
+    PrivateOrganizationInvitationSDK,
+    doc_py_example=_CREATE_EXAMPLE,
+    arg_docstrings=_CREATE_ARG_DOCSTRINGS,
+)
+def create(
+    emails: List[str], *, _sdk: PrivateOrganizationInvitationSDK
+) -> Tuple[List[str], List[str]]:
+    """Creates organization invitations for the provided emails.
+
+    Returns a tuple of successful emails and error messages.
+    """
+    return _sdk.create(emails=emails)
+
+
+@sdk_command(
+    _ORGANIZATION_INVITATION_SDK_SINGLETON_KEY,
+    PrivateOrganizationInvitationSDK,
+    doc_py_example=_LIST_EXAMPLE,
+    arg_docstrings=_LIST_ARG_DOCSTRINGS,
+)
+def list(  # noqa: A001
+    *, _sdk: PrivateOrganizationInvitationSDK
+) -> List[OrganizationInvitation]:
+    """Lists organization invitations.
+
+    Returns a list of organization invitations.
+    """
+    return _sdk.list()
+
+
+@sdk_command(
+    _ORGANIZATION_INVITATION_SDK_SINGLETON_KEY,
+    PrivateOrganizationInvitationSDK,
+    doc_py_example=_DELETE_EXAMPLE,
+    arg_docstrings=_DELETE_ARG_DOCSTRINGS,
+)
+def delete(email: str, *, _sdk: PrivateOrganizationInvitationSDK) -> str:
+    """Deletes an organization invitation.
+
+    Returns the email of the deleted organization invitation.
+    """
+    return _sdk.delete(email)

anyscale/organization_invitation/models.py

@@ -0,0 +1,45 @@
+from dataclasses import dataclass, field
+from datetime import datetime
+
+from anyscale._private.models import ModelBase
+
+
+@dataclass(frozen=True)
+class OrganizationInvitation(ModelBase):
+    """Organization invitation model.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.organization_invitation.models import OrganizationInvitation
+
+organization_invitations: List[OrganizationInvitation] = anyscale.organization_invitation.list()
+"""
+
+    id: str = field(metadata={"docstring": "ID of the organization invitation."},)
+
+    def _validate_id(self, id: str):  # noqa: A002
+        if not isinstance(id, str):
+            raise TypeError("id must be a string.")
+
+    email: str = field(metadata={"docstring": "Email of the organization invitation."})
+
+    def _validate_email(self, email: str):
+        if not isinstance(email, str):
+            raise TypeError("email must be a string.")
+
+    created_at: datetime = field(
+        metadata={"docstring": "Creation time of the organization invitation."},
+    )
+
+    def _validate_created_at(self, created_at: datetime):
+        if not isinstance(created_at, datetime):
+            raise TypeError("created_at must be a datetime.")
+
+    expires_at: datetime = field(
+        metadata={"docstring": "Expiration time of the organization invitation."},
+    )
+
+    def _validate_expires_at(self, expires_at: datetime):
+        if not isinstance(expires_at, datetime):
+            raise TypeError("expires_at must be a datetime.")

anyscale/project/__init__.py

@@ -0,0 +1,35 @@
+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.project._private.project_sdk import PrivateProjectSDK
+from anyscale.project.commands import (
+    _ADD_COLLABORATORS_DOCSTRINGS,
+    _ADD_COLLABORATORS_EXAMPLE,
+    add_collaborators,
+)
+from anyscale.project.models import CreateProjectCollaborator
+
+
+class ProjectSDK:
+    def __init__(
+        self,
+        *,
+        client: Optional[AnyscaleClientInterface] = None,
+        logger: Optional[BlockLogger] = None,
+        timer: Optional[Timer] = None,
+    ):
+        self._private_sdk = PrivateProjectSDK(client=client, logger=logger, timer=timer)
+
+    @sdk_docs(
+        doc_py_example=_ADD_COLLABORATORS_EXAMPLE,
+        arg_docstrings=_ADD_COLLABORATORS_DOCSTRINGS,
+    )
+    def add_collaborators(  # noqa: F811
+        self, cloud: str, project: str, collaborators: List[CreateProjectCollaborator],
+    ) -> str:
+        """Batch add collaborators to a project.
+        """
+        return self._private_sdk.add_collaborators(cloud, project, collaborators)

anyscale/project/_private/project_sdk.py

@@ -0,0 +1,27 @@
+from typing import List
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.client.openapi_client import (
+    CreateUserProjectCollaborator,
+    CreateUserProjectCollaboratorValue,
+)
+from anyscale.project.models import CreateProjectCollaborator
+
+
+class PrivateProjectSDK(BaseSDK):
+    def add_collaborators(
+        self, cloud: str, project: str, collaborators: List[CreateProjectCollaborator]
+    ) -> str:
+        cloud_id = self.client.get_cloud_id(cloud_name=cloud, compute_config_id=None)
+        project_id = self.client.get_project_id(parent_cloud_id=cloud_id, name=project)
+
+        return self.client.add_project_collaborators(
+            project_id=project_id,
+            collaborators=[
+                CreateUserProjectCollaborator(
+                    value=CreateUserProjectCollaboratorValue(email=collaborator.email),
+                    permission_level=collaborator.permission_level.lower(),
+                )
+                for collaborator in collaborators
+            ],
+        )

anyscale/project/commands.py

@@ -0,0 +1,56 @@
+from typing import List
+
+from anyscale._private.sdk import sdk_command
+from anyscale.project._private.project_sdk import PrivateProjectSDK
+from anyscale.project.models import CreateProjectCollaborator
+
+
+_PROJECT_SDK_SINGLETON_KEY = "project_sdk"
+
+_ADD_COLLABORATORS_EXAMPLE = """
+import anyscale
+from anyscale.project.models import CreateProjectCollaborator, ProjectPermissionLevel
+
+anyscale.project.add_collaborators(
+    cloud="cloud_name",
+    project="project_name",
+    collaborators=[
+        CreateProjectCollaborator(
+            email="test1@anyscale.com",
+            permission_level=ProjectPermissionLevel.OWNER,
+        ),
+        CreateProjectCollaborator(
+            email="test2@anyscale.com",
+            permission_level=ProjectPermissionLevel.WRITE,
+        ),
+        CreateProjectCollaborator(
+            email="test3@anyscale.com",
+            permission_level=ProjectPermissionLevel.READONLY,
+        ),
+    ],
+)
+"""
+
+_ADD_COLLABORATORS_DOCSTRINGS = {
+    "cloud": "The cloud that the project belongs to.",
+    "project": "The project to add users to.",
+    "collaborators": "The list of collaborators to add to the project.",
+}
+
+
+@sdk_command(
+    _PROJECT_SDK_SINGLETON_KEY,
+    PrivateProjectSDK,
+    doc_py_example=_ADD_COLLABORATORS_EXAMPLE,
+    arg_docstrings=_ADD_COLLABORATORS_DOCSTRINGS,
+)
+def add_collaborators(
+    cloud: str,
+    project: str,
+    collaborators: List[CreateProjectCollaborator],
+    *,
+    _sdk: PrivateProjectSDK
+) -> str:
+    """Batch add collaborators to a project.
+    """
+    return _sdk.add_collaborators(cloud, project, collaborators)

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,
         )