Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels #11783

dcarrier · 2025-02-25T22:57:31Z

Summary

Addresses: #10699

Adds a hint that the user may utilize MACOSX_DEPLOYMENT_TARGET to change the deployment target for macos platform wheels.

Test Plan

uv git:(issue-10699) echo "mlx" | cargo run -- pip compile - -p 3.12 --python-platform=macos
  × No solution found when resolving dependencies:
  ╰─▶ Because only the following versions of mlx are available:
          mlx==0.0.2
          mlx==0.0.3
          mlx==0.0.4
          mlx==0.0.5
          mlx==0.0.6
          mlx==0.0.7
          mlx==0.0.9
          mlx==0.0.10
          mlx==0.0.11
          mlx==0.1.0
          mlx==0.2.0
          mlx==0.3.0
          mlx==0.4.0
          mlx==0.5.1
          mlx==0.6.0
          mlx==0.7.0
          mlx==0.8.1
          mlx==0.9.1
          mlx==0.10.0
          mlx==0.11.1
          mlx==0.12.2
          mlx==0.13.0
          mlx==0.13.1
          mlx==0.14.0
          mlx==0.14.1
          mlx==0.15.0
          mlx==0.15.1
          mlx==0.15.2
          mlx==0.16.0
          mlx==0.16.1
          mlx==0.16.2
          mlx==0.16.3
          mlx==0.17.1
          mlx==0.17.2
          mlx==0.17.3
          mlx==0.18.0
          mlx==0.18.1
          mlx==0.19.0
          mlx==0.19.3
          mlx==0.20.0
          mlx==0.21.0
          mlx==0.21.1
          mlx==0.22.0
          mlx==0.22.1
          mlx==0.23.1
      and mlx<=0.0.3 has no wheels with a matching Python ABI tag (e.g., `cp312`), we can conclude that mlx<=0.0.3 cannot be used.
      And because mlx>=0.0.4 has no wheels with a matching platform tag (e.g., `macosx_12_0_arm64`) and you require mlx, we can conclude that your requirements are unsatisfiable.

      hint: You require CPython 3.12 (`cp312`), but we only found wheels for `mlx` (v0.0.3) with the following Python ABI tags: `cp38`, `cp39`, `cp310`, `cp311`

      hint: Wheels are available for `mlx` (v0.23.1) on the following platforms: `manylinux_2_31_x86_64`, `macosx_13_0_arm64`, `macosx_14_0_arm64`

      hint: Use `MACOSX_DEPLOYMENT_TARGET` to set the deployment target on macos platform

crates/uv-resolver/src/pubgrub/report.rs

zanieb · 2025-02-26T03:32:20Z

crates/uv-resolver/src/pubgrub/report.rs

