modal 1.1.5.dev86__py3-none-any.whl → 1.1.5.dev88__py3-none-any.whl

modal/_billing.py

@@ -0,0 +1,80 @@
+# Copyright Modal Labs 2025
+from datetime import datetime, timezone
+from decimal import Decimal
+from typing import Any, Optional, TypedDict
+
+from modal_proto import api_pb2
+
+from .client import _Client
+from .exception import InvalidError
+
+
+class WorkspaceBillingReportItem(TypedDict):
+    object_id: str
+    description: str
+    environment_name: str
+    interval_start: datetime
+    cost: Decimal
+    tags: dict[str, str]
+
+
+async def _workspace_billing_report(
+    *,
+    start: datetime,  # Start of the report, inclusive
+    end: Optional[datetime] = None,  # End of the report, exclusive
+    resolution: str = "d",  # Resolution, e.g. "d" for daily or "h" for hourly
+    tag_names: Optional[list[str]] = None,  # Optional additional metadata to include
+    client: Optional[_Client] = None,
+) -> list[dict[str, Any]]:
+    """Generate a tabular report of workspace usage by object and time.
+
+    The result will be a list of dictionaries for each interval (determined by `resolution`)
+    between the `start` and `end` limits. The dictionary represents a single Modal object
+    that billing can be attributed to (e.g., an App) along with metadata (including user-defined
+    tags) for identifying that object.
+
+    The `start` and `end` parameters are required to either have a UTC timezone or to be
+    timezone-naive (which will be interpreted as UTC times). The timestamps in the result will
+    be in UTC. Cost will be reported for full intervals, even if the provided `start` or `end`
+    parameters are partial: `start` will be rounded to the beginning of its interval, while
+    partial `end` intervals will be excluded.
+
+    Additional user-provided metadata can be included in the report if the objects have tags
+    and `tag_names` (i.e., keys) are specified in the request. Note that tags will be attributed
+    to the entire interval even if they were added or removed at some point within it.
+
+    """
+    if client is None:
+        client = await _Client.from_env()
+
+    tag_names = tag_names or []
+
+    if end is None:
+        end = datetime.now(timezone.utc)
+
+    for dt in (start, end):
+        if dt.tzinfo is None:
+            dt = dt.replace(tzinfo=timezone.utc)
+        elif dt.tzinfo != timezone.utc:
+            raise InvalidError("Timezone-aware start/end limits must be in UTC.")
+
+    request = api_pb2.WorkspaceBillingReportRequest(
+        resolution=resolution,
+        tag_names=tag_names,
+    )
+    request.start_timestamp.FromDatetime(start)
+    request.end_timestamp.FromDatetime(end)
+
+    rows = []
+    async for pb_item in client.stub.WorkspaceBillingReport.unary_stream(request):
+        item = {
+            "object_id": pb_item.object_id,
+            "description": pb_item.description,
+            "environment_name": pb_item.environment_name,
+            "interval_start": pb_item.interval.ToDatetime().replace(tzinfo=timezone.utc),
+            "cost": Decimal(pb_item.cost),
+            "tags": dict(pb_item.tags),
+        }
+        rows.append(item)
+
+    return rows

modal/billing.py

@@ -0,0 +1,5 @@
+# Copyright Modal Labs 2025
+from ._billing import _workspace_billing_report
+from ._utils.async_utils import synchronize_api
+
+workspace_billing_report = synchronize_api(_workspace_billing_report)

modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.5.dev86",
+        version: str = "1.1.5.dev88",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -164,7 +164,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.5.dev86",
+        version: str = "1.1.5.dev88",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.5.dev86.dist-info → modal-1.1.5.dev88.dist-info}/METADATA

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

{modal-1.1.5.dev86.dist-info → modal-1.1.5.dev88.dist-info}/RECORD

@@ -1,5 +1,6 @@
 modal/__init__.py,sha256=WMaRW-2IJRGA9ioNAaBhJYuyLvu-GS01L8wQD90fKBs,2682
 modal/__main__.py,sha256=45H-GtwzaDfN-1nP4_HYvzN3s7AG_HXR4-ynrsjO_OI,2803
