modal 1.5.2.dev22__tar.gz → 1.5.3__tar.gz

{modal-1.5.2.dev22 → modal-1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.5.2.dev22
+Version: 1.5.3
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License-Expression: Apache-2.0

{modal-1.5.2.dev22 → modal-1.5.3}/modal/_clustered_functions.py

@@ -15,6 +15,7 @@ class ClusterInfo:
     cluster_id: str
     container_ips: list[str]
     container_ipv4_ips: list[str]
+    fabric_ids: list[str]
 
 
 cluster_info: ClusterInfo | None = None
@@ -29,6 +30,14 @@ def get_cluster_info() -> ClusterInfo:
     return cluster_info
 
 
+def get_fabric_peers() -> list[int]:
+    info = get_cluster_info()
+    if info.rank >= len(info.fabric_ids) or not info.fabric_ids[info.rank]:
+        return [info.rank]
+    own_fabric_id = info.fabric_ids[info.rank]
+    return [rank for rank, fabric_id in enumerate(info.fabric_ids) if fabric_id == own_fabric_id]
+
+
 async def _initialize_clustered_function(client: _Client, task_id: str, world_size: int):
     global cluster_info
 
@@ -70,6 +79,7 @@ async def _initialize_clustered_function(client: _Client, task_id: str, world_si
             cluster_id=resp.cluster_id,
             container_ips=resp.container_ips,
             container_ipv4_ips=resp.container_ipv4_ips,
+            fabric_ids=resp.fabric_ids,
         )
     else:
         cluster_info = ClusterInfo(
@@ -77,6 +87,7 @@ async def _initialize_clustered_function(client: _Client, task_id: str, world_si
             cluster_id="",  # No cluster ID for single-node  # TODO(irfansharif): Is this right?
             container_ips=[container_ip],
             container_ipv4_ips=[],  # No IPv4 IPs for single-node
+            fabric_ids=[],
         )
 
 

{modal-1.5.2.dev22 → modal-1.5.3}/modal/_clustered_functions.pyi

@@ -3,14 +3,17 @@ import types
 import typing_extensions
 
 class ClusterInfo:
-    """ClusterInfo(rank: int, cluster_id: str, container_ips: list[str], container_ipv4_ips: list[str])"""
+    """ClusterInfo(rank: int, cluster_id: str, container_ips: list[str], container_ipv4_ips: list[str], fabric_ids: list[str])"""
 
     rank: int
     cluster_id: str
     container_ips: list[str]
     container_ipv4_ips: list[str]
+    fabric_ids: list[str]
 
-    def __init__(self, rank: int, cluster_id: str, container_ips: list[str], container_ipv4_ips: list[str]) -> None:
+    def __init__(
+        self, rank: int, cluster_id: str, container_ips: list[str], container_ipv4_ips: list[str], fabric_ids: list[str]
+    ) -> None:
         """Initialize self.  See help(type(self)) for accurate signature."""
         ...
 
@@ -23,6 +26,7 @@ class ClusterInfo:
         ...
 
 def get_cluster_info() -> ClusterInfo: ...
+def get_fabric_peers() -> list[int]: ...
 async def _initialize_clustered_function(client: modal.client._Client, task_id: str, world_size: int): ...
 
 class __initialize_clustered_function_spec(typing_extensions.Protocol):

{modal-1.5.2.dev22 → modal-1.5.3}/modal/_container_entrypoint.py

@@ -145,7 +145,7 @@ def call_function(
                             item_count += 1
 
                 await container_io_manager._send_outputs.aio(
-                    started_at, io_context.output_items_generator_done(started_at, item_count)
+                    io_context.output_items_generator_done(started_at, item_count)
                 )
             else:
                 value = await io_context.call_function_async()
@@ -182,9 +182,7 @@ def call_function(
                         container_io_manager._queue_put(generator_queue, value)
                         item_count += 1
 
-                container_io_manager._send_outputs(
-                    started_at, io_context.output_items_generator_done(started_at, item_count)
-                )
+                container_io_manager._send_outputs(io_context.output_items_generator_done(started_at, item_count))
             else:
                 values = io_context.call_function_sync()
                 container_io_manager.push_outputs(io_context, started_at, values)

{modal-1.5.2.dev22 → modal-1.5.3}/modal/_environments.py

@@ -16,11 +16,13 @@ from modal_proto import api_pb2
 from ._load_context import LoadContext
 from ._object import _Object
 from ._resolver import Resolver
+from ._utils.deprecation import deprecation_warning
 from ._utils.name_utils import check_environment_name
+from ._utils.time_utils import is_utc_month_aligned, parse_billing_cycle
 from .client import _Client
 from .config import config, logger
 from .exception import InvalidError, WorkspaceManagementError
-from .types import BillingReportItem
+from .types import BillingReportItem, EnvironmentBillingSummary
 
 
 @dataclass(frozen=True)
@@ -103,63 +105,38 @@ class _EnvironmentManager:
         await client.stub.EnvironmentDelete(api_pb2.EnvironmentDeleteRequest(name=name))
 
 
-def _role_to_proto(role: str) -> "api_pb2.EnvironmentRole.ValueType":
-    match role:
-        case "viewer":
-            return api_pb2.ENVIRONMENT_ROLE_VIEWER
-        case "contributor":
-            return api_pb2.ENVIRONMENT_ROLE_CONTRIBUTOR
-        case _:
-            raise InvalidError(f"Invalid Environment role: {role!r} (expected 'viewer' or 'contributor')")
-
-
-def _role_from_proto(proto_value: int) -> str:
-    match proto_value:
-        case api_pb2.ENVIRONMENT_ROLE_VIEWER:
-            return "viewer"
-        case api_pb2.ENVIRONMENT_ROLE_CONTRIBUTOR:
-            return "contributor"
-        case _:
-            raise ValueError(f"Unknown environment role: {proto_value}")
-
-
-class _EnvironmentMembersManager:
-    """mdmd:namespace
-    Namespace with methods for managing the membership of a restricted Environment.
-
-    See https://modal.com/docs/guide/rbac for more information on restricted Environments.
-    """
+class _EnvironmentRolesManager:
+    """mdmd:namespace"""
 
     def __init__(self, environment: "_Environment"):
         """mdmd:hidden"""
         self._environment = environment
 
     async def list(self) -> dict[Literal["users", "service_users"], dict[str, str]]:
-        """Return the members of a restricted Environment with their roles.
+        """Enumerate the Environment Role for each user and service user in the workspace.
 
         **Examples:**
 
         ```python notest
-        members = modal.Environment.from_name("my-restricted-env").members.list()
-        print(members)
+        roles = modal.Environment.from_name("my-env").roles.list()
+        print(roles)
         # {
-        #     "users": {"alice": "contributor", "bob": "viewer"},
-        #     "service_users": {"alice-bot": "contributor"},
+        #     "users": {"alice": "contributor", "bob": "viewer", "carol": "contributor"},
+        #     "service_users": {"alice-bot": "contributor", "ops-bot": "viewer", "ci-bot": "no-access"},
         # }
         ```
         """
         await self._environment.hydrate()
-        req = api_pb2.EnvironmentGetManagedRequest(environment_id=self._environment.object_id)
-        resp = await self._environment.client.stub.EnvironmentGetManaged(req)
+        req = api_pb2.EnvironmentGetRolesRequest(environment_id=self._environment.object_id)
+        resp = await self._environment.client.stub.EnvironmentGetRoles(req)
 
         users: dict[str, str] = {}
         service_users: dict[str, str] = {}
         for principal in resp.principal_roles:
-            role = _role_from_proto(principal.role)
             if principal.user_id:
-                users[principal.user_name] = role
+                users[principal.user_name] = principal.role_str
             elif principal.service_user_id:
-                service_users[principal.service_user_name] = role
+                service_users[principal.service_user_name] = principal.role_str
 
         return {"users": users, "service_users": service_users}
 
@@ -169,16 +146,17 @@ class _EnvironmentMembersManager:
         users: Mapping[str, str] | None = None,
         service_users: Mapping[str, str] | None = None,
     ) -> None:
-        """Add or modify roles for members of a restricted Environment.
+        """Update the Environment Role of users and service users.
 
-        Each user or service user will be added to the Environment if not currently a member;
-        if already a member, the user or service user's role will be updated.
+        Each role is one of 'contributor', 'viewer', or 'no-access'. Service users can be
+        assigned a role on any Environment, while workspace members can only be assigned a
+        role on restricted Environments.
 
         **Examples:**
 
         ```python notest
         env = modal.Environment.from_name("my-restricted-env")
-        env.members.update(
+        env.roles.update(
             users={"alice": "contributor", "bob": "viewer"},
             service_users={"alice-bot": "contributor"},
         )
@@ -188,13 +166,13 @@ class _EnvironmentMembersManager:
         users = users or {}
         service_users = service_users or {}
 
-        req = api_pb2.EnvironmentGetManagedRequest(environment_id=self._environment.object_id)
-        resp = await self._environment.client.stub.EnvironmentGetManaged(req)
+        req = api_pb2.EnvironmentGetRolesRequest(environment_id=self._environment.object_id)
+        resp = await self._environment.client.stub.EnvironmentGetRoles(req)
 
-        # Both current members and additional eligible workspace principals can be assigned a role
+        # EnvironmentGetRoles returns every workspace principal
         user_name_to_id: dict[str, str] = {}
         service_user_name_to_id: dict[str, str] = {}
-        for principal in [*resp.principal_roles, *resp.additional_roles]:
+        for principal in resp.principal_roles:
             if principal.user_id:
                 user_name_to_id[principal.user_name] = principal.user_id
             elif principal.service_user_id:
@@ -207,7 +185,7 @@ class _EnvironmentMembersManager:
             requests[f"User {name!r}"] = api_pb2.EnvironmentRoleSetRequest(
                 environment_id=self._environment.object_id,
                 user_id=user_name_to_id[name],
-                role=_role_to_proto(role),
+                role_str=role,
             )
         for name, role in service_users.items():
             if name not in service_user_name_to_id:
@@ -215,35 +193,70 @@ class _EnvironmentMembersManager:
             requests[f"Service user {name!r}"] = api_pb2.EnvironmentRoleSetRequest(
                 environment_id=self._environment.object_id,
                 service_user_id=service_user_name_to_id[name],
-                role=_role_to_proto(role),
+                role_str=role,
             )
 
         await self._dispatch_role_updates(requests)
 
+    async def _dispatch_role_updates(self, requests: dict[str, api_pb2.EnvironmentRoleSetRequest]) -> None:
+        """Send batched EnvironmentRoleSet RPCs and report all errors encountered."""
+        results = await asyncio.gather(
+            *(self._environment.client.stub.EnvironmentRoleSet(req) for req in requests.values()),
+            return_exceptions=True,
+        )
+        errors = [(label, result) for label, result in zip(requests.keys(), results) if isinstance(result, Exception)]
+        if errors:
+            n = len(errors)
+            header = f"{n} error{'s' if n != 1 else ''} occurred while updating Environment roles:"
+            details = "\n".join(f"  - {label}: {e}" for label, e in errors)
+            raise WorkspaceManagementError(f"{header}\n{details}")
+
+
+# Deprecated alias for `_EnvironmentRolesManager`; each method warns and delegates.
+class _EnvironmentMembersManager:
+    """mdmd:hidden"""
+
+    def __init__(self, environment: "_Environment"):
+        """mdmd:hidden"""
+        self._environment = environment
+
+    async def list(self) -> dict[Literal["users", "service_users"], dict[str, str]]:
+        deprecation_warning(
+            (2026, 7, 23),
+            "`Environment.members.list()` is deprecated; use `Environment.roles.list()` instead.",
+        )
+        return await _EnvironmentRolesManager(self._environment).list()
+
+    async def update(
+        self,
+        *,
+        users: Mapping[str, str] | None = None,
+        service_users: Mapping[str, str] | None = None,
+    ) -> None:
+        deprecation_warning(
+            (2026, 7, 23),
+            "`Environment.members.update()` is deprecated; use `Environment.roles.update()` instead.",
+        )
+        await _EnvironmentRolesManager(self._environment).update(users=users, service_users=service_users)
+
     async def remove(
         self,
         *,
         users: Iterable[str] | None = None,
         service_users: Iterable[str] | None = None,
     ) -> None:
-        """Remove members from a restricted Environment.
-
-        **Examples:**
-
-        ```python notest
-        env = modal.Environment.from_name("my-restricted-env")
-        env.members.remove(
-            users=["alice"],
-            service_users=["alice-bot"],
+        """Remove the Environment Role of users and service users, reverting them to the default."""
+        deprecation_warning(
+            (2026, 7, 23),
+            "`Environment.members.remove()` is deprecated. Environment Roles are now explicit; "
+            "set a role (e.g. 'no-access') with `Environment.roles.update()` instead.",
         )
-        ```
-        """
         await self._environment.hydrate()
         users = users or []
         service_users = service_users or []
 
-        req = api_pb2.EnvironmentGetManagedRequest(environment_id=self._environment.object_id)
-        resp = await self._environment.client.stub.EnvironmentGetManaged(req)
+        req = api_pb2.EnvironmentGetRolesRequest(environment_id=self._environment.object_id)
+        resp = await self._environment.client.stub.EnvironmentGetRoles(req)
 
         user_name_to_id: dict[str, str] = {}
         service_user_name_to_id: dict[str, str] = {}
@@ -256,7 +269,7 @@ class _EnvironmentMembersManager:
         requests: dict[str, api_pb2.EnvironmentRoleSetRequest] = {}
         for name in users:
             if name not in user_name_to_id:
-                raise InvalidError(f"User {name!r} is not a member of this Environment")
+                raise InvalidError(f"User {name!r} not found in workspace")
             requests[f"User {name!r}"] = api_pb2.EnvironmentRoleSetRequest(
                 environment_id=self._environment.object_id,
                 user_id=user_name_to_id[name],
@@ -264,27 +277,14 @@ class _EnvironmentMembersManager:
             )
         for name in service_users:
             if name not in service_user_name_to_id:
-                raise InvalidError(f"Service user {name!r} is not a member of this Environment")
+                raise InvalidError(f"Service user {name!r} not found in workspace")
             requests[f"Service user {name!r}"] = api_pb2.EnvironmentRoleSetRequest(
                 environment_id=self._environment.object_id,
                 service_user_id=service_user_name_to_id[name],
                 role=api_pb2.ENVIRONMENT_ROLE_UNSPECIFIED,
             )
 
-        await self._dispatch_role_updates(requests)
-
-    async def _dispatch_role_updates(self, requests: dict[str, api_pb2.EnvironmentRoleSetRequest]) -> None:
-        """Send batched EnvironmentRoleSet RPCs and report all errors encountered."""
-        results = await asyncio.gather(
-            *(self._environment.client.stub.EnvironmentRoleSet(req) for req in requests.values()),
-            return_exceptions=True,
-        )
-        errors = [(label, result) for label, result in zip(requests.keys(), results) if isinstance(result, Exception)]
-        if errors:
-            n = len(errors)
-            header = f"{n} error{'s' if n != 1 else ''} occurred while updating Environment members:"
-            details = "\n".join(f"  - {label}: {e}" for label, e in errors)
-            raise WorkspaceManagementError(f"{header}\n{details}")
+        await _EnvironmentRolesManager(self._environment)._dispatch_role_updates(requests)
 
 
 class _Environment(_Object, type_prefix="en"):
@@ -307,8 +307,18 @@ class _Environment(_Object, type_prefix="en"):
     def objects(cls) -> _EnvironmentManager:
         return _EnvironmentManager()
 
+    @property
+    def roles(self) -> "_EnvironmentRolesManager":
+        """Namespace with methods for managing the Environment Roles of users and service users.
+
+        See https://modal.com/docs/guide/rbac for more information on Environment Roles.
+        """
+        return _EnvironmentRolesManager(self)
+
     @property
     def members(self) -> "_EnvironmentMembersManager":
+        """mdmd:hidden"""
+        # Deprecated alias for `Environment.roles`.
         return _EnvironmentMembersManager(self)
 
     # TODO(michael) Keeping this private for now until we decide what else should be in it
@@ -393,13 +403,12 @@ class _Environment(_Object, type_prefix="en"):
 
     @property
     def billing(self) -> "_EnvironmentBillingManager":
+        """Namespace for Environment billing APIs."""
         return _EnvironmentBillingManager(self)
 
 
 class _EnvironmentBillingManager:
-    """mdmd:namespace
-    Namespace for Environment billing APIs
-    """
+    """mdmd:namespace"""
 
     def __init__(self, environment: _Environment):
         """mdmd:ignore"""
@@ -436,7 +445,7 @@ class _EnvironmentBillingManager:
             - [`modal environment billing report`](https://modal.com/docs/cli/latest/environment#modal-environment-billing-report):
               An environment report CLI that has convenience features around relative time range queries
               and JSON/CSV output.
-            - [`Workspace.billing.report()`](https://modal.com/docs/sdk/py/latest/modal.Workspace#billingreport):
+            - [`Workspace.billing.report()`](https://modal.com/docs/sdk/py/latest/Workspace#billingreport):
               An analogous report API for the entire Workspace.
 
         """
@@ -472,6 +481,71 @@ class _EnvironmentBillingManager:
             async for pb_item in self._environment.client.stub.WorkspaceBillingReport.unary_stream(request)
         ]
 
+    async def summary(
+        self,
+        cycle: str | datetime | None = None,  # Start of the summary, inclusive
+    ) -> EnvironmentBillingSummary:
+        """Return a summary of environment cost over a single billing cycle determined by `cycle`.
+
+        Unlike the analogous `Workspace.billing.summary()`, this API only emits metered cost
+        information. This is because billing adjustments due to credits, free storage, etc. are
+        applied at the Workspace level, and thus cannot be attributed to individual Environments.
+
+        Args:
+            cycle: Start of the summary, inclusive. Must be the first of a month, and must be in UTC
+                or timezone-naive (interpreted as UTC). If provided as a string, it must either be
+                formatted as an ISO 8601 month (YYYY-MM), or must be one of the convenience spellings
+                "this month" or "last month". If not provided, `cycle` defaults to the first of the
+                current month (in which case a summary is generated for the current billing cycle).
+
+        Returns:
+            A single `EnvironmentBillingSummary` dataclass containing the following fields:
+            - `metered_cost` representing cost before any adjustments, and
+            - `metered_cost_breakdown` containing a breakdown of that cost by the Modal resources
+              that generated it. The exact keys of this are subject to change as Modal's billing
+              model evolves.
+
+            All values are reported as `decimal.Decimal`s.
+
+        See also:
+            - [`modal environment billing summary`](https://modal.com/docs/cli/latest/billing#modal-environment-billing-summary):
+              An environment summary CLI that has convenience features around relative time range queries.
+            - [`Environment.billing.report()`](https://modal.com/docs/sdk/py/latest/Environment#billingreport):
+              An analogous report API that is scoped to a specific Environment.
+        """
+
+        if cycle is None:
+            cycle = datetime.now(timezone.utc).replace(
+                day=1,
+                hour=0,
+                minute=0,
+                second=0,
+                microsecond=0,
+            )
+        elif isinstance(cycle, str):
+            cycle = parse_billing_cycle(cycle)
+
+        if cycle.tzinfo is None:
+            cycle = cycle.replace(tzinfo=timezone.utc)
+        elif cycle.tzinfo != timezone.utc:
+            raise InvalidError("Timezone-aware 'cycle' parameter must be in UTC.")
+
+        if not is_utc_month_aligned(cycle):
+            raise InvalidError("Provided 'cycle' parameter must be the first of a month.")
+
+        if cycle > datetime.now(timezone.utc):
+            raise InvalidError("Provided 'cycle' parameter cannot be in the future.")
+
+        if not self._environment.is_hydrated:
+            await self._environment.hydrate()
+
+        request = api_pb2.EnvironmentBillingSummaryRequest(environment_id=self._environment.object_id)
+        request.start_timestamp.FromDatetime(cycle)
+
+        return EnvironmentBillingSummary._from_proto(
+            await self._environment.client.stub.EnvironmentBillingSummary(request)
+        )
+
 
 ENVIRONMENT_CACHE: dict[str, _Environment] = {}
 
@@ -547,4 +621,4 @@ def ensure_env(environment_name: str | None = None) -> str:
     if environment_name is not None:
         config.override_locally("environment", environment_name)
 
-    return config.get("environment")
+    return config.get("environment") or ""

{modal-1.5.2.dev22 → modal-1.5.3}/modal/_function_variants.py

@@ -171,7 +171,7 @@ class _FunctionOptions:
             replace_secret_ids=bool(self.secrets),
             replace_volume_mounts=len(volume_mounts) > 0,
             volume_mounts=volume_mounts,
-            cloud_bucket_mounts=cloud_bucket_mounts_to_proto(self.cloud_bucket_mounts),
+            cloud_bucket_mounts=cloud_bucket_mounts_to_proto(self.cloud_bucket_mounts)[0],
             replace_cloud_bucket_mounts=bool(self.cloud_bucket_mounts),
             resources=self.resources,
             retry_policy=self.retry_policy,