@@ -1657,16 +1657,29 @@ impl std::fmt::Display for PubGrubHint {
                tags,
            } => {
                let s = if tags.len() == 1 { "" } else { "s" };
+                let macos_env_hint = tags


Presumably this will show the hint even if you're not targeting macOS? Is that what we want? e.g., in the changed test invalid_platform the target is linux. Showing the hint there seems confusing, right?

Great point, confusing indeed! I have been poking around this afternoon to find a way to filter on platform and passing in ResolverEnvironment looks promising.

Is this also what you had in mind?

That sounds reasonable — looks like we use that in other hints too.

zanieb · 2025-02-26T03:33:34Z

crates/uv/tests/it/pip_compile.rs

@@ -14791,7 +14791,9 @@ fn invalid_platform() -> Result<()> {
          hint: You require CPython 3.10 (`cp310`), but we only found wheels for `open3d` (v0.15.2) with the following Python ABI tags: `cp36m`, `cp37m`, `cp38`, `cp39`

          hint: Wheels are available for `open3d` (v0.18.0) on the following platforms: `manylinux_2_27_aarch64`, `manylinux_2_27_x86_64`, `macosx_11_0_x86_64`, `macosx_13_0_arm64`, `win_amd64`
-    "###);
+
+          hint: Use `MACOSX_DEPLOYMENT_TARGET` to set the deployment target on macos platform


I think we'll also need to explain the current deployment target. e.g., "The current macOS deployment target is <>, set ... to change the deployment target to a different version"

Do we need to talk about how the deployment target is a minimum or a maximum? Can we use one of the target versions from the available wheels to show an example?

This is good advice thank you. I have found using a TargetTriple instance is a good way to grab the current deployment target.

I will add that, talk about minimum and maximum, and utilize one of the PlatformTags to provide an example.

zanieb · 2025-02-26T03:33:55Z

Cool! Thanks for contributing. I have a few questions.

- Make macOS deployment target its own hint. - Add support for PubGrubHints. - Add test for this specific scenario.

dcarrier · 2025-03-05T19:09:08Z

Alright, in addition to the requested changes I made a few modifications.

Most notably:

Made the macOS deployment target its own hint as it felt more ergonomic.
Modified tag_hint -> tag_hints so we can return multiple PubgrubHints in the Platform scenario.
Added a snapshot test based on the linked issue.

Hint now looks like this:

hint: The current minimum macOS deployment target is 12.0, set environment variable MACOSX_DEPLOYMENT_TARGET to change the minimum deployment target (e.g. MACOSX_DEPLOYMENT_TARGET=13.0)

zanieb · 2025-03-05T23:37:53Z

crates/uv-configuration/src/target_triple.rs

+            debug!("Found macOS deployment target: {}.{}", major, minor);
+            Some((major, minor))
+        })
+        .unwrap_or((12, 0))


Why did you decide to change this call signature instead of unwrapping to something like DEFAULT_MACOS_DEPLOYMENT_TARGET at callsites?

This might be better, just curious if there was anything in particular that motivated it.

cc @charliermarsh as the owner of this

(Noticed this was related to #11783 (comment))

I liked centralizing the logic and moving the default version unwrap out of the platform constructor. It had the added benefit that it assisted with #11783 (comment) as you pointed out 😄.

Your suggestion is clean and would work the same. I would just change to DEFAULT_MACOS_DEPLOYMENT_TARGET in platform() unwrap.

I would probably keep this as-is and unwrap at each site. I think each site should be "forced" to consider the value it uses here.

Ack, I will revert these changes in favor of the call site unwrap. Thank you!

zanieb · 2025-03-05T23:41:05Z

crates/uv-resolver/src/pubgrub/report.rs

@@ -1669,6 +1696,37 @@ impl std::fmt::Display for PubGrubHint {
                        .join(", "),
                )
            }
