anyscale 0.24.86__py3-none-any.whl

anyscale/shared_anyscale_utils/aws.py

@@ -0,0 +1,153 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import dataclasses
+from typing import Any, Optional, Type, TypeVar
+
+
+_S3_BUCKET_ARN_PREFIX = "arn:aws:s3"
+AWS_ROLE_ARN_RESOURCE_ID_PREFIX = "role/"
+_AwsArnT = TypeVar("_AwsArnT", bound="AwsArn")
+NoneType = type(None)
+
+
+@dataclasses.dataclass
+class AwsArn:
+    partition: str
+    service: str
+    resource_id: str
+    region: Optional[str] = dataclasses.field(default=None)
+    account_id: Optional[str] = dataclasses.field(default=None)
+
+    def _validate_fields(self):
+        """Enforce typing of each field."""
+        if not isinstance(self.partition, str):
+            raise ValueError(f"Partition is of type {type(self.partition)}, not str")
+
+        if not isinstance(self.service, str):
+            raise ValueError(f"Service is of type {type(self.service)}, not str")
+
+        if not isinstance(self.region, (str, type(None))):
+            raise ValueError(
+                f"Region is of type {type(self.region)}, not Optional[str]"
+            )
+
+        if not isinstance(self.account_id, (str, type(None))):
+            raise ValueError(
+                "Account ID is of type {}, not Optional[str]".format(
+                    type(self.account_id)
+                )
+            )
+
+        if not isinstance(self.resource_id, str):
+            raise ValueError(f"ResourceId is of type {type(self.resource_id)}, not str")
+
+    def _empty_str_to_none(self):
+        """Sets empty strings to None."""
+        for k, v in dataclasses.asdict(self).items():
+            if v == "":
+                setattr(self, k, None)
+
+    def __post_init__(self):
+        # pydantic.validator("*", pre=True)
+        self._empty_str_to_none()
+
+        # Standard pydantic validation
+        self._validate_fields()
+
+    @classmethod
+    def from_string(cls: Type[_AwsArnT], arn: str) -> _AwsArnT:
+        """Convert an AWS ARN string into a Pydantic Model.
+
+        The ARN is a standard format in AWS with
+        the following format:
+        arn:<partition>:<service>:<region>:<account>:<resource>
+        0       1          2         3        4         5
+
+        > arn:aws:apprunner:us-west-2:959243851260:my_app
+
+        Region & Account can be empty i.e:
+        > arn:aws:s3:::bucketName
+        """
+        spl = arn.split(":")
+        if len(spl) != 6 or spl[0] != "arn":
+            raise ValueError(f"invalid arn: {arn}")
+        return cls(
+            partition=spl[1],
+            service=spl[2],
+            region=spl[3],
+            account_id=spl[4],
+            resource_id=spl[5],
+        )
+
+    def to_string(self) -> str:
+        return "arn:{p}:{s}:{reg}:{a}:{rid}".format(
+            p=self.partition,
+            s=self.service,
+            reg=self.region or "",
+            a=self.account_id or "",
+            rid=self.resource_id,
+        )
+
+
+@dataclasses.dataclass
+class AwsRoleArn(AwsArn):
+    """Role ARNs are of the format arn:aws:iam::<account>:role/<role name>."""
+
+    account_id: str
+    region: NoneType
+
+    def _validate_role(self):
+        """Validate that a Role has the correct ResourceId."""
+        if self.region is not None:
+            raise ValueError("Roles do not have a region!")
+        if self.account_id is None:
+            raise ValueError("No AccountId")
+        if not self.resource_id.startswith(AWS_ROLE_ARN_RESOURCE_ID_PREFIX):
+            raise ValueError(f"ResourceId {self.resource_id} is not a role")
+
+    def __post_init__(self):
+        self.partition = "aws"
+        self.service = "iam"
+
+        super().__post_init__()
+        self._validate_role()
+
+    @classmethod
+    def from_role_name(
+        cls: Type[_AwsArnT], account_id: str, role_name: str
+    ) -> _AwsArnT:
+        return cls(
+            partition="aws",
+            service="iam",
+            account_id=account_id,
+            resource_id=f"role/{role_name}",
+        )
+
+    def to_role_name(self) -> str:
+        """Get the role name from a role ARN.
+        If there is a path, this gets the actual name (which is following the last slash).
+        Role with path (`/anyscale/`): arn:aws:iam::959243851260:role/anyscale/thomas-test-role
+        The Role name *is* `thomas-test-role`
+        NOTE: The resource_id for a Role is "role/<role_name>".
+        """
+        return self.resource_id.split("/")[-1]
+
+
+def get_dataplane_role_arn(
+    account_id: str, cloud_resource_record: Optional[Any],
+) -> AwsRoleArn:
+    """ Helper method to get instance role from cloud_resource_record. """
+    if cloud_resource_record and cloud_resource_record.aws_iam_role_arns:
+        return AwsRoleArn.from_string(cloud_resource_record.aws_iam_role_arns[1])
+
+    return AwsRoleArn.from_role_name(
+        account_id=account_id, role_name="ray-autoscaler-v1",
+    )
+
+
+def bucket_name_from_maybe_bucket_arn(s3_bucket_id: str) -> str:
+    """We sometimes store buckets as an ARN.
+    This means the id has the format of "arn:aws:s3:::key/bucket" instead of "key/bucket."""
+    if s3_bucket_id.startswith(_S3_BUCKET_ARN_PREFIX):
+        s3_bucket_id = AwsArn.from_string(s3_bucket_id).resource_id
+
+    return s3_bucket_id

