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

Revert "Prefix the entire setup.py chroot. (#12359)" #12370

Merged
merged 1 commit into from
Jul 17, 2021
Merged

Revert "Prefix the entire setup.py chroot. (#12359)" #12370

Show file tree
Hide file tree
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
43 changes: 17 additions & 26 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 @@ -405,6 +405,10 @@ async def package_python_dist(
return BuiltPackage(rel_chroot, (BuiltPackageArtifact(dirname),))


# We write .py sources into the chroot under this dir.
CHROOT_SOURCE_ROOT = "src"


SETUP_BOILERPLATE = """
# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
# Target: {target_address_spec}
Expand All @@ -429,42 +433,23 @@ async def run_setup_py(req: RunSetupPyRequest, setuptools: Setuptools) -> RunSet
interpreter_constraints=req.interpreter_constraints,
),
)

# We prefix the entire chroot, and run with this prefix as the cwd, so that we can capture any
# changes setup made within it (e.g., when running 'develop') without also capturing other
# artifacts of the pex process invocation.
chroot_prefix = "chroot"

# The setuptools dist dir, created by it under the chroot (not to be confused with
# pants's own dist dir, at the buildroot).
dist_dir = "dist"

prefixed_chroot = await Get(Digest, AddPrefix(req.chroot.digest, chroot_prefix))

# setup.py basically always expects to be run with the cwd as its own directory
# (e.g., paths in it are relative to that directory). This is true of the setup.py
# we generate and is overwhelmingly likely to be true for existing setup.py files,
# as there is no robust way to run them otherwise.
setup_script_reldir, setup_script_name = os.path.split(req.chroot.setup_script)
working_directory = os.path.join(chroot_prefix, setup_script_reldir)

dist_dir = "dist/"
result = await Get(
ProcessResult,
VenvPexProcess(
setuptools_pex,
argv=(setup_script_name, *req.args),
input_digest=prefixed_chroot,
working_directory=working_directory,
argv=(req.chroot.setup_script, *req.args),
input_digest=req.chroot.digest,
# setuptools commands that create dists write them to the distdir.
# TODO: Could there be other useful files to capture?
output_directories=(dist_dir,), # Relative to the working_directory.
output_directories=(dist_dir,),
description=f"Run setuptools for {req.exported_target.target.address}",
level=LogLevel.DEBUG,
),
)
output_digest = await Get(
Digest, RemovePrefix(result.output_digest, os.path.join(chroot_prefix, dist_dir))
)
output_digest = await Get(Digest, RemovePrefix(result.output_digest, dist_dir))
return RunSetupPyResult(output_digest)


Expand Down Expand Up @@ -550,6 +535,7 @@ async def generate_chroot(request: SetupPyChrootRequest) -> SetupPyChroot:
# specified `SetupKwargs(_allow_banned_keys=True)`.
setup_kwargs.update(
{
"package_dir": {"": CHROOT_SOURCE_ROOT, **setup_kwargs.get("package_dir", {})},
"packages": (*sources.packages, *(setup_kwargs.get("packages", []))),
"namespace_packages": (
*sources.namespace_packages,
Expand Down Expand Up @@ -609,8 +595,13 @@ async def generate_chroot(request: SetupPyChrootRequest) -> SetupPyChroot:
FileContent("setup.py", setup_py_content),
FileContent("MANIFEST.in", "include *.py".encode()),
]
extra_files_digest = await Get(Digest, CreateDigest(files_to_create))
chroot_digest = await Get(Digest, MergeDigests((sources.digest, extra_files_digest)))
extra_files_digest, src_digest = await MultiGet(
Get(Digest, CreateDigest(files_to_create)),
# Nest the sources under the src/ prefix.
Get(Digest, AddPrefix(sources.digest, CHROOT_SOURCE_ROOT)),
)

chroot_digest = await Get(Digest, MergeDigests((src_digest, extra_files_digest)))
return SetupPyChroot(
chroot_digest, "setup.py", FinalizedSetupKwargs(setup_kwargs, address=target.address)
)
Expand Down
18 changes: 10 additions & 8 deletions src/python/pants/backend/python/goals/setup_py_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,13 +285,13 @@ def test_generate_chroot(chroot_rule_runner: RuleRunner) -> None:
assert_chroot(
chroot_rule_runner,
[
"files/README.txt",
"foo/qux/__init__.py",
"foo/qux/qux.py",
"foo/qux/qux.pyi",
"foo/resources/js/code.js",
"foo/__init__.py",
"foo/foo.py",
"src/files/README.txt",
"src/foo/qux/__init__.py",
"src/foo/qux/qux.py",
"src/foo/qux/qux.pyi",
"src/foo/resources/js/code.js",
"src/foo/__init__.py",
"src/foo/foo.py",
"setup.py",
"MANIFEST.in",
],
Expand All @@ -300,6 +300,7 @@ def test_generate_chroot(chroot_rule_runner: RuleRunner) -> None:
"name": "foo",
"version": "1.2.3",
"plugin_demo": "hello world",
"package_dir": {"": "src"},
"packages": ("foo", "foo.qux"),
"namespace_packages": ("foo",),
"package_data": {"foo": ("resources/js/code.js",)},
Expand Down Expand Up @@ -377,12 +378,13 @@ def test_binary_shorthand(chroot_rule_runner: RuleRunner) -> None:
)
assert_chroot(
chroot_rule_runner,
["project/app.py", "setup.py", "MANIFEST.in"],
["src/project/app.py", "setup.py", "MANIFEST.in"],
"setup.py",
{
"name": "bin",
"version": "1.1.1",
"plugin_demo": "hello world",
"package_dir": {"": "src"},
"packages": ("project",),
"namespace_packages": (),
"install_requires": (),
Expand Down