+            Self::PlatformMacosDeploymentTarget { tag } => {
+                let current_version = {
+                    let (major, minor) = macos_deployment_target();


Here you pull the current target from the environment which I presume motivates the change in https://github.com/astral-sh/uv/pull/11783/files#r1982335893 but shouldn't we be pulling this value from the failing resolution's platform target triple instead?

(I'm not entirely sure this matters in practice, because the only way the deployment target can be set is via environment variable right now? But I think it could be an easy cause of a future bug)

As far as I know the environment variable is the only way to control the deployment target, correct.

If you don’t mind, I may need some advice on the best path forward. The major / minor fields in the platform object are not included in the resolution marker env object and the originally constructed target triple is only used to create the marker.

I see — yeah I wasn't sure if it was necessarily easy to get at. I can take a look. Charlie may also have an idea.

I think what you want to do is... Iterate over self.tags, and find the minimum macOS major-minor on any platform tag. Then use that as the inferred deployment target.

Thanks Charlie! I was looking into iterating over self.tags with one caveat: Should we actually find the max to infer the macosx deployment target?

It looks like we use the major field of Os as the top end to generate the list of platform_tag versions for anything >= 11. (ex: https://github.com/astral-sh/uv/blob/main/crates/uv-platform-tags/src/tags.rs#L497)

This feels counterintuitive to me because MACOSX_DEPLOYMENT_TARGET specifies the minimum to be supported, but for the purposes of the hint it would make the most sense as feedback to the user.

Btw thanks to you and Zanie for the feedback, I feel like I am making this complicated but I want to be sure I understand what I am changing.

zanieb · 2025-03-05T23:42:47Z

Thank you for following up on my feedback!

zanieb · 2025-03-05T23:43:57Z

crates/uv/tests/it/pip_compile.rs

+          hint: Wheels are available for `mlx` (v0.7.0) on the following platforms: `macosx_13_0_arm64`, `macosx_14_0_arm64`
+
+          hint: The current minimum macOS deployment target is 12.5, set environment variable MACOSX_DEPLOYMENT_TARGET to change the minimum deployment target (e.g. MACOSX_DEPLOYMENT_TARGET=13.0)


I still find it a bit surprising these are separate hints, as the latter is only relevant if the first is shown, correct? Can you say a bit more about why you found separate hints more ergonomic?

Yep you are correct, the macOS deployment target hint is dependent on the platform hint. I did mess around with breaking out the logic of the macOS deployment target into a separate function instead of a new PubgrubHint variant, but it didn't feel as clean in the codebase as following the variant pattern in the fmt function. It also feels nice to compose the hints at the tag_hints level.

Happy to switch it up if necessary!

I don't know that this hint actually works today... Has anyone tried it? I think we only look at MACOSX_DEPLOYMENT_TARGET when --python-platform is specified. I wouldn't expect it to have any affect on uv lock, for example. We might need to change our tag inference logic to respect it first. (I could be wrong.)

I haven't tried it, no. Interesting.

@dcarrier don't worry about looking into that (unless you're interested), we can explore it separately from this change.

dcarrier added 2 commits February 25, 2025 14:48

Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels

d15c763

fix clippy lint

19bc54b

j178 reviewed Feb 26, 2025

View reviewed changes

crates/uv-resolver/src/pubgrub/report.rs Outdated Show resolved Hide resolved

zanieb reviewed Feb 26, 2025

View reviewed changes

zanieb self-assigned this Feb 26, 2025

zanieb added the error messages Messaging when something goes wrong label Feb 26, 2025

Update the logic and verbiage of macOS deployment target hint.

e0ccee4

- Make macOS deployment target its own hint. - Add support for PubGrubHints. - Add test for this specific scenario.

zanieb reviewed Mar 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels #11783

Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels #11783

dcarrier commented Feb 25, 2025

zanieb Feb 26, 2025

dcarrier Feb 27, 2025

zanieb Mar 1, 2025

zanieb Feb 26, 2025

dcarrier Feb 27, 2025

zanieb commented Feb 26, 2025

dcarrier commented Mar 5, 2025 •

edited

Loading

zanieb Mar 5, 2025

zanieb Mar 5, 2025

dcarrier Mar 6, 2025

charliermarsh Mar 6, 2025

dcarrier Mar 7, 2025

zanieb Mar 5, 2025

zanieb Mar 5, 2025

dcarrier Mar 6, 2025

zanieb Mar 6, 2025

charliermarsh Mar 6, 2025

dcarrier Mar 7, 2025 •

edited

Loading

zanieb commented Mar 5, 2025

zanieb Mar 5, 2025

dcarrier Mar 6, 2025

charliermarsh Mar 6, 2025

zanieb Mar 6, 2025

		hint: Wheels are available for `mlx` (v0.7.0) on the following platforms: `macosx_13_0_arm64`, `macosx_14_0_arm64`

		hint: The current minimum macOS deployment target is 12.5, set environment variable MACOSX_DEPLOYMENT_TARGET to change the minimum deployment target (e.g. MACOSX_DEPLOYMENT_TARGET=13.0)

Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels #11783

Are you sure you want to change the base?

Add MACOSX_DEPLOYMENT_TARGET hint for macos platform wheels #11783

Conversation

dcarrier commented Feb 25, 2025

Summary

Test Plan

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zanieb commented Feb 26, 2025

dcarrier commented Mar 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcarrier Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

zanieb commented Mar 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcarrier commented Mar 5, 2025 •

edited

Loading

dcarrier Mar 7, 2025 •

edited

Loading