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

Jump to bottom

refactor package_python_dist rule so most of the logic can be reused (Cherry-pick of #18701) #18703

Merged
merged 1 commit into from
Apr 8, 2023
Merged

refactor package_python_dist rule so most of the logic can be reused (Cherry-pick of #18701) #18703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 40 additions & 21 deletions src/python/pants/backend/python/goals/setup_py.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,19 +411,25 @@ class DistBuildEnvironment:
extra_build_time_inputs: Digest


@rule
async def package_python_dist(
async def create_dist_build_request(
field_set: PythonDistributionFieldSet,
python_setup: PythonSetup,
union_membership: UnionMembership,
) -> BuiltPackage:
validate_wheel_sdist: bool = True,
) -> DistBuildRequest:
"""Create a DistBuildRequest for a `python_distribution`.

This is a separate helper function so that editable wheel builds can share setup logic with the
standard wheel/sdist builds.
"""

transitive_targets = await Get(TransitiveTargets, TransitiveTargetsRequest([field_set.address]))
exported_target = ExportedTarget(transitive_targets.roots[0])

dist_tgt = exported_target.target
wheel = dist_tgt.get(WheelField).value
sdist = dist_tgt.get(SDistField).value
if not wheel and not sdist:
if validate_wheel_sdist and not wheel and not sdist:
raise NoDistTypeSelected(
softwrap(
f"""
Expand Down Expand Up @@ -509,24 +515,37 @@ async def package_python_dist(
output_path is not None
), "output_path should take a default string value if the user has not provided it."

setup_py_result = await Get(
DistBuildResult,
DistBuildRequest(
build_system=build_system,
interpreter_constraints=interpreter_constraints,
build_wheel=wheel,
build_sdist=sdist,
input=prefixed_input,
working_directory=working_directory,
build_time_source_roots=source_roots,
target_address_spec=exported_target.target.address.spec,
wheel_config_settings=wheel_config_settings,
sdist_config_settings=sdist_config_settings,
extra_build_time_requirements=extra_build_time_requirements,
extra_build_time_env=extra_build_time_env,
output_path=output_path,
),
return DistBuildRequest(
build_system=build_system,
interpreter_constraints=interpreter_constraints,
build_wheel=wheel,
build_sdist=sdist,
input=prefixed_input,
working_directory=working_directory,
build_time_source_roots=source_roots,
target_address_spec=exported_target.target.address.spec,
wheel_config_settings=wheel_config_settings,
sdist_config_settings=sdist_config_settings,
extra_build_time_requirements=extra_build_time_requirements,
extra_build_time_env=extra_build_time_env,
output_path=output_path,
)


@rule
async def package_python_dist(
field_set: PythonDistributionFieldSet,
python_setup: PythonSetup,
union_membership: UnionMembership,
) -> BuiltPackage:
dist_build_request = await create_dist_build_request(
field_set=field_set,
python_setup=python_setup,
union_membership=union_membership,
# raises an error if both dist_tgt.wheel and dist_tgt.sdist are False
validate_wheel_sdist=True,
)
setup_py_result = await Get(DistBuildResult, DistBuildRequest, dist_build_request)
dist_snapshot = await Get(Snapshot, Digest, setup_py_result.output)
return BuiltPackage(
setup_py_result.output,
Expand Down