+modal/_billing.py,sha256=C1jUN9f_1WqozSZAt9EOk1nImXUdiLrgFeeAu3R23cI,3012
 modal/_clustered_functions.py,sha256=Sy4Sf_17EO8OL-FUe8LYcm4hrqLyQFCssNhr3p0SroU,3013
 modal/_clustered_functions.pyi,sha256=JmYwAGOLEnD5AF-gYF9O5tu-SgGjeoJz-X1j48b1Ijg,1157
 modal/_container_entrypoint.py,sha256=B_fIKKjWposiNsYOePifX7S6cR9hf5LRPhDfVums5O8,27867
@@ -20,9 +21,10 @@ modal/_type_manager.py,sha256=DWjgmjYJuOagw2erin506UUbG2H5UzZCFEekS-7hmfA,9087
 modal/_watcher.py,sha256=K6LYnlmSGQB4tWWI9JADv-tvSvQ1j522FwT71B51CX8,3584
 modal/app.py,sha256=W-24GIIBTKBqBWF6n4aB_heUhCb8d4KJfGF8oWteZn8,52454
 modal/app.pyi,sha256=6wlYK9nNp0GuHXyUxGmcZ6J92EjsWS-KK6KRuejqXEY,49718
+modal/billing.py,sha256=zmQ3bcCJlwa4KD1IA_QgdWpm1pn13c-7qfy79iEauYI,195
 modal/call_graph.py,sha256=1g2DGcMIJvRy-xKicuf63IVE98gJSnQsr8R_NVMptNc,2581
 modal/client.py,sha256=kyAIVB3Ay-XKJizQ_1ufUFB__EagV0MLmHJpyYyJ7J0,18636
-modal/client.pyi,sha256=eaiV3x4_xzXKVlKx1zXZ3WnYs3z7wGdEJ92xO7B6fzM,15831
+modal/client.pyi,sha256=1SD-1xFGRj7-jx0ofSh0gVb07hS9qR3xmpJb18PdTto,15831
 modal/cloud_bucket_mount.py,sha256=I2GRXYhOWLIz2kJZjXu75jAm9EJkBNcutGc6jR2ReUw,5928
 modal/cloud_bucket_mount.pyi,sha256=VuUOipMIHqFXMkD-3g2bsoqpSxV5qswlFHDOqPQzYAo,7405
 modal/cls.py,sha256=IZG9gLlssbhTgIn6iSEmBSKkbbkst3skASMae-59FII,40239
@@ -153,7 +155,7 @@ modal/experimental/__init__.py,sha256=9gkVuDmu3m4TlKoU3MzEtTOemUSs8EEOWba40s7Aa0
 modal/experimental/flash.py,sha256=C4sef08rARYFllsgtqukFmYL18SZW0_JpMS0BejDcUs,28552
 modal/experimental/flash.pyi,sha256=vV_OQhtdrPn8SW0XrBK-aLLHHIvxAzLzwFbWrke-m74,15463
 modal/experimental/ipython.py,sha256=TrCfmol9LGsRZMeDoeMPx3Hv3BFqQhYnmD_iH0pqdhk,2904
-modal-1.1.5.dev86.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-1.1.5.dev88.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
 modal_docs/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,28
 modal_docs/gen_cli_docs.py,sha256=c1yfBS_x--gL5bs0N4ihMwqwX8l3IBWSkBAKNNIi6bQ,3801
 modal_docs/gen_reference_docs.py,sha256=d_CQUGQ0rfw28u75I2mov9AlS773z9rG40-yq5o7g2U,6359
@@ -161,13 +163,13 @@ modal_docs/mdmd/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,2
 modal_docs/mdmd/mdmd.py,sha256=tUTImNd4UMFk1opkaw8J672gX8AkBO5gbY2S_NMxsxs,7140
 modal_docs/mdmd/signatures.py,sha256=XJaZrK7Mdepk5fdX51A8uENiLFNil85Ud0d4MH8H5f0,3218
 modal_proto/__init__.py,sha256=MIEP8jhXUeGq_eCjYFcqN5b1bxBM4fdk0VESpjWR0fc,28