anyscale/shared_anyscale_utils/bytes_util.py

@@ -0,0 +1,10 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+from enum import Enum
+
+
+class Bytes(int, Enum):
+    """Gets the number of bytes per unit."""
+
+    KB = 1024
+    MB = 1024 * KB
+    GB = 1024 * MB

anyscale/shared_anyscale_utils/conf.py

@@ -0,0 +1,47 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import os
+
+
+TEST_MODE = os.environ.get("TEST_MODE") == "1"
+
+ANYSCALE_ENDPOINTS = {
+    "development": "https://console.anyscale-dev.dev",
+    "staging": "https://console.anyscale-staging.com",
+    "production": "https://console.anyscale.com",
+    "predeploy": "https://console.predeploy.anyscale.dev",
+    "test": "",
+}
+
+ANYSCALE_CORS_ORIGINS = {
+    # development
+    "https://console.anyscale-dev.dev": "https://*.anyscale-dev.dev",
+    # staging
+    "https://console.anyscale-staging.com": "https://*.anyscale-staging.com",
+    # production
+    "https://console.anyscale.com": "https://*.anyscale.com",
+    # predeploy
+    "https://console.predeploy.anyscale.dev": "https://*.predeploy.anyscale.dev",
+}
+
+ANYSCALE_EXTERNAL_API_ENDPOINTS = {
+    "development": "https://anyscale-dev.dev/ext",
+    "staging": "https://api.anyscale-staging.com",
+    "production": "https://api.anyscale.com",
+    "predeploy": "https://api.predeploy.anyscale.dev",
+    "test": "",
+}
+
+if (
+    "ANYSCALE_HOST" in os.environ
+    and os.environ.get("ANYSCALE_HOST") not in ANYSCALE_ENDPOINTS.values()
+):
+    anyscale_env_default = "test"
+else:
+    anyscale_env_default = "production"
+
+ANYSCALE_ENV = os.environ.get("DEPLOY_ENVIRONMENT", anyscale_env_default)
+ANYSCALE_HOST = os.environ.get("ANYSCALE_HOST", ANYSCALE_ENDPOINTS[ANYSCALE_ENV])
+ANYSCALE_CORS_ORIGIN = ANYSCALE_CORS_ORIGINS.get(
+    ANYSCALE_HOST, "https://*.anyscale-dev.dev"
+)
+ANYSCALE_API_HOST = ANYSCALE_EXTERNAL_API_ENDPOINTS[ANYSCALE_ENV]

anyscale/shared_anyscale_utils/default_anyscale_aws.yaml

