modal 1.0.6.dev11__tar.gz → 1.0.6.dev13__tar.gz

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/PKG-INFO

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

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal/client.pyi

@@ -31,7 +31,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.6.dev11",
+        version: str = "1.0.6.dev13",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -160,7 +160,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.6.dev11",
+        version: str = "1.0.6.dev13",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal/functions.pyi

@@ -428,7 +428,7 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
@@ -437,7 +437,7 @@ class Function(
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
 
-    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -464,7 +464,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """[Experimental] Calls the function with the given arguments, without waiting for the results.
 
@@ -488,7 +488,7 @@ class Function(
             ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
+        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -497,7 +497,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """Calls the function with the given arguments, without waiting for the results.
 
@@ -518,7 +518,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal/image.py

@@ -1222,6 +1222,114 @@ class _Image(_Object, type_prefix="im"):
             gpu_config=parse_gpu_config(gpu),
         )
 
+    def uv_pip_install(
+        self,
+        *packages: Union[str, list[str]],  # A list of Python packages, eg. ["numpy", "matplotlib>=3.5.0"]
+        requirements: Optional[list[str]] = None,  # Passes -r (--requirements) to uv pip install
+        find_links: Optional[str] = None,  # Passes -f (--find-links) to uv pip install
+        index_url: Optional[str] = None,  # Passes -i (--index-url) to uv pip install
+        extra_index_url: Optional[str] = None,  # Passes --extra-index-url to uv pip install
+        pre: bool = False,  # Allow pre-releases using uv pip install --prerelease allow
+        extra_options: str = "",  # Additional options to pass to pip install, e.g. "--no-build-isolation"
+        force_build: bool = False,  # Ignore cached builds, similar to 'docker build --no-cache'
+        uv_version: Optional[str] = None,  # uv version to use
+        secrets: Sequence[_Secret] = [],
+        gpu: GPU_T = None,
+    ) -> "_Image":
+        """Install a list of Python packages using uv pip install.
+
+        **Examples**
+
+        Simple installation:
+        ```python
+        image = modal.Image.debian_slim().uv_pip_install("torch==2.7.1", "numpy")
+        ```
+
+        This method assumes that:
+        - Python is on the `$PATH` and dependencies are installed with the first Python on the `$PATH`.
+        - Shell supports backticks for substitution
+        - `which` command is on the `$PATH`
+        """
+        pkgs = _flatten_str_args("uv_pip_install", "packages", packages)
+
+        if requirements is None or isinstance(requirements, list):
+            requirements = requirements or []
+        else:
+            raise InvalidError("requirements must be None or a list of strings")
+
+        if not pkgs and not requirements:
+            return self
+        elif not _validate_packages(pkgs):
+            raise InvalidError(
+                "Package list for `Image.uv_pip_install` cannot contain other arguments;"
+                " try the `extra_options` parameter instead."
+            )
+
+        def build_dockerfile(version: ImageBuilderVersion) -> DockerfileSpec:
+            commands = ["FROM base"]
+            UV_ROOT = "/.uv"
+            if uv_version is None:
+                commands.append(f"COPY --from=ghcr.io/astral-sh/uv:latest /uv {UV_ROOT}/uv")
+            else:
+                commands.append(f"COPY --from=ghcr.io/astral-sh/uv:{uv_version} /uv {UV_ROOT}/uv")
+
+            # NOTE: Using `which python` assumes:
+            # - python is on the PATH and uv is installing into the first python in the PATH
+            # - the shell supports backticks for substitution
+            # - `which` command is on the PATH
+            uv_pip_args = ["--python `which python`", "--compile-bytecode"]
+            context_files = {}
+
+            if find_links:
+                uv_pip_args.append(f"--find-links {shlex.quote(find_links)}")
+            if index_url:
+                uv_pip_args.append(f"--index-url {shlex.quote(index_url)}")
+            if extra_index_url:
+                uv_pip_args.append(f"--extra-index-url {shlex.quote(extra_index_url)}")
+            if pre:
+                uv_pip_args.append("--prerelease allow")
+            if extra_options:
+                uv_pip_args.append(extra_options)
+
+            if requirements:
+
+                def _generate_paths(idx: int, req: str) -> dict:
+                    local_path = os.path.expanduser(req)
+                    basename = os.path.basename(req)
+
+                    # The requirement files can have the same name but in different directories:
+                    # requirements=["test/requirements.txt", "a/b/c/requirements.txt"]
+                    # To uniquely identify these files, we add a `idx` prefix to every file's basename
+                    # - `test/requirements.txt` -> `/.0_requirements.txt` in context -> `/.uv/0/requirements.txt` to uv
+                    # - `a/b/c/requirements.txt` -> `/.1_requirements.txt` in context -> `/.uv/1/requirements.txt` to uv
+                    return {
+                        "local_path": local_path,
+                        "context_path": f"/.{idx}_{basename}",
+                        "dest_path": f"{UV_ROOT}/{idx}/{basename}",
+                    }
+
+                requirement_paths = [_generate_paths(idx, req) for idx, req in enumerate(requirements)]
+                requirements_cli = " ".join(f"--requirements {req['dest_path']}" for req in requirement_paths)
+                uv_pip_args.append(requirements_cli)
+
+                commands.extend([f"COPY {req['context_path']} {req['dest_path']}" for req in requirement_paths])
+                context_files.update({req["context_path"]: req["local_path"] for req in requirement_paths})
+
+            uv_pip_args.extend(shlex.quote(p) for p in sorted(pkgs))
+            uv_pip_args_joined = " ".join(uv_pip_args)
+
+            commands.append(f"RUN {UV_ROOT}/uv pip install {uv_pip_args_joined}")
+
+            return DockerfileSpec(commands=commands, context_files=context_files)
+
+        return _Image._from_args(
+            base_images={"base": self},
+            dockerfile_function=build_dockerfile,
+            force_build=self.force_build or force_build,
+            gpu_config=parse_gpu_config(gpu),
+            secrets=secrets,
+        )
+
     def poetry_install_from_file(
         self,
         poetry_pyproject_toml: str,
@@ -1312,6 +1420,149 @@ class _Image(_Object, type_prefix="im"):
             gpu_config=parse_gpu_config(gpu),
         )
 