-modal_proto/api.proto,sha256=BJvChnmHwPHqAzPctoawlFbH_UNNw8Fut88FNfbRSHk,108830
-modal_proto/api_grpc.py,sha256=plTpsjLCcRpciQdTxwh1Y6fZaAMBbSzoUYFOTF9uMIE,135333
-modal_proto/api_pb2.py,sha256=AXfiWULiO4EcttRDWnqZVImhXIvZVqv0Xbf1ojRAc_k,381192
-modal_proto/api_pb2.pyi,sha256=5qCe0VixKCd2TMSmtpgJuiF9pMbfP9ZLG76z7M5iN98,532059
-modal_proto/api_pb2_grpc.py,sha256=KGm4HHBQsge8Ww3eSVr9KWbl1IPomf-l3qqbfXWrej0,291534
-modal_proto/api_pb2_grpc.pyi,sha256=FVAP6dDZgGHVR3xP7ZxrUVQZLXY0PgT9EG3l2UXh10w,68311
-modal_proto/modal_api_grpc.py,sha256=WDbmh9XNSXIsnQ3KePkDlclEHRQpeDtRBuBIdGsvvHU,20394
+modal_proto/api.proto,sha256=V3XYevM1T8Btc8GJmV5i4I3faI6c62xE0sfwvjx3QKY,109406
+modal_proto/api_grpc.py,sha256=Kgv6E88imUNNWyOA0foC1NEzgPWTXW4mJ3IKg_f0Dek,136233
+modal_proto/api_pb2.py,sha256=QGUGKLLqnAQPrdpXtWUDmKuNyEdeMyBAYKvOrOBcLG8,382752
+modal_proto/api_pb2.pyi,sha256=5P6K_B-zCILsKFk9XgtvvPu5gqUrVxVkVzzdV9CBWrU,533421
+modal_proto/api_pb2_grpc.py,sha256=_M7mQCqZ3BhuCgL4vRrinA2oOjWeJSMXeb5iOFKHi2g,293349
+modal_proto/api_pb2_grpc.pyi,sha256=4Jub1tY9CWdUXRvC7LxAiTCWuu-tuLTLBAEcpoDQMDw,68760
+modal_proto/modal_api_grpc.py,sha256=6w-9wV6QLE3KFSzPerMtSjzbsunVEfCjOOmplKudjuw,20528
 modal_proto/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 modal_proto/sandbox_router.proto,sha256=NWmNYbxgcGoV3XlR-pp8cQEgyVNn43U83e4gyWjKtmQ,5296
 modal_proto/sandbox_router_grpc.py,sha256=27daOTX2N5hADDG-5Qnn4Yj3VfekyJwrDUkrQ12mPuU,5004
@@ -175,10 +177,16 @@ modal_proto/sandbox_router_pb2.py,sha256=QTT32WuusbyZwciNo-UUa6wl9-juOE2xRlv0JrB
 modal_proto/sandbox_router_pb2.pyi,sha256=Ihf7LHmh0V5XfMHwYQobZiQ1_3xPoDJgIueyUxC4fMQ,15088
 modal_proto/sandbox_router_pb2_grpc.py,sha256=8kPFo84rpRHfeRdZuHyoWuuIAphGmjM0s3ygGJSBVck,10006
 modal_proto/sandbox_router_pb2_grpc.pyi,sha256=iAr1ornlIEYP7pfrFMrw91-F3PNs7amH6z6J2oCwYxk,3276
-modal_version/__init__.py,sha256=PYnkwPhjnrPa0phIwaK7GG2qfKb9Hk16t28x3rRfiDE,121
+modal_proto/task_command_router.proto,sha256=AzgrpOQo0ux4axnxG_akIvUPsi2zjZwrv6qpw-mseXk,5013
+modal_proto/task_command_router_grpc.py,sha256=K4jx9zr97twm3wrJa00ENoEntGcGz67ColcAeTZPrNc,5013
+modal_proto/task_command_router_pb2.py,sha256=sHuO2zhdF1IcjoYOFdZQR2SRxG4pKqFZv1D-AsqpOsw,10619
+modal_proto/task_command_router_pb2.pyi,sha256=EyDgXPLr7alqjXYERV8w_MPuO404x0uCppmSkrfE9IE,14589
+modal_proto/task_command_router_pb2_grpc.py,sha256=-IgssABfiboRRsW08JwWWSeJxHvDdOUxZd0fiN9xq4Q,10009
+modal_proto/task_command_router_pb2_grpc.pyi,sha256=V_uvtFjVDfqien0x820hQ0W5ZbNAqm_uSn0F3RSqz58,3273
+modal_version/__init__.py,sha256=kpk1mIJ0ez-b0kJrSKuArOR_g3mP5vWqiKryck72F6Q,121
 modal_version/__main__.py,sha256=2FO0yYQQwDTh6udt1h-cBnGd1c4ZyHnHSI4BksxzVac,105