@@ -0,0 +1,74 @@
+cluster_name: default
+
+max_workers: 1
+
+upscaling_speed: 1.0
+
+idle_timeout_minutes: 5
+
+docker:
+    image: anyscale/ray-ml:latest
+    container_name: ray_container
+    pull_before_run: false
+
+# Cloud-provider specific configuration.
+provider:
+    type: aws
+    region: us-west-2
+
+available_node_types:
+    anyscale.head.default:
+        node_config:
+            InstanceType: m5.large
+            BlockDeviceMappings:
+              - DeviceName: /dev/sda1
+                Ebs:
+                    VolumeSize: 500
+        resources: {}
+        min_workers: 0
+        max_workers: 0
+    anyscale.worker.small:
+        node_config:
+            InstanceType: m5.large
+            BlockDeviceMappings:
+              - DeviceName: /dev/sda1
+                Ebs:
+                    VolumeSize: 500
+        resources: {}
+        min_workers: 0
+        max_workers: 1
+
+# Specify the node type of the head node (as configured above).
+head_node_type: anyscale.head.default
+
+# How Ray will authenticate with newly launched nodes.
+auth:
+    ssh_user: ubuntu
+
+initialization_commands: []
+
+setup_commands: []
+
+head_setup_commands: []
+
+worker_setup_commands: []
+
+head_start_ray_commands:
+    - "ray stop --force; ulimit -n 65536; ray start --head --port=6379 --object-manager-port=8076 --gcs-server-port=9031 --no-monitor"
+
+worker_start_ray_commands:
+    - "ray stop --force; ulimit -n 65536; ray start --address=$RAY_HEAD_IP:6379 --object-manager-port=8076"
+
+# Default values for file synchronization
+cluster_synced_files: []
+
+file_mounts_sync_continuously: False
+
+file_mounts: {}
+
+rsync_exclude:
+    - "**/.git"
+    - "**/.git/**"
+
+rsync_filter:
+    - ".gitignore"

anyscale/shared_anyscale_utils/default_anyscale_gcp.yaml

@@ -0,0 +1,80 @@
+cluster_name: default
+
+max_workers: 1
+
+upscaling_speed: 1.0
+
+idle_timeout_minutes: 5
+
+docker:
+    image: anyscale/ray-ml:latest
+    container_name: ray_container
+    pull_before_run: false
+
+# Cloud-provider specific configuration.
+provider:
+    type: gcp
+    region: us-west1
+    availability_zone: us-west1-a
+    is_k8s: false
+
+available_node_types:
+    anyscale.head.default:
+        node_config:
+            machineType: n2-standard-8
+            disks:
+              - boot: true
+                autoDelete: true
+                type: PERSISTENT
+                initializeParams:
+                    diskSizeGb: 100
+        resources: {}
+        min_workers: 0
+        max_workers: 0
+    anyscale.worker.small:
+        node_config:
+            machineType: n2-standard-8
+            disks:
+              - boot: true
+                autoDelete: true
+                type: PERSISTENT
+                initializeParams:
+                    diskSizeGb: 100
+        resources: {}
+        min_workers: 0
+        max_workers: 1
+
+# Specify the node type of the head node (as configured above).
+head_node_type: anyscale.head.default
+
+# How Ray will authenticate with newly launched nodes.
+auth:
+    ssh_user: ubuntu
+
+initialization_commands: []
+
+setup_commands: []
+
+head_setup_commands: []
+
+worker_setup_commands: []
+
+head_start_ray_commands:
+    - "ray stop --force; ulimit -n 65536; ray start --head --port=6379 --object-manager-port=8076 --gcs-server-port=9031 --no-monitor"
+
+worker_start_ray_commands:
+    - "ray stop --force; ulimit -n 65536; ray start --address=$RAY_HEAD_IP:6379 --object-manager-port=8076"
+
+# Default values for file synchronization
+cluster_synced_files: []
+
+file_mounts_sync_continuously: False
+
+file_mounts: {}
+
+rsync_exclude:
+    - "**/.git"
+    - "**/.git/**"
+
+rsync_filter:
+    - ".gitignore"

anyscale/shared_anyscale_utils/headers.py

