mirror of
https://github.com/astral-sh/ruff
synced 2026-01-21 13:30:49 -05:00
60a2dc53e7
## Summary <!-- What's the purpose of the change? What does it do, and why? --> Changes in this PR https://github.com/astral-sh/ruff/pull/13591 did not allow correct discovery in pip build environments. ```python # both of these variables are tuple[str, str] (length is 2) first, second = os.path.split(paths[0]), os.path.split(paths[1]) # so these length checks are guaranteed to fail even for build environment folders if ( len(first) >= 3 and len(second) >= 3 ... ) ``` ~~Here we instead use `pathlib`, and we check all `pip-build-env-` paths for the folder that is expected to contain the `ruff` executable.~~ Here we update the logic to more properly split out the path components that we use for `pip-build-env-` inspection. ## Test Plan I've checked this manually against a workflow that was failing, I'm not sure what to do for real tests. The same issues apply as with the previous PR. --------- Co-authored-by: Jonathan Surany <jsurany@bloomberg.net> Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
import os
|
|
import sys
|
|
import sysconfig
|
|
|
|
|
|
def find_ruff_bin() -> str:
|
|
"""Return the ruff binary path."""
|
|
|
|
ruff_exe = "ruff" + sysconfig.get_config_var("EXE")
|
|
|
|
scripts_path = os.path.join(sysconfig.get_path("scripts"), ruff_exe)
|
|
if os.path.isfile(scripts_path):
|
|
return scripts_path
|
|
|
|
if sys.version_info >= (3, 10):
|
|
user_scheme = sysconfig.get_preferred_scheme("user")
|
|
elif os.name == "nt":
|
|
user_scheme = "nt_user"
|
|
elif sys.platform == "darwin" and sys._framework:
|
|
user_scheme = "osx_framework_user"
|
|
else:
|
|
user_scheme = "posix_user"
|
|
|
|
user_path = os.path.join(
|
|
sysconfig.get_path("scripts", scheme=user_scheme), ruff_exe
|
|
)
|
|
if os.path.isfile(user_path):
|
|
return user_path
|
|
|
|
# Search in `bin` adjacent to package root (as created by `pip install --target`).
|
|
pkg_root = os.path.dirname(os.path.dirname(__file__))
|
|
target_path = os.path.join(pkg_root, "bin", ruff_exe)
|
|
if os.path.isfile(target_path):
|
|
return target_path
|
|
|
|
# Search for pip-specific build environments.
|
|
#
|
|
# Expect to find ruff in <prefix>/pip-build-env-<rand>/overlay/bin/ruff
|
|
# Expect to find a "normal" folder at <prefix>/pip-build-env-<rand>/normal
|
|
#
|
|
# See: https://github.com/pypa/pip/blob/102d8187a1f5a4cd5de7a549fd8a9af34e89a54f/src/pip/_internal/build_env.py#L87
|
|
paths = os.environ.get("PATH", "").split(os.pathsep)
|
|
if len(paths) >= 2:
|
|
|
|
def get_last_three_path_parts(path: str) -> list[str]:
|
|
"""Return a list of up to the last three parts of a path."""
|
|
parts = []
|
|
|
|
while len(parts) < 3:
|
|
head, tail = os.path.split(path)
|
|
if tail or head != path:
|
|
parts.append(tail)
|
|
path = head
|
|
else:
|
|
parts.append(path)
|
|
break
|
|
|
|
return parts
|
|
|
|
maybe_overlay = get_last_three_path_parts(paths[0])
|
|
maybe_normal = get_last_three_path_parts(paths[1])
|
|
if (
|
|
len(maybe_normal) >= 3
|
|
and maybe_normal[-1].startswith("pip-build-env-")
|
|
and maybe_normal[-2] == "normal"
|
|
and len(maybe_overlay) >= 3
|
|
and maybe_overlay[-1].startswith("pip-build-env-")
|
|
and maybe_overlay[-2] == "overlay"
|
|
):
|
|
# The overlay must contain the ruff binary.
|
|
candidate = os.path.join(paths[0], ruff_exe)
|
|
if os.path.isfile(candidate):
|
|
return candidate
|
|
|
|
raise FileNotFoundError(scripts_path)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
ruff = os.fsdecode(find_ruff_bin())
|
|
if sys.platform == "win32":
|
|
import subprocess
|
|
|
|
completed_process = subprocess.run([ruff, *sys.argv[1:]])
|
|
sys.exit(completed_process.returncode)
|
|
else:
|
|
os.execvp(ruff, [ruff, *sys.argv[1:]])
|