-modal-1.1.5.dev86.dist-info/METADATA,sha256=X0DsidEkq4lS8zvPWMxd0dai3ClesoWgLfcW4FzV5Sg,2481
-modal-1.1.5.dev86.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-modal-1.1.5.dev86.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-1.1.5.dev86.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
-modal-1.1.5.dev86.dist-info/RECORD,,
+modal-1.1.5.dev88.dist-info/METADATA,sha256=XO_0TSuepAYSgvazA8eyGnixnVCALwIzcBQNx7Oc204,2481
+modal-1.1.5.dev88.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+modal-1.1.5.dev88.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-1.1.5.dev88.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
+modal-1.1.5.dev88.dist-info/RECORD,,

modal_proto/api.proto

@@ -2760,6 +2760,8 @@ message SandboxCreateResponse {
 // Used to get a JWT and URL for direct access to a sandbox router server
 // running on the modal-worker, so the client can issue exec commands (and other
 // operations as they become available) directly to the worker.
+// DEPRECATED: Use TaskGetCommandRouterAccessRequest instead.
+// TODO(saltzm): Remove this.
 message SandboxGetCommandRouterAccessRequest {
   string sandbox_id = 1;
 }
@@ -3163,6 +3165,18 @@ message TaskGetAutoscalingMetricsResponse {
   AutoscalingMetrics metrics = 1;
 }
 
+// Used to get a JWT and URL for direct access to a task command router
+// running on the modal-worker, so the client can issue exec commands (and other
+// operations as they become available) directly to the worker.
+message TaskGetCommandRouterAccessRequest {
+  string task_id = 1;
+}
+
+message TaskGetCommandRouterAccessResponse {
+  string jwt = 1;
+  string url = 2;
+}
+
 message TaskInfo {
   string id = 1;
   double started_at = 2;
@@ -3780,6 +3794,7 @@ service ModalClient {
   rpc TaskClusterHello(TaskClusterHelloRequest) returns (TaskClusterHelloResponse);
   rpc TaskCurrentInputs(google.protobuf.Empty) returns (TaskCurrentInputsResponse);
   rpc TaskGetAutoscalingMetrics(TaskGetAutoscalingMetricsRequest) returns (TaskGetAutoscalingMetricsResponse); // Used for flash autoscaling
+  rpc TaskGetCommandRouterAccess(TaskGetCommandRouterAccessRequest) returns (TaskGetCommandRouterAccessResponse);
   rpc TaskList(TaskListRequest) returns (TaskListResponse);
   rpc TaskResult(TaskResultRequest) returns (google.protobuf.Empty);
 

modal_proto/api_grpc.py

@@ -618,6 +618,10 @@ class ModalClientBase(abc.ABC):
     async def TaskGetAutoscalingMetrics(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.TaskGetAutoscalingMetricsRequest, modal_proto.api_pb2.TaskGetAutoscalingMetricsResponse]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def TaskGetCommandRouterAccess(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.TaskGetCommandRouterAccessRequest, modal_proto.api_pb2.TaskGetCommandRouterAccessResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def TaskList(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.TaskListRequest, modal_proto.api_pb2.TaskListResponse]') -> None:
         pass
@@ -1620,6 +1624,12 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.TaskGetAutoscalingMetricsRequest,
                 modal_proto.api_pb2.TaskGetAutoscalingMetricsResponse,
             ),
+            '/modal.client.ModalClient/TaskGetCommandRouterAccess': grpclib.const.Handler(
+                self.TaskGetCommandRouterAccess,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.TaskGetCommandRouterAccessRequest,
+                modal_proto.api_pb2.TaskGetCommandRouterAccessResponse,
+            ),
             '/modal.client.ModalClient/TaskList': grpclib.const.Handler(
                 self.TaskList,
                 grpclib.const.Cardinality.UNARY_UNARY,
@@ -2676,6 +2686,12 @@ class ModalClientStub:
             modal_proto.api_pb2.TaskGetAutoscalingMetricsRequest,
             modal_proto.api_pb2.TaskGetAutoscalingMetricsResponse,
         )
+        self.TaskGetCommandRouterAccess = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/TaskGetCommandRouterAccess',
+            modal_proto.api_pb2.TaskGetCommandRouterAccessRequest,
+            modal_proto.api_pb2.TaskGetCommandRouterAccessResponse,
+        )
         self.TaskList = grpclib.client.UnaryUnaryMethod(
             channel,
             '/modal.client.ModalClient/TaskList',