@@ -0,0 +1,38 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+from enum import Enum
+
+
+"""
+Headers used within Anyscale
+"""
+
+
+class RequestHeaders(str, Enum):
+    """
+    Request headers, set by the client.
+    """
+
+    # Standardized authorization header
+    # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
+    AUTHORIZATION = "Authorization"
+
+    # Identifies type of client (Web, SDK, CLI, etc.)
+    CLIENT = "X-Anyscale-Client"
+
+    # Identifies the version of the client
+    CLIENT_VERSION = "X-Anyscale-Client-Version"
+
+    # Identifies the source of the client
+    SOURCE = "X-Anyscale-Source"
+
+
+class ResponseHeaders(str, Enum):
+    """
+    Response headers, set by our server.
+    """
+
+    # Identifies a tenant for observability, used for authenticating requests to Cortex
+    TENANT_ID = "X-Anyscale-Tenant-Id"
+
+    # Identifies a user in Grafana, used for authenticating user requests to Grafana
+    GRAFANA_USER_ID = "X-Anyscale-Grafana-User-Id"

anyscale/shared_anyscale_utils/latest_ray_version.py

@@ -0,0 +1,2 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+LATEST_RAY_VERSION = "2.40.0"

anyscale/shared_anyscale_utils/project.py

@@ -0,0 +1,15 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import json
+import os
+
+import yaml
+
+
+# TODO(nikita): Remove CLUSTER_YAML_TEMPLATE and CLUSTER_CONFIG_TEMPLATE_STR once we remove cluster config
+# from projects model.
+with open(os.path.join(os.path.dirname(__file__), "default_anyscale_aws.yaml")) as f:
+    CLUSTER_YAML_TEMPLATE = f.read()
+
+CLUSTER_CONFIG_TEMPLATE_STR = json.dumps(
+    yaml.load(CLUSTER_YAML_TEMPLATE, Loader=yaml.SafeLoader)
+)

anyscale/shared_anyscale_utils/test_util.py

@@ -0,0 +1,22 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+from typing import Any, Dict, Tuple
+from unittest.mock import _Call, MagicMock
+
+
+# For `async with a() as b:`
+class MockAsyncContextManagerReturnValue(MagicMock):
+    async def __aenter__(self, *args) -> "MockAsyncContextManagerReturnValue":
+        return self
+
+    async def __aexit__(self, *args) -> None:
+        return None
+
+
+def get_args_from_call(call: _Call) -> Tuple[Any, ...]:
+    args_tuple: Tuple[Any, ...] = call[0]
+    return args_tuple
+
+
+def get_kwargs_from_call(call: _Call) -> Dict[str, Any]:
+    kw_args_dict: Dict[str, Any] = call[1]
+    return kw_args_dict

anyscale/shared_anyscale_utils/tests/__init__.py

@@ -0,0 +1 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes

anyscale/shared_anyscale_utils/tests/test_asyncio.py

@@ -0,0 +1,41 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import asyncio
+
+import pytest
+
+from shared_anyscale_utils.utils.asyncio import chain_future, create_future
+
+
+@pytest.mark.parametrize("result", [42, Exception("failed!")])
+async def test_chain_future_completes(result):
+    one = create_future()
+    other = create_future()
+
+    chain_future(one, other)
+
+    if isinstance(result, Exception):
+        one.set_exception(result)
+    else:
+        one.set_result(result)
+
+    await asyncio.gather(other, return_exceptions=True)
+
+    if isinstance(result, Exception):
+        assert str(other.exception()) == str(result)
+    else:
+        assert other.result() == 42
+
+
+async def test_chain_future_cancellation():
+    one = create_future()
+    other = create_future()
+
+    chain_future(one, other)
+
+    one.cancel()
+
+    # NOTE: We're using `gather` to retrieve `CancelledError` since `future.exception` will
+    #       raise it instead of returning it
+    e = (await asyncio.gather(other, return_exceptions=True))[0]
+
+    assert type(e) == asyncio.CancelledError

anyscale/shared_anyscale_utils/tests/test_ray_semver.py

