modal 0.73.34__tar.gz

modal-0.73.34/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

modal-0.73.34/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: modal
+Version: 0.73.34
+Summary: Python client library for Modal
+Author: Modal Labs
+Author-email: support@modal.com
+Project-URL: Homepage, https://modal.com
+Project-URL: Source, https://github.com/modal-labs/modal-client
+Keywords: modal,client,cloud,serverless,infrastructure
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Modal Python Library
+
+[![PyPI Version](https://img.shields.io/pypi/v/modal.svg)](https://pypi.org/project/modal/)
+[![License](https://img.shields.io/badge/license-apache_2.0-darkviolet.svg)](https://github.com/modal-labs/modal-client/blob/master/LICENSE)
+[![Tests](https://github.com/modal-labs/modal-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/modal-labs/modal-client/actions/workflows/ci-cd.yml)
+[![Slack](https://img.shields.io/badge/slack-join-blue.svg?logo=slack)](https://modal.com/slack)
+
+The [Modal](https://modal.com/) Python library provides convenient, on-demand
+access to serverless cloud compute from Python scripts on your local computer.
+
+## Documentation
+
+See the [online documentation](https://modal.com/docs/guide) for many
+[example applications](https://modal.com/docs/examples),
+a [user guide](https://modal.com/docs/guide), and the detailed
+[API reference](https://modal.com/docs/reference).
+
+## Installation
+
+**This library requires Python 3.9 – 3.13.**
+
+Install the package with `pip`:
+
+```bash
+pip install modal
+```
+
+You can create a Modal account (or link your existing one) directly on the
+command line:
+
+```bash
+python3 -m modal setup
+```
+
+## Support
+
+For usage questions and other support, please reach out on the
+[Modal Slack](https://modal.com/slack).

modal-0.73.34/README.md

@@ -0,0 +1,38 @@
+# Modal Python Library
+
+[![PyPI Version](https://img.shields.io/pypi/v/modal.svg)](https://pypi.org/project/modal/)
+[![License](https://img.shields.io/badge/license-apache_2.0-darkviolet.svg)](https://github.com/modal-labs/modal-client/blob/master/LICENSE)
+[![Tests](https://github.com/modal-labs/modal-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/modal-labs/modal-client/actions/workflows/ci-cd.yml)
+[![Slack](https://img.shields.io/badge/slack-join-blue.svg?logo=slack)](https://modal.com/slack)
+
+The [Modal](https://modal.com/) Python library provides convenient, on-demand
+access to serverless cloud compute from Python scripts on your local computer.
+
+## Documentation
+
+See the [online documentation](https://modal.com/docs/guide) for many
+[example applications](https://modal.com/docs/examples),
+a [user guide](https://modal.com/docs/guide), and the detailed
+[API reference](https://modal.com/docs/reference).
+
+## Installation
+
+**This library requires Python 3.9 – 3.13.**
+
+Install the package with `pip`:
+
+```bash
+pip install modal
+```
+
+You can create a Modal account (or link your existing one) directly on the
+command line:
+
+```bash
+python3 -m modal setup
+```
+
+## Support
+
+For usage questions and other support, please reach out on the
+[Modal Slack](https://modal.com/slack).

modal-0.73.34/modal/__init__.py

@@ -0,0 +1,86 @@
+# Copyright Modal Labs 2022
+import sys
+
+if sys.version_info[:2] < (3, 9):
+    raise RuntimeError("This version of Modal requires at least Python 3.9")
+if sys.version_info[:2] >= (3, 14):
+    raise RuntimeError("This version of Modal does not support Python 3.14+")
+
+from modal_version import __version__
+
+try:
+    from ._runtime.execution_context import current_function_call_id, current_input_id, interact, is_local
+    from ._tunnel import Tunnel, forward
+    from .app import App, Stub
+    from .client import Client
+    from .cloud_bucket_mount import CloudBucketMount
+    from .cls import Cls, parameter
+    from .dict import Dict
+    from .exception import Error
+    from .file_pattern_matcher import FilePatternMatcher
+    from .functions import Function
+    from .image import Image
+    from .mount import Mount
+    from .network_file_system import NetworkFileSystem
+    from .output import enable_output
+    from .partial_function import asgi_app, batched, build, enter, exit, method, web_endpoint, web_server, wsgi_app
+    from .proxy import Proxy
+    from .queue import Queue
+    from .retries import Retries
+    from .sandbox import Sandbox
+    from .schedule import Cron, Period
+    from .scheduler_placement import SchedulerPlacement
+    from .secret import Secret
+    from .snapshot import SandboxSnapshot
+    from .volume import Volume
+except Exception:
+    print()
+    print("#" * 80)
+    print("#" + "Something with the Modal installation seems broken.".center(78) + "#")
+    print("#" + "Please email support@modal.com and we will try to help!".center(78) + "#")
+    print("#" * 80)
+    print()
+    raise
+
+__all__ = [
+    "__version__",
+    "App",
+    "Client",
+    "Cls",
+    "Cron",
+    "Dict",
+    "Error",
+    "FilePatternMatcher",
+    "Function",
+    "Image",
+    "Mount",
+    "NetworkFileSystem",
+    "Period",
+    "Proxy",
+    "Queue",
+    "Retries",
+    "CloudBucketMount",
+    "Sandbox",
+    "SandboxSnapshot",
+    "SchedulerPlacement",
+    "Secret",
+    "Stub",
+    "Tunnel",
+    "Volume",
+    "asgi_app",
+    "batched",
+    "build",
+    "current_function_call_id",
+    "current_input_id",
+    "enable_output",
+    "enter",
+    "exit",
+    "forward",
+    "is_local",
+    "interact",
+    "method",
+    "parameter",
+    "web_endpoint",
+    "web_server",
+    "wsgi_app",
+]

modal-0.73.34/modal/__main__.py

@@ -0,0 +1,78 @@
+# Copyright Modal Labs 2022
+import sys
+
+from ._traceback import reduce_traceback_to_user_code
+from .cli._traceback import highlight_modal_deprecation_warnings, setup_rich_traceback
+from .cli.entry_point import entrypoint_cli
+from .cli.import_refs import _CliUserExecutionError
+from .config import config
+
+
+def main():
+    # Setup rich tracebacks, but only on user's end, when using the Modal CLI.
+    setup_rich_traceback()
+    highlight_modal_deprecation_warnings()
+
+    try:
+        entrypoint_cli()
+
+    except _CliUserExecutionError as exc:
+        if config.get("traceback"):
+            raise
+
+        assert exc.__cause__  # We should always raise this class from another error
+        tb = reduce_traceback_to_user_code(exc.__cause__.__traceback__, exc.user_source)
+        sys.excepthook(type(exc.__cause__), exc.__cause__, tb)
+        sys.exit(1)
+
+    except Exception as exc:
+        if (
+            # User has asked to alway see full tracebacks
+            config.get("traceback")
+            # The exception message is empty, so we need to provide _some_ actionable information
+            or not str(exc)
+        ):
+            raise
+
+        from grpclib import GRPCError, Status
+        from rich.console import Console
+        from rich.panel import Panel
+        from rich.text import Text
+
+        if isinstance(exc, GRPCError):
+            status_map = {
+                Status.ABORTED: "Aborted",
+                Status.ALREADY_EXISTS: "Already exists",
+                Status.CANCELLED: "Cancelled",
+                Status.DATA_LOSS: "Data loss",
+                Status.DEADLINE_EXCEEDED: "Deadline exceeded",
+                Status.FAILED_PRECONDITION: "Failed precondition",
+                Status.INTERNAL: "Internal",
+                Status.INVALID_ARGUMENT: "Invalid",
+                Status.NOT_FOUND: "Not found",
+                Status.OUT_OF_RANGE: "Out of range",
+                Status.PERMISSION_DENIED: "Permission denied",
+                Status.RESOURCE_EXHAUSTED: "Resource exhausted",
+                Status.UNAUTHENTICATED: "Unauthenticaed",
+                Status.UNAVAILABLE: "Unavailable",
+                Status.UNIMPLEMENTED: "Unimplemented",
+                Status.UNKNOWN: "Unknown",
+            }
+            title = f"Error: {status_map.get(exc.status, 'Unknown')}"
+            content = str(exc.message)
+            if exc.details:
+                content += f"\n\nDetails: {exc.details}"
+        else:
+            title = "Error"
+            content = str(exc)
+            if notes := getattr(exc, "__notes__", []):
+                content = f"{content}\n\nNote: {' '.join(notes)}"
+
+        console = Console(stderr=True)
+        panel = Panel(Text(content), title=title, title_align="left", border_style="red")
+        console.print(panel, highlight=False)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

modal-0.73.34/modal/_clustered_functions.py

@@ -0,0 +1,80 @@
+# Copyright Modal Labs 2024
+import os
+import socket
+from dataclasses import dataclass
+from typing import Optional
+
+from modal._utils.async_utils import synchronize_api
+from modal._utils.grpc_utils import retry_transient_errors
+from modal.client import _Client
+from modal.exception import InvalidError
+from modal_proto import api_pb2
+
+
+@dataclass
+class ClusterInfo:
+    rank: int
+    container_ips: list[str]
+
+
+cluster_info: Optional[ClusterInfo] = None
+
+
+def get_cluster_info() -> ClusterInfo:
+    if cluster_info is None:
+        raise InvalidError(
+            "Cluster info not initialized. Please ensure that you are "
+            "calling get_cluster_info() from a clustered function."
+        )
+    return cluster_info
+
+
+async def _initialize_clustered_function(client: _Client, task_id: str, world_size: int):
+    global cluster_info
+
+    def get_i6pn():
+        """Returns the ipv6 address assigned to this container."""
+        return socket.getaddrinfo("i6pn.modal.local", None, socket.AF_INET6)[0][4][0]
+
+    hostname = socket.gethostname()
+    container_ip = get_i6pn()
+
+    # nccl's default host ID is $(hostname)$(cat /proc/sys/kernel/random/boot_id).
+    # on runc, if two i6pn-linked containers get scheduled on the same worker,
+    # their boot ID and hostname will both be identical, causing nccl to break.
+    # As a workaround, we can explicitly specify a unique host ID here.
+    # See MOD-4067.
+    os.environ["NCCL_HOSTID"] = f"{hostname}{container_ip}"
+
+    # We found these settings to work well in most cases. You may be able to achieve
+    # better performance by tuning these settings.
+    if os.environ["MODAL_CLOUD_PROVIDER"] in ("CLOUD_PROVIDER_GCP", "CLOUD_PROVIDER_OCI"):
+        os.environ["NCCL_SOCKET_NTHREADS"] = "4"
+        os.environ["NCCL_NSOCKS_PERTHREAD"] = "1"
+    elif os.environ["MODAL_CLOUD_PROVIDER"] == "CLOUD_PROVIDER_AWS":
+        os.environ["NCCL_SOCKET_NTHREADS"] = "2"
+        os.environ["NCCL_NSOCKS_PERTHREAD"] = "8"
+    else:
+        os.environ["NCCL_SOCKET_NTHREADS"] = "1"
+        os.environ["NCCL_NSOCKS_PERTHREAD"] = "1"
+
+    if world_size > 1:
+        resp: api_pb2.TaskClusterHelloResponse = await retry_transient_errors(
+            client.stub.TaskClusterHello,
+            api_pb2.TaskClusterHelloRequest(
+                task_id=task_id,
+                container_ip=container_ip,
+            ),
+        )
+        cluster_info = ClusterInfo(
+            rank=resp.cluster_rank,
+            container_ips=resp.container_ips,
+        )
+    else:
+        cluster_info = ClusterInfo(
+            rank=0,
+            container_ips=[container_ip],
+        )
+
+
+initialize_clustered_function = synchronize_api(_initialize_clustered_function)

modal-0.73.34/modal/_clustered_functions.pyi

@@ -0,0 +1,22 @@
+import modal.client
+import typing
+import typing_extensions
+
+class ClusterInfo:
+    rank: int
+    container_ips: list[str]
+
+    def __init__(self, rank: int, container_ips: list[str]) -> None: ...
+    def __repr__(self): ...
+    def __eq__(self, other): ...
+
+def get_cluster_info() -> ClusterInfo: ...
+async def _initialize_clustered_function(client: modal.client._Client, task_id: str, world_size: int): ...
+
+class __initialize_clustered_function_spec(typing_extensions.Protocol):
+    def __call__(self, client: modal.client.Client, task_id: str, world_size: int): ...
+    async def aio(self, client: modal.client.Client, task_id: str, world_size: int): ...
+
+initialize_clustered_function: __initialize_clustered_function_spec
+
+cluster_info: typing.Optional[ClusterInfo]