Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: sdist resulting in duplicate repo name when requirements line does not match #2658

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

fix: sdist resulting in duplicate repo name when requirements line does not match #2658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c48534
add test scenario for sdists across platforms
chrisirhc Mar 11, 2025
029cf01
fix tests
chrisirhc Mar 11, 2025
c036d29
sketch for new merge logic
chrisirhc Mar 11, 2025
d098305
simplify logic assuming one sdist always per version
chrisirhc Mar 11, 2025
8e281cf
unsure: address test failure
chrisirhc Mar 11, 2025
8031419
lint
chrisirhc Mar 13, 2025
60eb704
fix missing req
chrisirhc Mar 13, 2025
608355a
fix lint
chrisirhc Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion python/private/pypi/parse_requirements.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,22 +207,46 @@ def parse_requirements(
# Return normalized names
ret_requirements = ret.setdefault(normalize_name(whl_name), [])

all_platforms = []
common_sdist = None

for r in sorted(reqs.values(), key = lambda r: r.requirement_line):
whls, sdist = _add_dists(
requirement = r,
index_urls = index_urls.get(whl_name),
logger = logger,
)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea of adding a common sdist feels like a hack. Maybe having a different algorithm/grouping would be better. Maybe having per sha grouping could be better.

if sdist and not common_sdist:
common_sdist = struct(
req = r,
sdist = sdist,
)

target_platforms = env_marker_target_platforms.get(r.requirement_line, r.target_platforms)
all_platforms.extend(target_platforms)

ret_requirements.append(
struct(
distribution = r.distribution,
srcs = r.srcs,
target_platforms = sorted(target_platforms),
extra_pip_args = r.extra_pip_args,
whls = whls,
sdist = sdist,
sdist = None,
is_exposed = is_exposed,
),
)

if common_sdist:
ret_requirements.append(
struct(
distribution = common_sdist.req.distribution,
srcs = common_sdist.req.srcs,
target_platforms = sorted(all_platforms),
extra_pip_args = common_sdist.req.extra_pip_args,
whls = [],
sdist = common_sdist.sdist,
is_exposed = is_exposed,
),
)
Expand Down
2 changes: 2 additions & 0 deletions tests/pypi/extension/extension_tests.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,12 +505,14 @@ some_pkg==0.0.1
whl_config_setting(
filename = "simple-0.0.1-py3-none-any.whl",
version = "3.15",
target_platforms = ("cp315_linux_aarch64", "cp315_linux_arm", "cp315_linux_ppc", "cp315_linux_s390x", "cp315_linux_x86_64", "cp315_osx_aarch64", "cp315_osx_x86_64", "cp315_windows_x86_64"),
Copy link
Contributor Author

@chrisirhc chrisirhc Mar 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why my changes introduced this change. My guess is that extension.bzl may have some handling for any.whl

),
],
"pypi_315_simple_sdist_deadbeef": [
whl_config_setting(
filename = "simple-0.0.1.tar.gz",
version = "3.15",
target_platforms = ("cp315_linux_aarch64", "cp315_linux_arm", "cp315_linux_ppc", "cp315_linux_s390x", "cp315_linux_x86_64", "cp315_osx_aarch64", "cp315_osx_x86_64", "cp315_windows_x86_64"),
),
],
},
Expand Down
116 changes: 116 additions & 0 deletions tests/pypi/parse_requirements/parse_requirements_tests.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ foo==0.0.3 --hash=sha256:deadbaaf
--abi=cp39

foo==0.0.3 --hash=sha256:deadbaaf
""",
"requirements_sdist_different_hashes": """\
foo==0.0.1 --hash=sha256:deadbeef --hash=sha256:cafebabe
""",
"requirements_sdist_different_hashes_linux": """\
foo==0.0.1 --hash=sha256:deadbaaf --hash=sha256:cafebabe
""",
"requirements_windows": """\
foo[extra]==0.0.2 --hash=sha256:deadbeef
Expand Down Expand Up @@ -443,6 +449,116 @@ def _test_different_package_version(env):

_tests.append(_test_different_package_version)

def _test_sdist_different_hashes(env):
"""Test that sdists with same hash but wheels with different hashes across platforms are handled correctly."""

def _mock_get_index_urls(_, _):
return {
"foo": struct(
whls = {
"deadbaaf": struct(
filename = "foo-0.0.1-py3-none-manylinux_2_17_x86_64.whl",
url = "https://pypi.org/foo-0.0.1-linux.whl",
sha256 = "deadbaaf",
yanked = False,
),
"deadbeef": struct(
filename = "foo-0.0.1-py3-none-win_amd64.whl",
url = "https://pypi.org/foo-0.0.1-win.whl",
sha256 = "deadbeef",
yanked = False,
),
},
sdists = {
"cafebabe": struct(
filename = "foo-0.0.1.tar.gz",
url = "https://pypi.org/foo-0.0.1.tar.gz",
sha256 = "cafebabe",
yanked = False,
),
},
),
}

got = parse_requirements(
ctx = _mock_ctx(),
requirements_by_platform = {
"requirements_sdist_different_hashes": ["cp315_windows_x86_64"],
"requirements_sdist_different_hashes_linux": ["cp315_linux_x86_64"],
},
get_index_urls = _mock_get_index_urls,
)
env.expect.that_dict(got).contains_exactly({
"foo": [
struct(
distribution = "foo",
extra_pip_args = [],
is_exposed = True,
sdist = None,
srcs = struct(
marker = "",
requirement = "foo==0.0.1",
requirement_line = "foo==0.0.1 --hash=sha256:deadbaaf --hash=sha256:cafebabe",
shas = ["cafebabe", "deadbaaf"],
version = "0.0.1",
),
target_platforms = ["cp315_linux_x86_64"],
whls = [
struct(
filename = "foo-0.0.1-py3-none-manylinux_2_17_x86_64.whl",
url = "https://pypi.org/foo-0.0.1-linux.whl",
sha256 = "deadbaaf",
yanked = False,
),
],
),
struct(
distribution = "foo",
extra_pip_args = [],
is_exposed = True,
sdist = None,
srcs = struct(
marker = "",
requirement = "foo==0.0.1",
requirement_line = "foo==0.0.1 --hash=sha256:deadbeef --hash=sha256:cafebabe",
shas = ["cafebabe", "deadbeef"],
version = "0.0.1",
),
target_platforms = ["cp315_windows_x86_64"],
whls = [
struct(
filename = "foo-0.0.1-py3-none-win_amd64.whl",
url = "https://pypi.org/foo-0.0.1-win.whl",
sha256 = "deadbeef",
yanked = False,
),
],
),
struct(
distribution = "foo",
extra_pip_args = [],
is_exposed = True,
sdist = struct(
filename = "foo-0.0.1.tar.gz",
url = "https://pypi.org/foo-0.0.1.tar.gz",
sha256 = "cafebabe",
yanked = False,
),
srcs = struct(
marker = "",
requirement = "foo==0.0.1",
requirement_line = "foo==0.0.1 --hash=sha256:deadbaaf --hash=sha256:cafebabe",
shas = ["cafebabe", "deadbaaf"],
version = "0.0.1",
),
target_platforms = ["cp315_linux_x86_64", "cp315_windows_x86_64"],
whls = [],
),
],
})

_tests.append(_test_sdist_different_hashes)

def parse_requirements_test_suite(name):
"""Create the test suite.

Expand Down