modal 1.5.3.dev10__tar.gz → 1.5.3.dev12__tar.gz

{modal-1.5.3.dev10 → modal-1.5.3.dev12}/PKG-INFO

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

{modal-1.5.3.dev10 → modal-1.5.3.dev12}/modal/_environments.py

@@ -17,10 +17,11 @@ from ._load_context import LoadContext
 from ._object import _Object
 from ._resolver import Resolver
 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)
@@ -450,6 +451,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] = {}
 

{modal-1.5.3.dev10 → modal-1.5.3.dev12}/modal/_functions.py

@@ -22,6 +22,8 @@ from modal_proto.modal_api_grpc import ModalClientModal
 from ._function_variants import _FunctionOptions, _make_function_variant
 from ._image import _Image
 from ._load_context import LoadContext
+from ._logs import LogsFilters
+from ._logs_manager import _FunctionCallLogsManager, _FunctionLogsManager
 from ._object import _Object, live_method, live_method_gen
 from ._output.pty import get_pty_info
 from ._output.status import FunctionCreationStatus
@@ -32,6 +34,7 @@ from ._serialization import (
     get_callable_schema,
     serialize,
 )
+from ._supports_logs import _LogQueryData
 from ._traceback import print_server_warnings
 from ._utils.async_utils import (
     TaskContext,
@@ -629,6 +632,27 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
     _base_function: "_Function | None" = None
     _app_id: str | None = None
 
+    async def _get_log_query_data(self) -> _LogQueryData:
+        await self.hydrate()
+        if not self._app_id:
+            raise ExecutionError("app_id should have been set during function hydration")
+        return _LogQueryData(self.client, self._app_id, LogsFilters(function_id=self.object_id))
+
+    @property
+    def logs(self) -> _FunctionLogsManager:
+        """Access logs for a `Function`.
+
+        Use [`fetch()`](#logsfetch)
+        to read logs from a UTC time range, [`tail()`](#logstail)
+        to read the most recent logs, and [`stream()`](#logsstream)
+        to follow new logs as they arrive.
+
+        See also:
+            - [`modal app logs`](https://modal.com/docs/cli/latest/app#modal-app-logs):
+              CLI access to logs for an App.
+        """
+        return _FunctionLogsManager(self)
+
     @staticmethod
     def from_local(
         info: FunctionInfo,
@@ -2000,6 +2024,29 @@ class _FunctionCall(typing.Generic[ReturnType], _Object, type_prefix="fc"):
         resp = await self.client.stub.FunctionCallFromId(request)
         self._hydrate_metadata(resp)
 
+    async def _get_log_query_data(self) -> _LogQueryData:
+        await self.hydrate()
+        if not self._app_id:
+            await self._hydrate_from_id_metadata()
+        if not self._app_id:
+            raise ExecutionError("app_id should have been set during function call hydration")
+        return _LogQueryData(self.client, self._app_id, LogsFilters(function_call_id=self.object_id))
+
+    @property
+    def logs(self) -> _FunctionCallLogsManager:
+        """Access logs for a single `FunctionCall`.
+
+        Use [`fetch()`](#logsfetch)
+        to read logs from a UTC time range, [`tail()`](#logstail)
+        to read the most recent logs, and [`stream()`](#logsstream)
+        to follow new logs as they arrive.
+
+        See also:
+            - [`modal app logs`](https://modal.com/docs/cli/latest/app#modal-app-logs):
+            CLI access to logs for an App.
+        """
+        return _FunctionCallLogsManager(self)
+
     @live_method
     async def num_inputs(self) -> int:
         """Get the number of inputs in the function call.