@@ -0,0 +1,63 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import pytest
+
+from shared_anyscale_utils.utils.ray_semver import (
+    _number_prefix_split,
+    _number_suffix_split,
+    _number_value,
+    ray_semver_compare,
+)
+
+
+def test_number_value():
+    assert _number_value("1") == 1
+    assert _number_value("0") == 0
+    assert _number_value("11") == 11
+    assert _number_value("1.2") == 0
+    assert _number_value("1.2.3") == 0
+    assert _number_value("") == 0
+
+
+def test_number_suffix_split():
+    assert _number_suffix_split("") == ("", "")
+    assert _number_suffix_split("ray2") == ("ray", "2")
+    assert _number_suffix_split("ray11") == ("ray", "11")
+    assert _number_suffix_split("ray11a") == ("ray11a", "")
+
+
+def test_number_prefix_split():
+    assert _number_prefix_split("1") == ("1", "")
+    assert _number_prefix_split("2rc") == ("2", "rc")
+    assert _number_prefix_split("11opt") == ("11", "opt")
+    assert _number_prefix_split("x11") == ("", "x11")
+
+
+@pytest.mark.parametrize(
+    ("a", "b", "expected_result"),
+    [
+        ("2.7.0", "2.7.0", 0),
+        ("ray2.7.0", "ray2.7.0", 0),
+        ("2.7.0", "ray2.7.0", -1),
+        ("rayml2.7.0", "ray2.7.0", 1),
+        ("2.7.0optimized", "2.7.0", 1),
+        ("2.7.0", "2.7.0optimized", -1),
+        ("2.0.1rc1", "2.0.1rc2", -1),
+        ("2.7.0", "2.7.0oss", -1),
+        ("2.0.1rc", "2.0.1", 1),
+        ("3.5.1customsuffix", "3.5.1", 1),
+        ("1.2.3", "1.2.3.dev456", -1),
+        ("2.0.0.final", "2.0.0", 1),
+        ("2.0.0", "2.0.0.final", -1),
+        ("2.6.0", "2.7.0", -1),
+        ("2.6.0", "2.11.0", -1),
+        ("2.0.1rc", "2.0.2", -1),
+        ("2.7.0optimized", "2.7.0oss", -1),
+        ("nightly", "2.7.0", 1),
+    ],
+)
+def test_ray_semver_compare(a, b, expected_result):
+    if a != b:
+        assert expected_result != 0
+    assert ray_semver_compare(a, b) == expected_result
+    if expected_result != 0:
+        assert ray_semver_compare(b, a) == -expected_result

anyscale/shared_anyscale_utils/util.py

@@ -0,0 +1,50 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+import base64
+import re
+from typing import Any, Dict
+import unicodedata
+
+
+def execution_log_name(session_command_id: str) -> str:
+    # Note: this path is no longer correct. We should remove this once
+    # we've cleaned up the logic backing `/api/v2/session_commands/{session_command_id}/execution_logs`
+    # and migrate the webterminal to a sidecar/standalone executable.
+    return "/tmp/ray_command_output_{session_command_id}".format(
+        session_command_id=session_command_id
+    )
+
+
+def startup_log_name(session_id: str) -> str:
+    return f"/tmp/session_startup_logs_{session_id}"
+
+
+def startup_log_name_v2(session_id: str, encoded: bool = False) -> str:
+    startup_log_name = "/var/log/anyscale/session_startup_logs_{session_id}".format(
+        session_id=session_id
+    )
+
+    if encoded:
+        # The encoding should be the same as `encodePathToFileName` in go/infra/anyscaled/internal/logcache/utils.go
+        return base64.standard_b64encode(f"{startup_log_name}.out".encode()).decode()
+    else:
+        return startup_log_name
+
+
+def slugify(value: str) -> str:
+    """
+    Code adopted from here https://github.com/django/django/blob/master/django/utils/text.py
+
+    Convert  to ASCII. Convert spaces to hyphens.
+    Remove characters that aren't alphanumerics, underscores, or hyphens.
+    Also strip leading and trailing whitespace.
+    """
+
+    value = (
+        unicodedata.normalize("NFKD", value).encode("ascii", "ignore").decode("ascii")
+    )
+    value = re.sub(r"[^\w\s-]", "", value).strip()
+    return re.sub(r"[-\s]+", "-", value)
+
+
+def get_container_name(cluster_config: Dict[str, Any]) -> str:
+    return str(cluster_config.get("docker", {}).get("container_name", ""))

anyscale/shared_anyscale_utils/utils/__init__.py

@@ -0,0 +1,2 @@
+# AUTOGENERATED - modify shared_anyscale_util in root directory to make changes
+INT_MAX = 2 ** 63 - 1