+    def uv_sync(
+        self,
+        uv_project_dir: str = "./",  # Path to local uv managed project
+        *,
+        force_build: bool = False,  # Ignore cached builds, similar to 'docker build --no-cache'
+        groups: Optional[list[str]] = None,  # Dependency group to install using `uv sync --group`
+        extras: Optional[list[str]] = None,  # Optional dependencies to install using `uv sync --extra`
+        frozen: bool = True,  # If True, then we run `uv sync --frozen` when a uv.lock file is present
+        extra_options: str = "",  # Extra options to pass to `uv sync`
+        uv_version: Optional[str] = None,  # uv version to use
+        secrets: Sequence[_Secret] = [],
+        gpu: GPU_T = None,
+    ) -> "_Image":
+        """Creates a virtual environment with the dependencies in a uv managed project with `uv sync`.
+
+        **Examples**
+        ```python
+        image = modal.Image.debian_slim().uv_sync()
+        ```
+        """
+
+        def _normalize_items(items, name) -> list[str]:
+            if items is None:
+                return []
+            elif isinstance(items, list):
+                return items
+            else:
+                raise InvalidError(f"{name} must be None or a list of strings")
+
+        groups = _normalize_items(groups, "groups")
+        extras = _normalize_items(extras, "extras")
+
+        def _check_pyproject_toml(pyproject_toml: str, version: ImageBuilderVersion):
+            if not os.path.exists(pyproject_toml):
+                raise InvalidError(f"Expected {pyproject_toml} to exist")
+
+            import toml
+
+            with open(pyproject_toml) as f:
+                pyproject_toml_content = toml.load(f)
+
+            if (
+                "tool" in pyproject_toml_content
+                and "uv" in pyproject_toml_content["tool"]
+                and "workspace" in pyproject_toml_content["tool"]["uv"]
+            ):
+                raise InvalidError("uv workspaces are not supported")
+
+            if version > "2024.10":
+                # For builder version > 2024.10, modal is mounted at runtime and is not
+                # a requirement in `uv.lock`
+                return
+
+            dependencies = pyproject_toml_content["project"]["dependencies"]
+
+            for group in groups:
+                if (
+                    "dependency-groups" in pyproject_toml_content
+                    and group in pyproject_toml_content["dependency-groups"]
+                ):
+                    dependencies += pyproject_toml_content["dependency-groups"][group]
+
+            for extra in extras:
+                if (
+                    "project" in pyproject_toml_content
+                    and "optional-dependencies" in pyproject_toml_content["project"]
+                    and extra in pyproject_toml_content["project"]["optional-dependencies"]
+                ):
+                    dependencies += pyproject_toml_content["project"]["optional-dependencies"][extra]
+
+            PACKAGE_REGEX = re.compile(r"^[\w-]+")
+
+            def _extract_package(package) -> str:
+                m = PACKAGE_REGEX.match(package)
+                return m.group(0) if m else ""
+
+            if not any(_extract_package(dependency) == "modal" for dependency in dependencies):
+                raise InvalidError(
+                    "Image builder version <= 2024.10 requires modal to be specified in your pyproject.toml file"
+                )
+
+        def build_dockerfile(version: ImageBuilderVersion) -> DockerfileSpec:
+            uv_project_dir_ = os.path.expanduser(uv_project_dir)
+            pyproject_toml = os.path.join(uv_project_dir_, "pyproject.toml")
+
+            UV_ROOT = "/.uv"
+            uv_sync_args = [
+                f"--project={UV_ROOT}",
+                "--no-install-workspace",  # Do not install the root project or any "uv workspace"
+                "--compile-bytecode",
+            ]
+
+            for group in groups:
+                uv_sync_args.append(f"--group={group}")
+            for extra in extras:
+                uv_sync_args.append(f"--extra={extra}")
+            if extra_options:
+                uv_sync_args.append(extra_options)
+
+            commands = ["FROM base"]
+
+            if uv_version is None:
+                commands.append(f"COPY --from=ghcr.io/astral-sh/uv:latest /uv {UV_ROOT}/uv")
+            else:
+                commands.append(f"COPY --from=ghcr.io/astral-sh/uv:{uv_version} /uv {UV_ROOT}/uv")
+
+            context_files = {}
+
+            _check_pyproject_toml(pyproject_toml, version)
+
+            context_files["/.pyproject.toml"] = pyproject_toml
+            commands.append(f"COPY /.pyproject.toml {UV_ROOT}/pyproject.toml")
+
+            uv_lock = os.path.join(uv_project_dir_, "uv.lock")
+            if os.path.exists(uv_lock):
+                context_files["/.uv.lock"] = uv_lock
+                commands.append(f"COPY /.uv.lock {UV_ROOT}/uv.lock")
+
+                if frozen:
+                    # Do not update `uv.lock` when we have one when `frozen=True`. This it ehd efault because this
+                    # ensures that the runtime environment matches the local `uv.lock`.
+                    #
+                    # If `frozen=False`, then `uv sync` will update the the dependencies in the `uv.lock` file
+                    # during build time.
+                    uv_sync_args.append("--frozen")
+
+            uv_sync_args_joined = " ".join(uv_sync_args).strip()
+
+            commands += [
+                f"RUN {UV_ROOT}/uv sync {uv_sync_args_joined}",
+                f"ENV PATH={UV_ROOT}/.venv/bin:$PATH",
+            ]
+
+            return DockerfileSpec(commands=commands, context_files=context_files)
+
+        return _Image._from_args(
+            base_images={"base": self},
+            dockerfile_function=build_dockerfile,
+            force_build=self.force_build or force_build,
+            secrets=secrets,
+            gpu_config=parse_gpu_config(gpu),
+        )
+
     def dockerfile_commands(
         self,
         *dockerfile_commands: Union[str, list[str]],

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal/image.pyi

@@ -505,6 +505,36 @@ class _Image(modal._object._Object):
         """
         ...
 
+    def uv_pip_install(
+        self,
+        *packages: typing.Union[str, list[str]],
+        requirements: typing.Optional[list[str]] = None,
+        find_links: typing.Optional[str] = None,
+        index_url: typing.Optional[str] = None,
+        extra_index_url: typing.Optional[str] = None,
+        pre: bool = False,
+        extra_options: str = "",
+        force_build: bool = False,
+        uv_version: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret._Secret] = [],
+        gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
+    ) -> _Image:
+        """Install a list of Python packages using uv pip install.
+
+        **Examples**
+
+        Simple installation:
+        ```python
+        image = modal.Image.debian_slim().uv_pip_install("torch==2.7.1", "numpy")
+        ```
+
+        This method assumes that:
+        - Python is on the `$PATH` and dependencies are installed with the first Python on the `$PATH`.
+        - Shell supports backticks for substitution
+        - `which` command is on the `$PATH`
+        """
+        ...
+
     def poetry_install_from_file(
         self,
         poetry_pyproject_toml: str,
@@ -534,6 +564,28 @@ class _Image(modal._object._Object):
         """
         ...
 
+    def uv_sync(
+        self,
+        uv_project_dir: str = "./",
+        *,
+        force_build: bool = False,
+        groups: typing.Optional[list[str]] = None,
+        extras: typing.Optional[list[str]] = None,
+        frozen: bool = True,
+        extra_options: str = "",
+        uv_version: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret._Secret] = [],
+        gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
+    ) -> _Image:
+        """Creates a virtual environment with the dependencies in a uv managed project with `uv sync`.
+
+        **Examples**
+        ```python
+        image = modal.Image.debian_slim().uv_sync()
+        ```
+        """
+        ...
+
     def dockerfile_commands(
         self,
         *dockerfile_commands: typing.Union[str, list[str]],
@@ -1348,6 +1400,36 @@ class Image(modal.object.Object):
         """
         ...
 
+    def uv_pip_install(
+        self,
+        *packages: typing.Union[str, list[str]],
+        requirements: typing.Optional[list[str]] = None,
+        find_links: typing.Optional[str] = None,
+        index_url: typing.Optional[str] = None,
+        extra_index_url: typing.Optional[str] = None,
+        pre: bool = False,
+        extra_options: str = "",
+        force_build: bool = False,
+        uv_version: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret.Secret] = [],
+        gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
+    ) -> Image:
+        """Install a list of Python packages using uv pip install.
+
+        **Examples**
+
+        Simple installation:
+        ```python
+        image = modal.Image.debian_slim().uv_pip_install("torch==2.7.1", "numpy")
+        ```
+
+        This method assumes that:
+        - Python is on the `$PATH` and dependencies are installed with the first Python on the `$PATH`.
+        - Shell supports backticks for substitution
+        - `which` command is on the `$PATH`
+        """
+        ...
+
     def poetry_install_from_file(
         self,
         poetry_pyproject_toml: str,
@@ -1377,6 +1459,28 @@ class Image(modal.object.Object):
         """
         ...
 
+    def uv_sync(
+        self,
+        uv_project_dir: str = "./",
+        *,
+        force_build: bool = False,
+        groups: typing.Optional[list[str]] = None,
+        extras: typing.Optional[list[str]] = None,
+        frozen: bool = True,
+        extra_options: str = "",
+        uv_version: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret.Secret] = [],
+        gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
+    ) -> Image:
+        """Creates a virtual environment with the dependencies in a uv managed project with `uv sync`.
+
+        **Examples**
+        ```python
+        image = modal.Image.debian_slim().uv_sync()
+        ```
+        """
+        ...
+
     def dockerfile_commands(
         self,
         *dockerfile_commands: typing.Union[str, list[str]],

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal.egg-info/PKG-INFO

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

{modal-1.0.6.dev11 → modal-1.0.6.dev13}/modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.0.6.dev11"
+__version__ = "1.0.6.dev13"