You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
plain invocation of python subprocess doesn't inherit sys.path for bootstrap_impl=script #2169
A side-effect of no longer propagating import paths using the PYTHONPATH envvar is that subprocesses don't inherit the paths. This is usually a good thing, but ends up breaking plain calls to python that assume they're going to inherit the current python's settings.
An example is pre-commit and its invocation of virtual env:
# add pre-commit to requirements and process through pip.parse
# BUILD.bazel
load("//python/entry_points:py_console_script_binary.bzl", "py_console_script_binary")
py_console_script_binary(
name = "pre-commit",
pkg = "@dev_pip//pre_commit",
script = "pre-commit",
)
bazel run --@rules_python//python/config_settings:bootstrap_impl=script //:pre-commit
Eventually, it'll run: [sys.executable, '-mvirtualenv', ...], its sys.path will be just the stdlib, and fail to import virtualenv
This is sort of WAI. Part of the purpose of bootstrap_impl=script is to no longer use the envvar so that PYTHONPATH doesn't get too long and bleed into subprocesses.
I'm not sure how to work around this. I guess a legacy option to set the env var?
I'm not sure how this is supposed to work outside of bazel, either. It must assume that it's invoked in a venv or something? The surrounding code seems to indicate it's setting up a venv for pre-commit itself...or something. This all seems odd -- I would have to create a venv with virtualenv in it to run pre-commit so pre-commit can create its own venv? That doesn't sound right.
At $dayjob I had a similar usecase where I need to have python interpreter with all dependencies set up and with the way the new thing is setup, I am not sure how I could achieve that using the new bootstrap. I had a py_binary that was using sys.executable and just forward the args to the interpreter and using pythonpath env var would just work, but with the new method, I would need to also setup the sys.path myself before invoking the interpreter.
Maybe at the very least there is a way to workaround this where sys.executable could be set to something that sets up the sys.path.
I was reading some Python docs (venv or site, i can't remember), and they gave me the following idea:
A binary creates a wrapper for the interpreter. This becomes sys.executable
In that same directory, there's a pth file
At interpreter startup (or site init?), it reads pth files from its directory.
@rickeylev could you provide more details on how this can be implemented, we are having issues with prefect library as well. When you say binary do you mean a py_binary or just a script (bash/python)
Okay I tried the following approach and it seems to work
Create sitecustomize.py under $(bazel info output_base)/external/rules_python~~python~python_3_11_6_x86_64-unknown-linux-gnu/lib/python3.11/site-packages/
sitecustomize.py
importosimportsysdeffind_site_packages_dirs(root_dir):
# Store all paths with the name 'site-packages'site_packages_dirs= []
# Walk through the directory treefordirpath, dirnames, _inos.walk(root_dir):
# Check if 'site-packages' is in the list of directories at this levelif"site-packages"indirnames:
site_packages_path=os.path.join(dirpath, "site-packages")
site_packages_dirs.append(site_packages_path)
# Optionally, remove 'site-packages' from dirnames to skip its subtreedirnames.remove(
"site-packages"
) # Skip subdirs within 'site-packages' for efficiencyreturnsite_packages_dirsroot_directory=os.environ["RUNFILES_DIR"]
site_packages_paths=find_site_packages_dirs(root_directory)
sys.path.extend(site_packages_paths)
It all looks to be working, but its still prototype quality, so needs cleanup and to see what happens when all the tests are run.
Okay I tried (putting site customize in the runtime dir) and it seems to work
I can't think of any situation where this fails.
Some problematic cases I can think of are:
Import paths that don't involve site-packages. e.g. when the imports attribute is used
I've strayed away from sitecustomize.py because its not as extensible -- there can be only one, and you can't know if overriding it is going to prevent a previously existing one from running. Putting it in the runtime itself probably obviates most of this issue, but hard to say.
Adding a sitecustomize.py is possible for the hermetic runtimes (since we effectively control what is in those), but doesn't generalize to custom runtimes or system runtimes.
Walking the whole file tree is pretty expensive -- large apps having e.g. 40,000 files is not unheard of.
nested binaries with different closures of dependencies would pick up each others site-packages directories.
The RUNFILES_DIR env variable may not be set (there's some other vars that may be set). In general, there usually has to be some fallback code if the various runfiles env vars aren't set.
EDIT: Just to clarify, thank you for hacking away on this :). I didn't meant to be overly critical.
EDIT: Just to clarify, thank you for hacking away on this :). I didn't meant to be overly critical.
Not at all. I love to learn
I did think of some of the points you mentioned, with potential ways to address them, but that is not relevant since you are working on a potentially more robust solution.
Hmm actually it fails on WSL Ubuntu and is fine on a regular Linux Machine. Says a broken symbolic link
file /home/ewianda/.cache/bazel/_bazel_ewianda/6091a940c516b5ac88940b423928af22/sandbox/linux-sandbox/7/execroot/_main/bazel-out/k8-fastbuild/bin/benchsci/test_pg13.runfiles/_main/benchsci/_test_pg13.venv/bin/python3
/home/ewianda/.cache/bazel/_bazel_ewianda/6091a940c516b5ac88940b423928af22/sandbox/linux-sandbox/7/execroot/_main/bazel-out/k8-fastbuild/bin/benchsci/test_pg13.runfiles/_main/benchsci/_test_pg13.venv/bin/python3: broken symbolic link to ../../../../../rules_python~~python~python_3_11_6_x86_64-unknown-linux-gnu/bin/python3
Unfortunately, I don't have a windows machine for development. Last time I tried to set one up for bazel dev it took days and I never got it actually working. Our CI doesn't cover windows+wsl. It might take me a bit of time to repro this and fix it.
Elvis, are you able to determine what the correct relative path should be? It kinda looks like there should 4, not 5, ../ in the path. The .. should end up at the runfiles root so that $runfilesRoot/rules_python~~python~python_3_11_6_x86_64-unknown-linux-gnu/bin/python3 is valid.
Building with --spawn_strategy=local should disable the sandbox and let you modify the files within runfiles after building. Then you should be able to recreate the symlink to try different values.
interpreter=ctx.actions.declare_symlink("{}/bin/{}".format(venv, py_exe_basename))
interpreter_actual_path=runtime.interpreter.short_path# Always relative to .runfiles/_mainescapes=2# To escape out of <target>.venv/binescapes+=executable.short_path.count("/") # To escape into .runfiles/_mainparent="/".join([".."] *escapes)
rel_path=parent+"/"+interpreter_actual_pathctx.actions.symlink(output=interpreter, target_path=rel_path)
(executable propagated from call-site)
Let me raise a PR in a moment so we can see this better.
interpreter=ctx.actions.declare_symlink("{}/bin/{}".format(venv, py_exe_basename))
interpreter_actual_path=runtime.interpreter.short_path# Always relative to .runfiles/_mainescapes=2# To escape out of <target>.venv/binescapes+=executable.short_path.count("/") # To escape into .runfiles/_mainparent="/".join([".."] *escapes)
rel_path=parent+"/"+interpreter_actual_pathctx.actions.symlink(output=interpreter, target_path=rel_path)
(executable propagated from call-site)
Let me raise a PR in a moment so we can see this better.
If read this correctly it translates to parent = "/".join([".."] * (interpreter_actual_path.count("/") + 2)),
which fails for me
The only case it doesn't cover is an external rule using a Python interpreter stored in the main repository (but I reckon that's a bit of an unusual setup).
Activity
aignas commentedon Aug 31, 2024
At $dayjob I had a similar usecase where I need to have python interpreter with all dependencies set up and with the way the new thing is setup, I am not sure how I could achieve that using the new bootstrap. I had a py_binary that was using sys.executable and just forward the args to the interpreter and using pythonpath env var would just work, but with the new method, I would need to also setup the sys.path myself before invoking the interpreter.
Maybe at the very least there is a way to workaround this where sys.executable could be set to something that sets up the sys.path.
rickeylev commentedon Sep 9, 2024
I was reading some Python docs (venv or site, i can't remember), and they gave me the following idea:
ewianda commentedon Nov 1, 2024
@rickeylev could you provide more details on how this can be implemented, we are having issues with prefect library as well. When you say binary do you mean a py_binary or just a script (bash/python)
ewianda commentedon Nov 1, 2024
Okay I tried the following approach and it seems to work
Create
sitecustomize.pyunder$(bazel info output_base)/external/rules_python~~python~python_3_11_6_x86_64-unknown-linux-gnu/lib/python3.11/site-packages/sitecustomize.py
I can't think of any situation where this fails.
rickeylev commentedon Nov 1, 2024
I've been poking this off and on over the last couple days and it looks pretty promising. It looks approximately like this:
It all looks to be working, but its still prototype quality, so needs cleanup and to see what happens when all the tests are run.
Some problematic cases I can think of are:
importsattribute is usedEDIT: Just to clarify, thank you for hacking away on this :). I didn't meant to be overly critical.
ewianda commentedon Nov 1, 2024
Not at all. I love to learn
I did think of some of the points you mentioned, with potential ways to address them, but that is not relevant since you are working on a potentially more robust solution.
Thanks.
fix: make sys.executable work with script bootstrap (#2409)
rickeylev commentedon Nov 23, 2024
#2409 might have broken bootstrap=script for windows using wsl
@ewianda reported on the PR:
Unfortunately, I don't have a windows machine for development. Last time I tried to set one up for bazel dev it took days and I never got it actually working. Our CI doesn't cover windows+wsl. It might take me a bit of time to repro this and fix it.
Elvis, are you able to determine what the correct relative path should be? It kinda looks like there should 4, not 5,
../in the path. The..should end up at the runfiles root so that$runfilesRoot/rules_python~~python~python_3_11_6_x86_64-unknown-linux-gnu/bin/python3is valid.Building with
--spawn_strategy=localshould disable the sandbox and let you modify the files within runfiles after building. Then you should be able to recreate the symlink to try different values.chowder commentedon Nov 23, 2024
#2409 also seems to have broken
py_binaryandpy_testtargets in multi-python setups.Trivial reproduction:
examples/multi_python_versions--@rules_python//python/config_settings:bootstrap_impl=scripttestsI get:
Where the symlink points to:
I haven't had the time to look into the venv implementation yet so I'm not sure what the problem is.
But I would've expectededit:nvm${target}.venv/bin/pythonto symlink to../../${target}.runfiles/${python_repo}/bin/python3ewianda commentedon Nov 23, 2024
Sorry @rickeylev I was quick to say that it happens only on Ubuntu WSL, it also happens on regular linux VM on gcp
ewianda commentedon Nov 23, 2024
changing
https://github.com/bazelbuild/rules_python/blob/4ee7e256de85faff38db5f21defd660a2cd6aa85/python/private/py_executable_bazel.bzl#L372
to
+ 0or removing the extra../fixes the problem.I assume there is no automated test for
--@rules_python//python/config_settings:bootstrap_impl=scriptewianda commentedon Nov 23, 2024
Windows + wsl2 is pretty mature. It is indistinguishable from native Linux installation. So need need to cover this case in CI.
chowder commentedon Nov 23, 2024
Ok - so I don't quite understand the original logic - but I think the correct logic for this:
https://github.com/bazelbuild/rules_python/blob/4ee7e256de85faff38db5f21defd660a2cd6aa85/python/private/py_executable_bazel.bzl#L370-L374
is supposed to be:
EDIT: ignore the below - i'm wrong and stupid
(
executablepropagated from call-site)Let me raise a PR in a moment so we can see this better.
ewianda commentedon Nov 23, 2024
If read this correctly it translates to
parent = "/".join([".."] * (interpreter_actual_path.count("/") + 2)),which fails for me
chowder commentedon Nov 23, 2024
They're not equivalent, no - can you try these changes out please?
https://github.com/bazelbuild/rules_python/pull/2439/files
ewianda commentedon Nov 23, 2024
Thanks @chowder , bazel test is now passing,
py_binaryalso runs with no issues. Butbazel runis failing for py_console_scriptchowder commentedon Nov 24, 2024
OHH okay, I think see how this is supposed to work now.
@ewianda I've updated the PR
The only case it doesn't cover is an external rule using a Python interpreter stored in the main repository (but I reckon that's a bit of an unusual setup).
fix: correctly obtain relative path required for the venv created by …